Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r71913 - in sandbox/odeint/branches/karsten/libs/numeric/odeint/doc: . html html/boost_sandbox_numeric_odeint
From: karsten.ahnert_at_[hidden]
Date: 2011-05-13 06:07:35

Author: karsten
Date: 2011-05-13 06:07:33 EDT (Fri, 13 May 2011)
New Revision: 71913
URL: http://svn.boost.org/trac/boost/changeset/71913

Log:
added caution button to the docs
Text files modified:
   sandbox/odeint/branches/karsten/libs/numeric/odeint/doc/getting_started.qbk | 2 ++
   sandbox/odeint/branches/karsten/libs/numeric/odeint/doc/html/boost_sandbox_numeric_odeint/getting_started.html | 11 ++++++++++-
   sandbox/odeint/branches/karsten/libs/numeric/odeint/doc/html/boost_sandbox_numeric_odeint/reference.html | 2 +-
   sandbox/odeint/branches/karsten/libs/numeric/odeint/doc/html/boost_sandbox_numeric_odeint/tutorial.html | 6 +++---
   sandbox/odeint/branches/karsten/libs/numeric/odeint/doc/html/index.html | 11 ++++++++++-
   sandbox/odeint/branches/karsten/libs/numeric/odeint/doc/odeint.qbk | 1 +
   6 files changed, 27 insertions(+), 6 deletions(-)

Modified: sandbox/odeint/branches/karsten/libs/numeric/odeint/doc/getting_started.qbk
==============================================================================
--- sandbox/odeint/branches/karsten/libs/numeric/odeint/doc/getting_started.qbk (original)
+++ sandbox/odeint/branches/karsten/libs/numeric/odeint/doc/getting_started.qbk 2011-05-13 06:07:33 EDT (Fri, 13 May 2011)
@@ -2,6 +2,8 @@

[section Overview]

+[caution Boost.Odeint is not an official boost library!]
+
Odeint is a library for solving initial value problems (IVP) of ordinary differential equations. Mathematically, these problems are formulated as follows: ['x'(t) = f(x,t)], ['x(0) = x0]. ['x] and ['f] can be vectors and the solution is some function ['x(t)] fullfilling both equations above. In the following we will refer to ['x'(t)] also `dxdt` which is also our notation for the derivative in the source code.

Numerical approximations for the solution ['x(t)] are calculated iteratively. The easiest algorithm is the Euler-Scheme, where starting at ['x(0)] one finds ['x(dt) = x(0) + dt f(x(0),0)]. Now one can use ['x(dt)] and obtain ['x(2dt)] in a similar way and so on. The Euler method is of order 1, that means the error at each step is ['~ dt[super 2]]. This is, of course, not very satisfying, which is why the Euler method is merely used for real life problems and serves just as illustrative example. In odeint, the following algorithms are implemented:

Modified: sandbox/odeint/branches/karsten/libs/numeric/odeint/doc/html/boost_sandbox_numeric_odeint/getting_started.html
==============================================================================
--- sandbox/odeint/branches/karsten/libs/numeric/odeint/doc/html/boost_sandbox_numeric_odeint/getting_started.html (original)
+++ sandbox/odeint/branches/karsten/libs/numeric/odeint/doc/html/boost_sandbox_numeric_odeint/getting_started.html 2011-05-13 06:07:33 EDT (Fri, 13 May 2011)
@@ -30,6 +30,15 @@
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_sandbox_numeric_odeint.getting_started.overview"></a><a class="link" href="getting_started.html#boost_sandbox_numeric_odeint.getting_started.overview" title="Overview">Overview</a>
</h3></div></div></div>
+<div class="caution"><table border="0" summary="Caution">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Caution]" src="../images/caution.png"></td>
+<th align="left">Caution</th>
+</tr>
+<tr><td align="left" valign="top"><p>
+ Boost.Odeint is not an official boost library!
+ </p></td></tr>
+</table></div>
<p>
         Odeint is a library for solving initial value problems (IVP) of ordinary
         differential equations. Mathematically, these problems are formulated as
@@ -52,7 +61,7 @@
         algorithms are implemented:
       </p>
<div class="table">
-<a name="id533115"></a><p class="title"><b>Table 1.1. Stepper Algorithms</b></p>
+<a name="id532034"></a><p class="title"><b>Table 1.1. Stepper Algorithms</b></p>
<div class="table-contents"><table class="table" summary="Stepper Algorithms">
<colgroup>
<col>

Modified: sandbox/odeint/branches/karsten/libs/numeric/odeint/doc/html/boost_sandbox_numeric_odeint/reference.html
==============================================================================
--- sandbox/odeint/branches/karsten/libs/numeric/odeint/doc/html/boost_sandbox_numeric_odeint/reference.html (original)
+++ sandbox/odeint/branches/karsten/libs/numeric/odeint/doc/html/boost_sandbox_numeric_odeint/reference.html 2011-05-13 06:07:33 EDT (Fri, 13 May 2011)
@@ -33,7 +33,7 @@
classes</a>
</h3></div></div></div>
<div class="table">
-<a name="id589793"></a><p class="title"><b>Table 1.4. Stepper Algorithms</b></p>
+<a name="id589875"></a><p class="title"><b>Table 1.4. Stepper Algorithms</b></p>
<div class="table-contents"><table class="table" summary="Stepper Algorithms">
<colgroup>
<col>

