| Line No. | Rev | Author | Line |
|---|---|---|---|
| 1 | 6 | kaklik | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| 2 | <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> |
||
| 3 | <title>Procyon AVRlib: fixedpt.h Source File</title> |
||
| 4 | <link href="dox.css" rel="stylesheet" type="text/css"> |
||
| 5 | </head><body> |
||
| 6 | <!-- Generated by Doxygen 1.4.2 --> |
||
| 7 | <div class="qindex"><a class="qindex" href="main.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a></div> |
||
| 8 | <h1>fixedpt.h</h1><a href="fixedpt_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment">00001 <span class="comment">/*! \file fixedpt.h \brief Fixed-point math function library. */</span> |
||
| 9 | 00002 <span class="comment">//*****************************************************************************</span> |
||
| 10 | 00003 <span class="comment">//</span> |
||
| 11 | 00004 <span class="comment">// File Name : 'fixedpt.h'</span> |
||
| 12 | 00005 <span class="comment">// Title : Fixed-point math function library</span> |
||
| 13 | 00006 <span class="comment">// Author : Pascal Stang - Copyright (C) 2003</span> |
||
| 14 | 00007 <span class="comment">// Created : 2003.01.26</span> |
||
| 15 | 00008 <span class="comment">// Revised : 2003.02.04</span> |
||
| 16 | 00009 <span class="comment">// Version : 0.1</span> |
||
| 17 | 00010 <span class="comment">// Target MCU : Atmel AVR Series</span> |
||
| 18 | 00011 <span class="comment">// Editor Tabs : 4</span> |
||
| 19 | 00012 <span class="comment">//</span> |
||
| 20 | 00013 <span class="comment">// NOTE: This code is currently below version 1.0, and therefore is considered</span> |
||
| 21 | 00014 <span class="comment">// to be lacking in some functionality or documentation, or may not be fully</span> |
||
| 22 | 00015 <span class="comment">// tested. Nonetheless, you can expect most functions to work.</span> |
||
| 23 | 00016 <span class="comment">//</span><span class="comment"></span> |
||
| 24 | 00017 <span class="comment">/// \ingroup general</span> |
||
| 25 | 00018 <span class="comment">/// \defgroup fixedpt Fixed-Point Math Function Library (fixedpt.c)</span> |
||
| 26 | 00019 <span class="comment">/// \code #include "fixedpt.h" \endcode</span> |
||
| 27 | 00020 <span class="comment">/// \par Overview</span> |
||
| 28 | 00021 <span class="comment">/// This library provides basic fixed-point math operations implemented in</span> |
||
| 29 | 00022 <span class="comment">/// C. Fixed-point math is a system by which integer variables can</span> |
||
| 30 | 00023 <span class="comment">/// represent fractional values with a fixed precision "behind" the decimal</span> |
||
| 31 | 00024 <span class="comment">/// point (like a fixed number of decimal places). Fixed-point math is</span> |
||
| 32 | 00025 <span class="comment">/// typically 10x faster to execute than floating-point math, and should</span> |
||
| 33 | 00026 <span class="comment">/// be used when a limited amount of fractional precision is sufficient</span> |
||
| 34 | 00027 <span class="comment">/// (such as 4ths, or 10ths, or 128ths, etc).</span> |
||
| 35 | 00028 <span class="comment">///</span> |
||
| 36 | 00029 <span class="comment">/// \note This library is really meant more as a demonstration of fixed-pt</span> |
||
| 37 | 00030 <span class="comment">/// math. For best code-efficiency and speed, you are enouraged to take</span> |
||
| 38 | 00031 <span class="comment">/// the code you see in these functions and copy it into your own code.</span> |
||
| 39 | 00032 <span class="comment"></span><span class="comment">//</span> |
||
| 40 | 00033 <span class="comment">// This code is distributed under the GNU Public License</span> |
||
| 41 | 00034 <span class="comment">// which can be found at http://www.gnu.org/licenses/gpl.txt</span> |
||
| 42 | 00035 <span class="comment">//</span> |
||
| 43 | 00036 <span class="comment">//*****************************************************************************</span> |
||
| 44 | 00037 |
||
| 45 | 00038 <span class="preprocessor">#ifndef FIXEDPT_H</span> |
||
| 46 | 00039 <span class="preprocessor"></span><span class="preprocessor">#define FIXEDPT_H</span> |
||
| 47 | 00040 <span class="preprocessor"></span> |
||
| 48 | 00041 <span class="preprocessor">#include "<a class="code" href="global_8h.html">global.h</a>"</span> |
||
| 49 | 00042 |
||
| 50 | 00043 <span class="comment">// constants/macros/typdefs</span> |
||
| 51 | 00044 |
||
| 52 | 00045 <span class="comment">// functions</span> |
||
| 53 | 00046 <span class="comment"></span> |
||
| 54 | 00047 <span class="comment">//! fixedptInit() initializes fixed-point math function library</span> |
||
| 55 | 00048 <span class="comment"></span><span class="comment">// set the number of bits to use behind the point</span> |
||
| 56 | 00049 <span class="keywordtype">void</span> <a class="code" href="fixedpt_8c.html#a1">fixedptInit</a>(u08 fixedPtBits); |
||
| 57 | 00050 <span class="comment"></span> |
||
| 58 | 00051 <span class="comment">//! convert integer to fixed-point number</span> |
||
| 59 | 00052 <span class="comment"></span>s32 <a class="code" href="fixedpt_8c.html#a2">fixedptConvertFromInt</a>(s32 int_number); |
||
| 60 | 00053 <span class="comment"></span> |
||
| 61 | 00054 <span class="comment">//! convert fixed-point number to integer</span> |
||
| 62 | 00055 <span class="comment"></span>s32 <a class="code" href="fixedpt_8c.html#a3">fixedptConvertToInt</a>(s32 fp_number); |
||
| 63 | 00056 <span class="comment"></span> |
||
| 64 | 00057 <span class="comment">//! add a and b (a+b) with fixed-point math</span> |
||
| 65 | 00058 <span class="comment"></span>s32 <a class="code" href="fixedpt_8c.html#a4">fixedptAdd</a>(s32 a, s32 b); |
||
| 66 | 00059 <span class="comment"></span> |
||
| 67 | 00060 <span class="comment">//! subtract a and b (a-b) with fixed-point math</span> |
||
| 68 | 00061 <span class="comment"></span>s32 <a class="code" href="fixedpt_8c.html#a5">fixedptSubtract</a>(s32 a, s32 b); |
||
| 69 | 00062 <span class="comment"></span> |
||
| 70 | 00063 <span class="comment">//! multiply a and b (a*b) with fixed-point math</span> |
||
| 71 | 00064 <span class="comment"></span>s32 <a class="code" href="fixedpt_8c.html#a6">fixedptMultiply</a>(s32 a, s32 b); |
||
| 72 | 00065 <span class="comment"></span> |
||
| 73 | 00066 <span class="comment">//! divide numer by denom (numer/denom) with fixed-point math</span> |
||
| 74 | 00067 <span class="comment"></span>s32 <a class="code" href="fixedpt_8c.html#a7">fixedptDivide</a>(s32 numer, s32 denom); |
||
| 75 | 00068 |
||
| 76 | 00069 <span class="preprocessor">#endif</span> |
||
| 77 | </pre></div><hr size="1"><address style="align: right;"><small>Generated on Sun Oct 29 03:41:06 2006 for Procyon AVRlib by |
||
| 78 | <a href="http://www.doxygen.org/index.html"> |
||
| 79 | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.2 </small></address> |
||
| 80 | </body> |
||
| 81 | </html> |
Powered by WebSVN v2.8.3