[Boost-commit] svn:boost r71960 - in sandbox/odeint/branches/karsten/libs/numeric/odeint/doc: . concepts html html/boost_sandbox_numeric_odeint

Subject: [Boost-commit] svn:boost r71960 - in sandbox/odeint/branches/karsten/libs/numeric/odeint/doc: . concepts html html/boost_sandbox_numeric_odeint
From: mario.mulansky_at_[hidden]
Date: 2011-05-15 15:13:41

Author: mariomulansky
Date: 2011-05-15 15:13:40 EDT (Sun, 15 May 2011)
New Revision: 71960
URL: http://svn.boost.org/trac/boost/changeset/71960

Log:
minor changes
Added:
   sandbox/odeint/branches/karsten/libs/numeric/odeint/doc/concepts/system.qbk   (contents, props changed)
Text files modified: 
   sandbox/odeint/branches/karsten/libs/numeric/odeint/doc/concepts.qbk                                         |     1 +                                       
   sandbox/odeint/branches/karsten/libs/numeric/odeint/doc/concepts/stepper.qbk                                 |     4 ++--                                    
   sandbox/odeint/branches/karsten/libs/numeric/odeint/doc/html/boost_sandbox_numeric_odeint/concepts.html      |     8 ++++----                                
   sandbox/odeint/branches/karsten/libs/numeric/odeint/doc/html/boost_sandbox_numeric_odeint/extend_odeint.html |     8 ++++----                                
   sandbox/odeint/branches/karsten/libs/numeric/odeint/doc/html/boost_sandbox_numeric_odeint/tutorial.html      |     8 ++++----                                
   sandbox/odeint/branches/karsten/libs/numeric/odeint/doc/html/index.html                                      |    14 +++++++-------                          
   6 files changed, 22 insertions(+), 21 deletions(-)

Modified: sandbox/odeint/branches/karsten/libs/numeric/odeint/doc/concepts.qbk
==============================================================================
--- sandbox/odeint/branches/karsten/libs/numeric/odeint/doc/concepts.qbk	(original)
+++ sandbox/odeint/branches/karsten/libs/numeric/odeint/doc/concepts.qbk	2011-05-15 15:13:40 EDT (Sun, 15 May 2011)
@@ -1,5 +1,6 @@
 [section Concepts]
 
+[include concepts/system.qbk]
 [include concepts/stepper.qbk]
 [include concepts/error_stepper.qbk]
 [include concepts/controlled_stepper.qbk]

Modified: sandbox/odeint/branches/karsten/libs/numeric/odeint/doc/concepts/stepper.qbk
==============================================================================
--- sandbox/odeint/branches/karsten/libs/numeric/odeint/doc/concepts/stepper.qbk	(original)
+++ sandbox/odeint/branches/karsten/libs/numeric/odeint/doc/concepts/stepper.qbk	2011-05-15 15:13:40 EDT (Sun, 15 May 2011)
@@ -37,7 +37,7 @@
 
 *  '''<para>'''[*order_type]'''</para>'''
 '''<para>'''`Stepper::order_type`'''</para>'''
-'''<para>'''The type characterizing the order of the ODE, typically something like `unsigned short`.'''</para>'''
+'''<para>'''The type characterizing the order of the ODE, typically `unsigned short`.'''</para>'''
 
 [endsect]
 