Modified: sandbox/odeint/branches/karsten/libs/numeric/odeint/doc/html/boost_sandbox_numeric_odeint/tutorial.html
==============================================================================
--- sandbox/odeint/branches/karsten/libs/numeric/odeint/doc/html/boost_sandbox_numeric_odeint/tutorial.html (original)
+++ sandbox/odeint/branches/karsten/libs/numeric/odeint/doc/html/boost_sandbox_numeric_odeint/tutorial.html 2011-05-13 06:07:33 EDT (Fri, 13 May 2011)
@@ -141,7 +141,7 @@
           choose:
         </p>
<div class="table">
-<a name="id575770"></a><p class="title"><b>Table 1.2. Stepper Algorithms</b></p>
+<a name="id575784"></a><p class="title"><b>Table 1.2. Stepper Algorithms</b></p>
<div class="table-contents"><table class="table" summary="Stepper Algorithms">
<colgroup>
<col>
@@ -1027,7 +1027,7 @@
<span class="keyword">while</span><span class="special">(</span> <span class="keyword">true</span> <span class="special">)</span>
<span class="special">{</span>
         <span class="identifier">t</span> <span class="special">=</span> <span class="identifier">integrate_n_steps</span><span class="special">(</span> <span class="identifier">rk4</span> <span class="special">,</span> <span class="identifier">lorenz_with_lyap</span> <span class="special">,</span> <span class="identifier">x</span> <span class="special">,</span> <span class="identifier">t</span> <span class="special">,</span> <span class="identifier">dt</span> <span class="special">,</span> <span class="number">100</span> <span class="special">);</span>
- <span class="identifier">gram_schmitt</span><span class="special">(</span> <span class="identifier">x</span> <span class="special">,</span> <span class="identifier">lyap</span> <span class="special">,</span> <span class="identifier">n</span> <span class="special">,</span> <span class="identifier">num_of_lyap</span> <span class="special">);</span>
+ <span class="identifier">gram_schmidt</span><span class="special">(</span> <span class="identifier">x</span> <span class="special">,</span> <span class="identifier">lyap</span> <span class="special">,</span> <span class="identifier">n</span> <span class="special">,</span> <span class="identifier">num_of_lyap</span> <span class="special">);</span>
         <span class="special">++</span><span class="identifier">count</span><span class="special">;</span>

     <span class="keyword">if</span><span class="special">(</span> <span class="special">!(</span><span class="identifier">count</span> <span class="special">%</span> <span class="number">100000</span><span class="special">)</span> <span class="special">)</span>
@@ -1355,7 +1355,7 @@
         The following table gives an overview over all examples.
       </p>
<div class="table">
-<a name="id586564"></a><p class="title"><b>Table 1.3. Examples Overview</b></p>
+<a name="id586646"></a><p class="title"><b>Table 1.3. Examples Overview</b></p>
<div class="table-contents"><table class="table" summary="Examples Overview">
<colgroup>
<col>

Modified: sandbox/odeint/branches/karsten/libs/numeric/odeint/doc/html/index.html
==============================================================================
--- sandbox/odeint/branches/karsten/libs/numeric/odeint/doc/html/index.html (original)
+++ sandbox/odeint/branches/karsten/libs/numeric/odeint/doc/html/index.html 2011-05-13 06:07:33 EDT (Fri, 13 May 2011)
@@ -93,9 +93,18 @@
</dl></dd>
</dl>
</div>
+<div class="caution"><table border="0" summary="Caution">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Caution]" src="images/caution.png"></td>
+<th align="left">Caution</th>
+</tr>
+<tr><td align="left" valign="top"><p>
+ Boost.Odeint is not an official boost library!
+ </p></td></tr>
+</table></div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left"><p><small>Last revised: April 12, 2011 at 15:11:39 GMT</small></p></td>
+<td align="left"><p><small>Last revised: May 13, 2011 at 10:39:06 GMT</small></p></td>
<td align="right"><div class="copyright-footer"></div></td>
</tr></table>
<hr>

Modified: sandbox/odeint/branches/karsten/libs/numeric/odeint/doc/odeint.qbk
==============================================================================
--- sandbox/odeint/branches/karsten/libs/numeric/odeint/doc/odeint.qbk (original)
+++ sandbox/odeint/branches/karsten/libs/numeric/odeint/doc/odeint.qbk 2011-05-13 06:07:33 EDT (Fri, 13 May 2011)
@@ -44,6 +44,7 @@
[template sub[x]'''<subscript>'''[x]'''</subscript>''']
[template subl[x]'''<subscript>'''__space[x]'''</subscript>''']

+[caution Boost.Odeint is not an official boost library!]

[include getting_started.qbk]

Date view	Thread view	Subject view	Author view

Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk