Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > bad97183153701b09df5fae1052b1c30 > files > 1997

crystalspace-doc-1.2.1-5mdv2010.0.i586.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Crystal Space 1.2.1: csgeom/math.h Source File (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
 <tr height="59">
  <td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
  <td class="head"><h2>Public API Reference</h2></td>
 </tr>
 <tr height="11">
  <td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
 </tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="modules.html"><span>Modules</span></a></li>
    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    <li><a href="classes.html"><span>Classes</span></a></li>
    <li class="current"><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul>
</div>
<h1>csgeom/math.h</h1><a href="math_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment">  Copyright (C) 2005 by Marten Svanfeldt</span>
<a name="l00003"></a>00003 <span class="comment">  </span>
<a name="l00004"></a>00004 <span class="comment">  This library is free software; you can redistribute it and/or</span>
<a name="l00005"></a>00005 <span class="comment">  modify it under the terms of the GNU Library General Public</span>
<a name="l00006"></a>00006 <span class="comment">  License as published by the Free Software Foundation; either</span>
<a name="l00007"></a>00007 <span class="comment">  version 2 of the License, or (at your option) any later version.</span>
<a name="l00008"></a>00008 <span class="comment"></span>
<a name="l00009"></a>00009 <span class="comment">  This library is distributed in the hope that it will be useful,</span>
<a name="l00010"></a>00010 <span class="comment">  but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00011"></a>00011 <span class="comment">  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU</span>
<a name="l00012"></a>00012 <span class="comment">  Library General Public License for more details.</span>
<a name="l00013"></a>00013 <span class="comment"></span>
<a name="l00014"></a>00014 <span class="comment">  You should have received a copy of the GNU Library General Public</span>
<a name="l00015"></a>00015 <span class="comment">  License along with this library; if not, write to the Free</span>
<a name="l00016"></a>00016 <span class="comment">  Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</span>
<a name="l00017"></a>00017 <span class="comment">*/</span>
<a name="l00018"></a>00018 
<a name="l00019"></a>00019 <span class="preprocessor">#ifndef __CS_MATH_H__</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define __CS_MATH_H__</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span>
<a name="l00022"></a>00022 <span class="preprocessor">#include "<a class="code" href="algorithms_8h.html" title="General Algorithms.">csutil/algorithms.h</a>"</span>
<a name="l00023"></a>00023 
<a name="l00034"></a>00034 <span class="keyword">template</span>&lt;<span class="keyword">class</span> T&gt;
<a name="l00035"></a><a class="code" href="group__geom__utils.html#g79291314e7548d3eb1df274158908235">00035</a> <span class="keyword">const</span> T&amp; <a class="code" href="group__geom__utils.html#g79291314e7548d3eb1df274158908235" title="Returns bigger of a and b.">csMax</a> (<span class="keyword">const</span> T&amp; a, <span class="keyword">const</span> T&amp; b)
<a name="l00036"></a>00036 {
<a name="l00037"></a>00037   <span class="keywordflow">if</span> (b &lt; a) <span class="keywordflow">return</span> a;
<a name="l00038"></a>00038   <span class="keywordflow">return</span> b;
<a name="l00039"></a>00039 }
<a name="l00040"></a>00040 
<a name="l00044"></a>00044 <span class="keyword">template</span>&lt;<span class="keyword">class</span> T&gt;
<a name="l00045"></a><a class="code" href="group__geom__utils.html#g16a5d316a30efbd72510b608e3233ea1">00045</a> <span class="keyword">const</span> T&amp; <a class="code" href="group__geom__utils.html#g16a5d316a30efbd72510b608e3233ea1" title="Returns smaller of a and b.">csMin</a> (<span class="keyword">const</span> T&amp; a, <span class="keyword">const</span> T&amp; b)
<a name="l00046"></a>00046 {
<a name="l00047"></a>00047   <span class="keywordflow">if</span> (a &lt; b) <span class="keywordflow">return</span> a;
<a name="l00048"></a>00048   <span class="keywordflow">return</span> b;
<a name="l00049"></a>00049 }
<a name="l00050"></a>00050 
<a name="l00054"></a>00054 <span class="keyword">template</span>&lt;<span class="keyword">class</span> T&gt;
<a name="l00055"></a><a class="code" href="group__geom__utils.html#g3192df8378b422cf7c3e4320a3c838bf">00055</a> <span class="keywordtype">void</span> <a class="code" href="group__geom__utils.html#g3192df8378b422cf7c3e4320a3c838bf" title="Sort a and b in order of size.">csSort</a> (T&amp; a, T&amp; b)
<a name="l00056"></a>00056 {
<a name="l00057"></a>00057   <span class="keywordflow">if</span> (b &lt; a)
<a name="l00058"></a>00058     <a class="code" href="namespaceCS.html#68d61355d1c8c8d00c9ed83c963a2dce" title="Swap two elements.">CS::Swap</a> (a, b);
<a name="l00059"></a>00059 }
<a name="l00060"></a>00060 
<a name="l00065"></a>00065 <span class="keyword">template</span>&lt;<span class="keyword">class</span> T, <span class="keyword">class</span> U&gt;
<a name="l00066"></a><a class="code" href="group__geom__utils.html#g1286eb4497b8d01ea5f8272509b7e99a">00066</a> <span class="keywordtype">void</span> <a class="code" href="group__geom__utils.html#g3192df8378b422cf7c3e4320a3c838bf" title="Sort a and b in order of size.">csSort</a> (T&amp; a, T&amp; b, U&amp; x, U&amp; y)
<a name="l00067"></a>00067 {
<a name="l00068"></a>00068   <span class="keywordflow">if</span> (b &lt; a)
<a name="l00069"></a>00069   {
<a name="l00070"></a>00070     <a class="code" href="namespaceCS.html#68d61355d1c8c8d00c9ed83c963a2dce" title="Swap two elements.">CS::Swap</a> (a, b);
<a name="l00071"></a>00071     <a class="code" href="namespaceCS.html#68d61355d1c8c8d00c9ed83c963a2dce" title="Swap two elements.">CS::Swap</a> (x, y);
<a name="l00072"></a>00072   }
<a name="l00073"></a>00073 }
<a name="l00074"></a>00074 
<a name="l00075"></a>00075 
<a name="l00079"></a>00079 <span class="keyword">template</span>&lt;<span class="keyword">class</span> T&gt;
<a name="l00080"></a><a class="code" href="group__geom__utils.html#g1c0100d274735df4706c4b903c9ba6f5">00080</a> T <a class="code" href="group__geom__utils.html#g1c0100d274735df4706c4b903c9ba6f5" title="Clamp a between max and min.">csClamp</a> (<span class="keyword">const</span> T&amp; a, T max, T min)
<a name="l00081"></a>00081 {
<a name="l00082"></a>00082   <span class="keywordflow">return</span> <a class="code" href="group__geom__utils.html#g16a5d316a30efbd72510b608e3233ea1" title="Returns smaller of a and b.">csMin</a> (<a class="code" href="group__geom__utils.html#g79291314e7548d3eb1df274158908235" title="Returns bigger of a and b.">csMax</a> (a, min), max);
<a name="l00083"></a>00083 }
<a name="l00084"></a>00084 
<a name="l00090"></a>00090 <span class="keyword">template</span>&lt;<span class="keyword">class</span> T&gt;
<a name="l00091"></a><a class="code" href="group__geom__utils.html#g5aa770bf13eb4b8ee00f34ae9ef64567">00091</a> T <a class="code" href="group__geom__utils.html#g5aa770bf13eb4b8ee00f34ae9ef64567" title="Performs a smooth interpolation of a on range min to max.">csSmoothStep</a> (<span class="keyword">const</span> T&amp; a, T max, T min)
<a name="l00092"></a>00092 {
<a name="l00093"></a>00093   T tmp, tmp2;
<a name="l00094"></a>00094   <span class="keywordflow">if</span> (a &lt;= min)
<a name="l00095"></a>00095     tmp = 0.0f;
<a name="l00096"></a>00096   <span class="keywordflow">else</span> <span class="keywordflow">if</span> (a &gt;= max)
<a name="l00097"></a>00097     tmp = 1.0f;
<a name="l00098"></a>00098   <span class="keywordflow">else</span>
<a name="l00099"></a>00099   {
<a name="l00100"></a>00100     tmp2 = (a - min) / (max-min);
<a name="l00101"></a>00101     tmp = tmp2*tmp2 * (3.0 - 2.0*tmp2);
<a name="l00102"></a>00102   }
<a name="l00103"></a>00103   <span class="keywordflow">return</span> tmp;
<a name="l00104"></a>00104 }
<a name="l00105"></a>00105 
<a name="l00110"></a>00110 <span class="keyword">template</span>&lt;<span class="keyword">class</span> T, <span class="keyword">class</span> Tfactor&gt;
<a name="l00111"></a><a class="code" href="group__geom__utils.html#gc34fecd9e6f85e9fcfc2bb081b160b81">00111</a> T <a class="code" href="group__geom__utils.html#gc34fecd9e6f85e9fcfc2bb081b160b81" title="Performs a linear interpolation between a and b with the factor f.">csLerp</a> (<span class="keyword">const</span> T&amp; a, <span class="keyword">const</span> T&amp; b, <span class="keyword">const</span> Tfactor&amp; f)
<a name="l00112"></a>00112 {
<a name="l00113"></a>00113   <span class="keywordflow">return</span> (a + (b - a) * f);
<a name="l00114"></a>00114 }
<a name="l00115"></a>00115 
<a name="l00119"></a>00119 <span class="keyword">template</span>&lt;<span class="keyword">class</span> T&gt;
<a name="l00120"></a><a class="code" href="group__geom__utils.html#g7e2758395886579dcca2faba48e67f94">00120</a> T <a class="code" href="group__geom__utils.html#g7e2758395886579dcca2faba48e67f94" title="Returns the square of the argument.">csSquare</a> (<span class="keyword">const</span> T&amp; x)
<a name="l00121"></a>00121 {
<a name="l00122"></a>00122   <span class="keywordflow">return</span> x * x;
<a name="l00123"></a>00123 }
<a name="l00124"></a>00124 
<a name="l00126"></a>00126 
<a name="l00127"></a><a class="code" href="group__geom__utils.html#ge589d6b05b27636b5c3d5d2ecc7af508">00127</a> CS_FORCEINLINE <span class="keywordtype">bool</span> <a class="code" href="group__geom__utils.html#ge589d6b05b27636b5c3d5d2ecc7af508" title="Checks if a floating point value is finite.">csFinite</a> (<span class="keywordtype">float</span> f)
<a name="l00128"></a>00128 {
<a name="l00129"></a>00129 <span class="preprocessor">#if defined (CS_HAVE_FINITEF)</span>
<a name="l00130"></a>00130 <span class="preprocessor"></span>  <span class="keywordflow">return</span> finitef (f);
<a name="l00131"></a>00131 <span class="preprocessor">#elif defined (CS_HAVE_STD__ISFINITE)</span>
<a name="l00132"></a>00132 <span class="preprocessor"></span>  <span class="keywordflow">return</span> std::isfinite (f);
<a name="l00133"></a>00133 <span class="preprocessor">#elif defined(CS_HAVE_ISFINITE)</span>
<a name="l00134"></a>00134 <span class="preprocessor"></span>  <span class="keywordflow">return</span> isfinite (f);
<a name="l00135"></a>00135 <span class="preprocessor">#elif defined (CS_HAVE_FINITE)</span>
<a name="l00136"></a>00136 <span class="preprocessor"></span>  <span class="keywordflow">return</span> finite (f);
<a name="l00137"></a>00137 <span class="preprocessor">#elif defined (CS_HAVE__FINITE)</span>
<a name="l00138"></a>00138 <span class="preprocessor"></span>  <span class="keywordflow">return</span> _finite (f) != 0;
<a name="l00139"></a>00139 <span class="preprocessor">#else</span>
<a name="l00140"></a>00140 <span class="preprocessor"></span><span class="preprocessor">#error Your platform has no isfinite()-alike function!</span>
<a name="l00141"></a>00141 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00142"></a>00142 <span class="preprocessor"></span>}
<a name="l00144"></a><a class="code" href="group__geom__utils.html#gb84e24b220cd40059738cc8aea20ea18">00144</a> CS_FORCEINLINE <span class="keywordtype">bool</span> <a class="code" href="group__geom__utils.html#ge589d6b05b27636b5c3d5d2ecc7af508" title="Checks if a floating point value is finite.">csFinite</a> (<span class="keywordtype">double</span> d)
<a name="l00145"></a>00145 {
<a name="l00146"></a>00146 <span class="preprocessor">#if defined (CS_HAVE_STD__ISFINITE)</span>
<a name="l00147"></a>00147 <span class="preprocessor"></span>  <span class="keywordflow">return</span> std::isfinite (d);
<a name="l00148"></a>00148 <span class="preprocessor">#elif defined(CS_HAVE_ISFINITE)</span>
<a name="l00149"></a>00149 <span class="preprocessor"></span>  <span class="keywordflow">return</span> isfinite (d);
<a name="l00150"></a>00150 <span class="preprocessor">#elif defined (CS_HAVE_FINITE)</span>
<a name="l00151"></a>00151 <span class="preprocessor"></span>  <span class="keywordflow">return</span> finite (d);
<a name="l00152"></a>00152 <span class="preprocessor">#elif defined (CS_HAVE__FINITE)</span>
<a name="l00153"></a>00153 <span class="preprocessor"></span>  <span class="keywordflow">return</span> _finite (d) != 0;
<a name="l00154"></a>00154 <span class="preprocessor">#else</span>
<a name="l00155"></a>00155 <span class="preprocessor"></span><span class="preprocessor">#error Your platform has no isfinite()-alike function!</span>
<a name="l00156"></a>00156 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00157"></a>00157 <span class="preprocessor"></span>}
<a name="l00158"></a>00158 
<a name="l00160"></a><a class="code" href="group__geom__utils.html#g5a443dfc570b99a0a3e3eec1141b0ffc">00160</a> CS_FORCEINLINE <span class="keywordtype">bool</span> <a class="code" href="group__geom__utils.html#g5a443dfc570b99a0a3e3eec1141b0ffc" title="Checks if a floating point value is not-a-number.">csNaN</a> (<span class="keywordtype">float</span> f)
<a name="l00161"></a>00161 {
<a name="l00162"></a>00162 <span class="preprocessor">#if defined (CS_HAVE_NANF)</span>
<a name="l00163"></a>00163 <span class="preprocessor"></span>  <span class="keywordflow">return</span> isnanf (f);
<a name="l00164"></a>00164 <span class="preprocessor">#elif defined (CS_HAVE_STD__ISNAN)</span>
<a name="l00165"></a>00165 <span class="preprocessor"></span>  <span class="keywordflow">return</span> std::isnan (f);
<a name="l00166"></a>00166 <span class="preprocessor">#elif defined(CS_HAVE_ISNAN)</span>
<a name="l00167"></a>00167 <span class="preprocessor"></span>  <span class="keywordflow">return</span> isnan (f);
<a name="l00168"></a>00168 <span class="preprocessor">#elif defined (CS_HAVE__ISNAN)</span>
<a name="l00169"></a>00169 <span class="preprocessor"></span>  <span class="keywordflow">return</span> _isnan (f) != 0;
<a name="l00170"></a>00170 <span class="preprocessor">#else</span>
<a name="l00171"></a>00171 <span class="preprocessor"></span><span class="preprocessor">#error Your platform has no isnan()-alike function!</span>
<a name="l00172"></a>00172 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00173"></a>00173 <span class="preprocessor"></span>}
<a name="l00175"></a><a class="code" href="group__geom__utils.html#ga452ffc07132608369d7b1f941638325">00175</a> CS_FORCEINLINE <span class="keywordtype">bool</span> <a class="code" href="group__geom__utils.html#g5a443dfc570b99a0a3e3eec1141b0ffc" title="Checks if a floating point value is not-a-number.">csNaN</a> (<span class="keywordtype">double</span> d)
<a name="l00176"></a>00176 {
<a name="l00177"></a>00177 <span class="preprocessor">#if defined (CS_HAVE_STD__ISNAN)</span>
<a name="l00178"></a>00178 <span class="preprocessor"></span>  <span class="keywordflow">return</span> std::isnan (d);
<a name="l00179"></a>00179 <span class="preprocessor">#elif defined(CS_HAVE_ISNAN)</span>
<a name="l00180"></a>00180 <span class="preprocessor"></span>  <span class="keywordflow">return</span> isnan (d);
<a name="l00181"></a>00181 <span class="preprocessor">#elif defined (CS_HAVE__ISNAN)</span>
<a name="l00182"></a>00182 <span class="preprocessor"></span>  <span class="keywordflow">return</span> _isnan (d) != 0;
<a name="l00183"></a>00183 <span class="preprocessor">#else</span>
<a name="l00184"></a>00184 <span class="preprocessor"></span><span class="preprocessor">#error Your platform has no isnan()-alike function!</span>
<a name="l00185"></a>00185 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00186"></a>00186 <span class="preprocessor"></span>}
<a name="l00187"></a>00187 
<a name="l00189"></a><a class="code" href="group__geom__utils.html#gc1760aed89ed0cc61c40d2826ab21c2c">00189</a> CS_FORCEINLINE <span class="keywordtype">bool</span> <a class="code" href="group__geom__utils.html#gc1760aed89ed0cc61c40d2826ab21c2c" title="Checks if a floating point value is normal (not infinite or nan).">csNormal</a> (<span class="keywordtype">float</span> f)
<a name="l00190"></a>00190 {
<a name="l00191"></a>00191 <span class="preprocessor">#if defined (CS_HAVE_NORMALF)</span>
<a name="l00192"></a>00192 <span class="preprocessor"></span>  <span class="keywordflow">return</span> normalf (f);
<a name="l00193"></a>00193 <span class="preprocessor">#elif defined (CS_HAVE_STD__ISNORMAL)</span>
<a name="l00194"></a>00194 <span class="preprocessor"></span>  <span class="keywordflow">return</span> std::isnormal (f);
<a name="l00195"></a>00195 <span class="preprocessor">#elif defined(CS_HAVE_ISNORMAL)</span>
<a name="l00196"></a>00196 <span class="preprocessor"></span>  <span class="keywordflow">return</span> isnormal (f);
<a name="l00197"></a>00197 <span class="preprocessor">#else</span>
<a name="l00198"></a>00198 <span class="preprocessor"></span>  <span class="keywordflow">return</span> <a class="code" href="group__geom__utils.html#ge589d6b05b27636b5c3d5d2ecc7af508" title="Checks if a floating point value is finite.">csFinite</a>(f) &amp;&amp; !<a class="code" href="group__geom__utils.html#g5a443dfc570b99a0a3e3eec1141b0ffc" title="Checks if a floating point value is not-a-number.">csNaN</a>(f);
<a name="l00199"></a>00199 <span class="preprocessor">#endif</span>
<a name="l00200"></a>00200 <span class="preprocessor"></span>}
<a name="l00202"></a><a class="code" href="group__geom__utils.html#g28088446394ecb4b3a0a40443b4bf76f">00202</a> CS_FORCEINLINE <span class="keywordtype">bool</span> <a class="code" href="group__geom__utils.html#gc1760aed89ed0cc61c40d2826ab21c2c" title="Checks if a floating point value is normal (not infinite or nan).">csNormal</a> (<span class="keywordtype">double</span> d)
<a name="l00203"></a>00203 {
<a name="l00204"></a>00204 <span class="preprocessor">#if defined (CS_HAVE_STD__ISNORMAL)</span>
<a name="l00205"></a>00205 <span class="preprocessor"></span>  <span class="keywordflow">return</span> std::isnormal (d);
<a name="l00206"></a>00206 <span class="preprocessor">#elif defined(CS_HAVE_ISNORMAL)</span>
<a name="l00207"></a>00207 <span class="preprocessor"></span>  <span class="keywordflow">return</span> isnormal (d);
<a name="l00208"></a>00208 <span class="preprocessor">#else</span>
<a name="l00209"></a>00209 <span class="preprocessor"></span>  <span class="keywordflow">return</span> <a class="code" href="group__geom__utils.html#ge589d6b05b27636b5c3d5d2ecc7af508" title="Checks if a floating point value is finite.">csFinite</a>(d) &amp;&amp; !<a class="code" href="group__geom__utils.html#g5a443dfc570b99a0a3e3eec1141b0ffc" title="Checks if a floating point value is not-a-number.">csNaN</a>(d);
<a name="l00210"></a>00210 <span class="preprocessor">#endif</span>
<a name="l00211"></a>00211 <span class="preprocessor"></span>}
<a name="l00213"></a>00213 
<a name="l00216"></a>00216 <span class="preprocessor">#endif //__CS_MATH_H__</span>
</pre></div><hr size="1"><address><small>Generated for Crystal Space 1.2.1 by 
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3 
</small></address> </div></body> </html>