@@ -59,7 +59,7 @@
 [section Valid expressions]
 
 [table
-  [[Name] [Expression] [Type] [Semantics]]
+  [[Name] [Expression] [Returns] [Semantics]]
   [[Get the order] [`stepper.order()`] [`Order`] [Returns the order of the stepper which is used for error calculation.] ]
   [[Do step in-place] [`stepper.do_step( sys , x , t , dt )`] [`void`] [Performs one step of step size `dt`.  The newly obtained state is written in place in `x`.] ]
   [[Do step out-of-place] [`stepper.do_step( sys , in , t , out , dt )`] [`void`] [Performs one step. The newly obtained state is written to `out`] ]

Added: sandbox/odeint/branches/karsten/libs/numeric/odeint/doc/concepts/system.qbk
==============================================================================
--- (empty file)
+++ sandbox/odeint/branches/karsten/libs/numeric/odeint/doc/concepts/system.qbk	2011-05-15 15:13:40 EDT (Sun, 15 May 2011)
@@ -0,0 +1,37 @@
+[section Concept system]
+
+Concept Sytem
+
+[section Description]
+
+The System concept models the algorithmic implementation of the rhs. of the ODE, that is ['f(x,t)].
+The only requirement for this concept is that it should be callable with a specific parameter syntax (see below).
+A System is typically implemented as a function or a functor.
+
+[endsect]
+
+[section Notation]
+
+[variablelist 
+  [[State] [A type that is the `state_type` of Stepper]]
+  [[Deriv] [A type that is the `deriv_type` of Stepper]]
+  [[Time] [A type that is the `time_type` of Stepper]]
+  [[sys] [An object that models System]]
+  [[x] [Object of type State]]
+  [[dxdt] [Object of type Deriv]]
+  [[t] [Object of type Time]]
+]
+
+[endsect]
+
+[section Valid expressions]
+
+[table
+  [[Name] [Expression] [Returns] [Semantics]]
+  [[Calculate ['dx/dt := f(x,t)]] [`sys( x , dxdt , t )`] [`void`] [Calculates f(x,t), the result is stored into dxdt] ]
+]
+
+[endsect]
+
+
+[endsect]
\ No newline at end of file

Modified: sandbox/odeint/branches/karsten/libs/numeric/odeint/doc/html/boost_sandbox_numeric_odeint/concepts.html
==============================================================================
--- sandbox/odeint/branches/karsten/libs/numeric/odeint/doc/html/boost_sandbox_numeric_odeint/concepts.html	(original)
+++ sandbox/odeint/branches/karsten/libs/numeric/odeint/doc/html/boost_sandbox_numeric_odeint/concepts.html	2011-05-15 15:13:40 EDT (Sun, 15 May 2011)
@@ -3,7 +3,7 @@
 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
 <title>Concepts</title>
 <link rel="stylesheet" href="../boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
 <link rel="home" href="../index.html" title="Chapter&#160;1.&#160;boost.sandbox.numeric.odeint">
 <link rel="up" href="../index.html" title="Chapter&#160;1.&#160;boost.sandbox.numeric.odeint">
 <link rel="prev" href="extend_odeint/adapt_your_own_operations.html" title="Adapt your own operations">
@@ -13,9 +13,9 @@
 <table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
 <hr>
 <div class="spirit-nav">
-<a accesskey="p" href="extend_odeint/adapt_your_own_operations.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="concepts/concept_stepper.html"><img src="../images/next.png" alt="Next"></a>
+<a accesskey="p" href="extend_odeint/adapt_your_own_operations.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="concepts/concept_stepper.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
 </div>
-<div class="section">
+<div class="section" title="Concepts">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="boost_sandbox_numeric_odeint.concepts"></a><a class="link" href="concepts.html" title="Concepts">Concepts</a>
 </h2></div></div></div>
@@ -40,7 +40,7 @@
 </tr></table>
 <hr>
 <div class="spirit-nav">
-<a accesskey="p" href="extend_odeint/adapt_your_own_operations.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="concepts/concept_stepper.html"><img src="../images/next.png" alt="Next"></a>
+<a accesskey="p" href="extend_odeint/adapt_your_own_operations.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="concepts/concept_stepper.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
 </div>
 </body>
 </html>

Modified: sandbox/odeint/branches/karsten/libs/numeric/odeint/doc/html/boost_sandbox_numeric_odeint/extend_odeint.html
==============================================================================
--- sandbox/odeint/branches/karsten/libs/numeric/odeint/doc/html/boost_sandbox_numeric_odeint/extend_odeint.html	(original)
+++ sandbox/odeint/branches/karsten/libs/numeric/odeint/doc/html/boost_sandbox_numeric_odeint/extend_odeint.html	2011-05-15 15:13:40 EDT (Sun, 15 May 2011)
@@ -3,7 +3,7 @@
 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
 <title>Extend odeint</title>
 <link rel="stylesheet" href="../boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
 <link rel="home" href="../index.html" title="Chapter&#160;1.&#160;boost.sandbox.numeric.odeint">
 <link rel="up" href="../index.html" title="Chapter&#160;1.&#160;boost.sandbox.numeric.odeint">
 <link rel="prev" href="tutorial/references.html" title="References">
@@ -13,9 +13,9 @@
 <table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
 <hr>
 <div class="spirit-nav">
-<a accesskey="p" href="tutorial/references.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="extend_odeint/write_own_steppers.html"><img src="../images/next.png" alt="Next"></a>
+<a accesskey="p" href="tutorial/references.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="extend_odeint/write_own_steppers.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
 </div>
-<div class="section">
+<div class="section" title="Extend odeint">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="boost_sandbox_numeric_odeint.extend_odeint"></a><a class="link" href="extend_odeint.html" title="Extend odeint">Extend odeint</a>
 </h2></div></div></div>
@@ -38,7 +38,7 @@
 </tr></table>
 <hr>
 <div class="spirit-nav">
-<a accesskey="p" href="tutorial/references.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="extend_odeint/write_own_steppers.html"><img src="../images/next.png" alt="Next"></a>
+<a accesskey="p" href="tutorial/references.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="extend_odeint/write_own_steppers.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
 </div>
 </body>
 </html>

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-15 15:13:40 EDT (Sun, 15 May 2011)
@@ -3,7 +3,7 @@
 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
 <title>Tutorial</title>
 <link rel="stylesheet" href="../boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
 <link rel="home" href="../index.html" title="Chapter&#160;1.&#160;boost.sandbox.numeric.odeint">
 <link rel="up" href="../index.html" title="Chapter&#160;1.&#160;boost.sandbox.numeric.odeint">
 <link rel="prev" href="getting_started/short_example.html" title="Short Example">
@@ -13,9 +13,9 @@
 <table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
 <hr>
 <div class="spirit-nav">
-<a accesskey="p" href="getting_started/short_example.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="tutorial/harmonic_oscillator.html"><img src="../images/next.png" alt="Next"></a>
+<a accesskey="p" href="getting_started/short_example.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="tutorial/harmonic_oscillator.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
 </div>
-<div class="section">
+<div class="section" title="Tutorial">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="boost_sandbox_numeric_odeint.tutorial"></a><a class="link" href="tutorial.html" title="Tutorial">Tutorial</a>
 </h2></div></div></div>
@@ -47,7 +47,7 @@
 </tr></table>
 <hr>
 <div class="spirit-nav">
-<a accesskey="p" href="getting_started/short_example.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="tutorial/harmonic_oscillator.html"><img src="../images/next.png" alt="Next"></a>
+<a accesskey="p" href="getting_started/short_example.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="tutorial/harmonic_oscillator.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
 </div>
 </body>
 </html>

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-15 15:13:40 EDT (Sun, 15 May 2011)
@@ -3,15 +3,15 @@
 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
 <title>Chapter&#160;1.&#160;boost.sandbox.numeric.odeint</title>
 <link rel="stylesheet" href="boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
 <link rel="home" href="index.html" title="Chapter&#160;1.&#160;boost.sandbox.numeric.odeint">
 <link rel="next" href="boost_sandbox_numeric_odeint/getting_started.html" title="Getting started">
 </head>
 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 <table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
 <hr>
-<div class="spirit-nav"><a accesskey="n" href="boost_sandbox_numeric_odeint/getting_started.html"><img src="images/next.png" alt="Next"></a></div>
-<div class="chapter">
+<div class="spirit-nav"><a accesskey="n" href="boost_sandbox_numeric_odeint/getting_started.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a></div>
+<div class="chapter" title="Chapter&#160;1.&#160;boost.sandbox.numeric.odeint">
 <div class="titlepage"><div>
 <div><h2 class="title">
 <a name="odeint"></a>Chapter&#160;1.&#160;boost.sandbox.numeric.odeint</h2></div>
@@ -22,8 +22,8 @@
 <span class="firstname">Mario</span> <span class="surname">Mulansky</span>
 </h3></div></div>
 <div><p class="copyright">Copyright &#169; 2009 -2011 Karsten Ahnert and Mario Mulansky</p></div>
-<div><div class="legalnotice">
-<a name="id563836"></a><p>
+<div><div class="legalnotice" title="Legal Notice">
+<a name="id614718"></a><p>
         Distributed under the Boost Software License, Version 1.0. (See accompanying
         file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
       </p>
@@ -107,10 +107,10 @@
 </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: May 14, 2011 at 16:09:52 GMT</small></p></td>
+<td align="left"><p><small>Last revised: May 15, 2011 at 11:15:51 GMT</small></p></td>
 <td align="right"><div class="copyright-footer"></div></td>
 </tr></table>
 <hr>
-<div class="spirit-nav"><a accesskey="n" href="boost_sandbox_numeric_odeint/getting_started.html"><img src="images/next.png" alt="Next"></a></div>
+<div class="spirit-nav"><a accesskey="n" href="boost_sandbox_numeric_odeint/getting_started.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a></div>
 </body>
 </html>