Sophie

Sophie

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

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: CS::Math::Ode45 Class Reference (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 class="current"><a href="classes.html"><span>Classes</span></a></li>
    <li><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul>
</div>
<div class="tabs">
  <ul>
    <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  </ul>
</div>
<div class="nav">
<a class="el" href="namespaceCS.html">CS</a>::<a class="el" href="namespaceCS_1_1Math.html">Math</a>::<a class="el" href="classCS_1_1Math_1_1Ode45.html">Ode45</a></div>
<h1>CS::Math::Ode45 Class Reference</h1><!-- doxytag: class="CS::Math::Ode45" -->Embedded Runge-Kutta 4/5th order ODE solver for non-stiff ODEs.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="odesolver_8h-source.html">csgeom/odesolver.h</a>&gt;</code>
<p>

<p>
<a href="classCS_1_1Math_1_1Ode45-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2">template&lt;typename FuncType, typename ArgType&gt; </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static ArgType&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classCS_1_1Math_1_1Ode45.html#c8085461e3e8b411a67a99c070cb33b7">Step</a> (FuncType &amp;f, ArgType h, ArgType t0, ArgType y0, ArgType &amp;yout)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Step system a single step with step length h.  <a href="#c8085461e3e8b411a67a99c070cb33b7"></a><br></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2">template&lt;typename FuncType, typename ArgType&gt; </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static float&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classCS_1_1Math_1_1Ode45.html#0a9fc38bbee91c52e0edf079dd51acb4">Step</a> (FuncType &amp;f, ArgType h, ArgType t0, <a class="el" href="classcsVector3.html">csVector3</a> y0, <a class="el" href="classcsVector3.html">csVector3</a> &amp;yout)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Step system a single step with step length h.  <a href="#0a9fc38bbee91c52e0edf079dd51acb4"></a><br></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2">template&lt;typename FuncType, typename ArgType&gt; </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static ArgType&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classCS_1_1Math_1_1Ode45.html#eb07d672fb71fe274e22b6ac768fb30c">Step</a> (FuncType &amp;f, ArgType h, ArgType t0, ArgType *y0, ArgType *yout, size_t size)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Step system a single step with step length h.  <a href="#eb07d672fb71fe274e22b6ac768fb30c"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Embedded Runge-Kutta 4/5th order ODE solver for non-stiff ODEs. 
<p>
Solve the system<p>
y' = f(t, y)<p>
where y (and y') are scalar or vector.<p>
For reference, see: "Ordinary and partial differential equation routines in C, C++, Fortran, Java, Maple and MATLAB" by H.J. Lee &amp; W.E. Schiesser 
<p>Definition at line <a class="el" href="odesolver_8h-source.html#l00046">46</a> of file <a class="el" href="odesolver_8h-source.html">odesolver.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="c8085461e3e8b411a67a99c070cb33b7"></a><!-- doxytag: member="CS::Math::Ode45::Step" ref="c8085461e3e8b411a67a99c070cb33b7" args="(FuncType &amp;f, ArgType h, ArgType t0, ArgType y0, ArgType &amp;yout)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename FuncType, typename ArgType&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">static ArgType CS::Math::Ode45::Step           </td>
          <td>(</td>
          <td class="paramtype">FuncType &amp;&nbsp;</td>
          <td class="paramname"> <em>f</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">ArgType&nbsp;</td>
          <td class="paramname"> <em>h</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">ArgType&nbsp;</td>
          <td class="paramname"> <em>t0</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">ArgType&nbsp;</td>
          <td class="paramname"> <em>y0</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">ArgType &amp;&nbsp;</td>
          <td class="paramname"> <em>yout</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [inline, static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Step system a single step with step length h. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>f</em>&nbsp;</td><td>Function in y' = f(t, y) </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>h</em>&nbsp;</td><td>Step length </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>t0</em>&nbsp;</td><td>Initial time </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>y0</em>&nbsp;</td><td>Initial y value </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>yout</em>&nbsp;</td><td>Resulting y value </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Error estimate </dd></dl>

<p>Definition at line <a class="el" href="odesolver_8h-source.html#l00241">241</a> of file <a class="el" href="odesolver_8h-source.html">odesolver.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="0a9fc38bbee91c52e0edf079dd51acb4"></a><!-- doxytag: member="CS::Math::Ode45::Step" ref="0a9fc38bbee91c52e0edf079dd51acb4" args="(FuncType &amp;f, ArgType h, ArgType t0, csVector3 y0, csVector3 &amp;yout)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename FuncType, typename ArgType&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">static float CS::Math::Ode45::Step           </td>
          <td>(</td>
          <td class="paramtype">FuncType &amp;&nbsp;</td>
          <td class="paramname"> <em>f</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">ArgType&nbsp;</td>
          <td class="paramname"> <em>h</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">ArgType&nbsp;</td>
          <td class="paramname"> <em>t0</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classcsVector3.html">csVector3</a>&nbsp;</td>
          <td class="paramname"> <em>y0</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classcsVector3.html">csVector3</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>yout</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [inline, static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Step system a single step with step length h. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>f</em>&nbsp;</td><td>Function in y' = f(t, y) </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>h</em>&nbsp;</td><td>Step length </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>t0</em>&nbsp;</td><td>Initial time </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>y0</em>&nbsp;</td><td>Initial y value </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>yout</em>&nbsp;</td><td>Resulting y value </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Error estimate </dd></dl>

<p>Definition at line <a class="el" href="odesolver_8h-source.html#l00177">177</a> of file <a class="el" href="odesolver_8h-source.html">odesolver.h</a>.</p>

<p>References <a class="el" href="classcsVector3.html#42b1546a61c4fd76ec17c50592fcad1e">csVector3::Norm()</a>.</p>

</div>
</div><p>
<a class="anchor" name="eb07d672fb71fe274e22b6ac768fb30c"></a><!-- doxytag: member="CS::Math::Ode45::Step" ref="eb07d672fb71fe274e22b6ac768fb30c" args="(FuncType &amp;f, ArgType h, ArgType t0, ArgType *y0, ArgType *yout, size_t size)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename FuncType, typename ArgType&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">static ArgType CS::Math::Ode45::Step           </td>
          <td>(</td>
          <td class="paramtype">FuncType &amp;&nbsp;</td>
          <td class="paramname"> <em>f</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">ArgType&nbsp;</td>
          <td class="paramname"> <em>h</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">ArgType&nbsp;</td>
          <td class="paramname"> <em>t0</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">ArgType *&nbsp;</td>
          <td class="paramname"> <em>y0</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">ArgType *&nbsp;</td>
          <td class="paramname"> <em>yout</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>size</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [inline, static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Step system a single step with step length h. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>f</em>&nbsp;</td><td>Function in y' = f(t, y) </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>h</em>&nbsp;</td><td>Step length </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>t0</em>&nbsp;</td><td>Initial time </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>y0</em>&nbsp;</td><td>Initial y value </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>yout</em>&nbsp;</td><td>Resulting y value </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>size</em>&nbsp;</td><td>Number of elements in y0 and yout </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Error estimate </dd></dl>

<p>Definition at line <a class="el" href="odesolver_8h-source.html#l00062">62</a> of file <a class="el" href="odesolver_8h-source.html">odesolver.h</a>.</p>

<p>References <a class="el" href="cssysdef_8h-source.html#l00194">CS_ALLOC_STACK_ARRAY</a>.</p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>csgeom/<a class="el" href="odesolver_8h-source.html">odesolver.h</a></ul>
<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>