|
|
Boost-Commit : |
Subject: [Boost-commit] svn:boost r59700 - in sandbox/odeint: . boost/numeric/odeint libs/numeric/odeint/doc libs/numeric/odeint/doc/html libs/numeric/odeint/doc/html/odeint
From: karsten.ahnert_at_[hidden]
Date: 2010-02-16 11:23:45
Author: karsten
Date: 2010-02-16 11:23:44 EST (Tue, 16 Feb 2010)
New Revision: 59700
URL: http://svn.boost.org/trac/boost/changeset/59700
Log:
documentation and todo list
Added:
sandbox/odeint/ToDo (contents, props changed)
sandbox/odeint/libs/numeric/odeint/doc/container_traits.qbk (contents, props changed)
sandbox/odeint/libs/numeric/odeint/doc/integrate_functions.qbk (contents, props changed)
sandbox/odeint/libs/numeric/odeint/doc/steppers.qbk (contents, props changed)
sandbox/odeint/libs/numeric/odeint/doc/tutorial.qbk (contents, props changed)
Text files modified:
sandbox/odeint/boost/numeric/odeint/observer.hpp | 1
sandbox/odeint/libs/numeric/odeint/doc/html/index.html | 49 ++++++++++++++++++++++++++++++---------
sandbox/odeint/libs/numeric/odeint/doc/html/odeint/short_example.html | 14 +++++-----
sandbox/odeint/libs/numeric/odeint/doc/html/odeint/tutorial.html | 27 +++++++++++----------
sandbox/odeint/libs/numeric/odeint/doc/html/standalone_HTML.manifest | 4 +++
sandbox/odeint/libs/numeric/odeint/doc/odeint.qbk | 12 ++++++++
6 files changed, 74 insertions(+), 33 deletions(-)
Added: sandbox/odeint/ToDo
==============================================================================
--- (empty file)
+++ sandbox/odeint/ToDo 2010-02-16 11:23:44 EST (Tue, 16 Feb 2010)
@@ -0,0 +1,65 @@
+= Features and Coding issues: =
+
+Karsten:
+* Resizer functionality should be called explicitly and not in every call of do_step or try_step
+* Add new order function (because we need three orders for rk78)
+* deriv every stepper from stepper_base< stepper >, because do_step( system , x , t , dt ) is only implemented ones ( and calls the special do_step( system , x , dxdt , t , dt )
+* In all steppers:
+ * const unsigned short -> short
+ * typedef typename traits_type::container_type container_type statt typedef Container container_type
+
+Mario:
+* code cleanup:
+ * error_checker in controlled_stepper_standard
+ * all iterator functionality in iterator_algebra
+ * cleanup iterator algebra
+
+* all std::vector should given explictly the allocator
+
+* numeric_traits or something similar for pow, abs, norm, sqrt ...
+
+Karsten: check
+* hamiltonian solvers with input std::pair< container_type , container_type >, than it can be used in integrate_const.
+
+Mario: check
+* change integrate_const to use number of steps instead of end_time and remove integrate_const_step
+* same order of parameters in the integration functions
+* Observer the observer should be able to tell the integrate function at which times it wants to analyze the state and the integrator should adapt (decrease) the stepsize accordingly to exactly hit these times - at least for adaptive methods - for constant stepsize integration the observers can remain as is.
+
+Mario:
+* state_copy_observer : statt der inserter die container direkt uebergeben
+
+
+= container_traits for =
+
+* boost::ublas / funktioniert
+* mtl4, implementing real iterators / funktioniert so gehackt, nicht submitten
+* blitz++ / funktioniert , nicht submitten
+* boost::multi_array / muss gemacht werden
+
+
+= Unit testing =
+
+Karsten:
+* aufsetzen des Frameworks
+
+= Documentation =
+
+* eventuell ein graph typ fürs tutorial
+
+
+= Examples and perforance testing =
+
+* cleanup examples directory, only one example per system
+* create performance directory/project
+* one example with complex types, cgle, mit spiral waves und multi_array (grisha)
+
+
+= Headers =
+
+* header cleanup, every header should include all header it needs
+* <tr1/array> ist not always present, on many systems it is <array>
+
+
+
+
Modified: sandbox/odeint/boost/numeric/odeint/observer.hpp
==============================================================================
--- sandbox/odeint/boost/numeric/odeint/observer.hpp (original)
+++ sandbox/odeint/boost/numeric/odeint/observer.hpp 2010-02-16 11:23:44 EST (Tue, 16 Feb 2010)
@@ -54,6 +54,7 @@
}
};
+
} // odeint
} // numeric
} // boost
Added: sandbox/odeint/libs/numeric/odeint/doc/container_traits.qbk
==============================================================================
--- (empty file)
+++ sandbox/odeint/libs/numeric/odeint/doc/container_traits.qbk 2010-02-16 11:23:44 EST (Tue, 16 Feb 2010)
@@ -0,0 +1,9 @@
+[section Container traits]
+
+definitions
+
+[section Define your own traits]
+
+[endsect]
+
+[endsect]
Modified: sandbox/odeint/libs/numeric/odeint/doc/html/index.html
==============================================================================
--- sandbox/odeint/libs/numeric/odeint/doc/html/index.html (original)
+++ sandbox/odeint/libs/numeric/odeint/doc/html/index.html 2010-02-16 11:23:44 EST (Tue, 16 Feb 2010)
@@ -1,10 +1,10 @@
<html>
<head>
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<title>Chapter 1. boost.sandbox.numeric.odeint</title>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Chapter 1. boost.sandbox.numeric.odeint</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
-<link rel="start" href="index.html" title="Chapter 1. boost.sandbox.numeric.odeint">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="index.html" title="Chapter 1. boost.sandbox.numeric.odeint">
<link rel="next" href="odeint/short_example.html" title="Short Example">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@@ -18,19 +18,19 @@
</tr></table>
<hr>
<div class="spirit-nav"><a accesskey="n" href="odeint/short_example.html"><img src="../../doc/html/images/next.png" alt="Next"></a></div>
-<div class="chapter" lang="en">
+<div class="chapter" title="Chapter 1. boost.sandbox.numeric.odeint">
<div class="titlepage"><div>
<div><h2 class="title">
-<a name="odeint"></a>Chapter 1. boost.sandbox.numeric.odeint</h2></div>
+<a name="odeint"></a>Chapter 1. boost.sandbox.numeric.odeint</h2></div>
<div><div class="author"><h3 class="author">
<span class="firstname">Karsten</span> <span class="surname">Ahnert</span>
</h3></div></div>
<div><div class="author"><h3 class="author">
<span class="firstname">Mario</span> <span class="surname">Mulansky</span>
</h3></div></div>
-<div><p class="copyright">Copyright © 2009 Karsten Ahnert and Mario Mulansky</p></div>
-<div><div class="legalnotice">
-<a name="id325363"></a><p>
+<div><p class="copyright">Copyright © 2009 Karsten Ahnert and Mario Mulansky</p></div>
+<div><div class="legalnotice" title="Legal Notice">
+<a name="id366480"></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>
@@ -50,9 +50,34 @@
<dt><span class="section"><a href="odeint/tutorial.html#odeint.tutorial.integration_with_adaptive_stepsize">Integration
with Adaptive Stepsize</a></span></dt>
</dl></dd>
+<dt><span class="section">Tutorial2</span></dt>
+<dd><dl>
+<dt><span class="section"><a href="boost_sandbox_numeric_odeint/tutorial2.html#boost_sandbox_numeric_odeint.tutorial2.harmonic_oscillator">Harmonic
+ oscillator</a></span></dt>
+<dt><span class="section"><a href="boost_sandbox_numeric_odeint/tutorial2.html#boost_sandbox_numeric_odeint.tutorial2.solar_system">Solar
+ system</a></span></dt>
+</dl></dd>
+<dt><span class="section">Stepper</span></dt>
+<dd><dl>
+<dt><span class="section">Concepts</span></dt>
+<dt><span class="section"><a href="boost_sandbox_numeric_odeint/stepper.html#boost_sandbox_numeric_odeint.stepper.stepper_classes">Stepper
+ classes</a></span></dt>
+</dl></dd>
+<dt><span class="section"><a href="boost_sandbox_numeric_odeint/integration_functions.html">Integration
+ functions</a></span></dt>
+<dd><dl>
+<dt><span class="section"><a href="boost_sandbox_numeric_odeint/integration_functions.html#boost_sandbox_numeric_odeint.integration_functions.constant_step_size_functions">Constant
+ step-size functions</a></span></dt>
+<dt><span class="section"><a href="boost_sandbox_numeric_odeint/integration_functions.html#boost_sandbox_numeric_odeint.integration_functions.adaptive_step_size_functions">Adaptive
+ step-size functions</a></span></dt>
+</dl></dd>
+<dt><span class="section"><a href="boost_sandbox_numeric_odeint/container_traits.html">Container
+ traits</a></span></dt>
+<dd><dl><dt><span class="section"><a href="boost_sandbox_numeric_odeint/container_traits.html#boost_sandbox_numeric_odeint.container_traits.define_your_own_traits">Define
+ your own traits</a></span></dt></dl></dd>
</dl>
</div>
-<div class="section" lang="en">
+<div class="section" title="Overview">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="odeint.overview"></a><a class="link" href="index.html#odeint.overview" title="Overview">Overview</a>
</h2></div></div></div>
@@ -70,7 +95,7 @@
for real life problems and serves just as illustrative example. In <span class="bold"><strong>odeint</strong></span>, the following algorithms are implemented:
</p>
<div class="table">
-<a name="id326850"></a><p class="title"><b>Table 1.1. Stepper Algorithms</b></p>
+<a name="id335508"></a><p class="title"><b>Table 1.1. Stepper Algorithms</b></p>
<div class="table-contents"><table class="table" summary="Stepper Algorithms">
<colgroup>
<col>
@@ -240,7 +265,7 @@
</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: January 20, 2010 at 19:11:53 GMT</small></p></td>
+<td align="left"><p><small>Last revised: February 16, 2010 at 14:51:53 GMT</small></p></td>
<td align="right"><div class="copyright-footer"></div></td>
</tr></table>
<hr>
Modified: sandbox/odeint/libs/numeric/odeint/doc/html/odeint/short_example.html
==============================================================================
--- sandbox/odeint/libs/numeric/odeint/doc/html/odeint/short_example.html (original)
+++ sandbox/odeint/libs/numeric/odeint/doc/html/odeint/short_example.html 2010-02-16 11:23:44 EST (Tue, 16 Feb 2010)
@@ -1,12 +1,12 @@
<html>
<head>
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Short Example</title>
<link rel="stylesheet" href="../boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
-<link rel="start" href="../index.html" title="Chapter 1. boost.sandbox.numeric.odeint">
-<link rel="up" href="../index.html" title="Chapter 1. boost.sandbox.numeric.odeint">
-<link rel="prev" href="../index.html" title="Chapter 1. boost.sandbox.numeric.odeint">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../index.html" title="Chapter 1. boost.sandbox.numeric.odeint">
+<link rel="up" href="../index.html" title="Chapter 1. boost.sandbox.numeric.odeint">
+<link rel="prev" href="../index.html" title="Chapter 1. boost.sandbox.numeric.odeint">
<link rel="next" href="tutorial.html" title="Tutorial">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@@ -22,7 +22,7 @@
<div class="spirit-nav">
<a accesskey="p" href="../index.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.html"><img src="../../../doc/html/images/next.png" alt="Next"></a>
</div>
-<div class="section" lang="en">
+<div class="section" title="Short Example">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="odeint.short_example"></a><a class="link" href="short_example.html" title="Short Example">Short Example</a>
</h2></div></div></div>
@@ -146,7 +146,7 @@
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
-<td align="right"><div class="copyright-footer">Copyright © 2009 Karsten Ahnert and Mario Mulansky<p>
+<td align="right"><div class="copyright-footer">Copyright © 2009 Karsten Ahnert and Mario Mulansky<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>
Modified: sandbox/odeint/libs/numeric/odeint/doc/html/odeint/tutorial.html
==============================================================================
--- sandbox/odeint/libs/numeric/odeint/doc/html/odeint/tutorial.html (original)
+++ sandbox/odeint/libs/numeric/odeint/doc/html/odeint/tutorial.html 2010-02-16 11:23:44 EST (Tue, 16 Feb 2010)
@@ -1,12 +1,13 @@
<html>
<head>
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<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.73.2">
-<link rel="start" href="../index.html" title="Chapter 1. boost.sandbox.numeric.odeint">
-<link rel="up" href="../index.html" title="Chapter 1. boost.sandbox.numeric.odeint">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../index.html" title="Chapter 1. boost.sandbox.numeric.odeint">
+<link rel="up" href="../index.html" title="Chapter 1. boost.sandbox.numeric.odeint">
<link rel="prev" href="short_example.html" title="Short Example">
+<link rel="next" href="../boost_sandbox_numeric_odeint/tutorial2.html" title="Tutorial2">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
@@ -19,9 +20,9 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="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="p" href="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="../boost_sandbox_numeric_odeint/tutorial2.html"><img src="../../../doc/html/images/next.png" alt="Next"></a>
</div>
-<div class="section" lang="en">
+<div class="section" title="Tutorial">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="odeint.tutorial"></a><a class="link" href="tutorial.html" title="Tutorial">Tutorial</a>
</h2></div></div></div>
@@ -33,7 +34,7 @@
<dt><span class="section"><a href="tutorial.html#odeint.tutorial.integration_with_adaptive_stepsize">Integration
with Adaptive Stepsize</a></span></dt>
</dl></div>
-<div class="section" lang="en">
+<div class="section" title="Define the ODE">
<div class="titlepage"><div><div><h3 class="title">
<a name="odeint.tutorial.define_the_ode"></a><a class="link" href="tutorial.html#odeint.tutorial.define_the_ode" title="Define the ODE">Define the ODE</a>
</h3></div></div></div>
@@ -113,7 +114,7 @@
which allows for cleaner code.
</p>
</div>
-<div class="section" lang="en">
+<div class="section" title="Stepper Types">
<div class="titlepage"><div><div><h3 class="title">
<a name="odeint.tutorial.stepper_types"></a><a class="link" href="tutorial.html#odeint.tutorial.stepper_types" title="Stepper Types">Stepper Types</a>
</h3></div></div></div>
@@ -130,7 +131,7 @@
<span class="bold"><strong>ErrorStepper</strong></span> and <span class="bold"><strong>ControlledStepper</strong></span>.
</p>
<div class="table">
-<a name="id368578"></a><p class="title"><b>Table 1.2. Stepper Algorithms</b></p>
+<a name="id376675"></a><p class="title"><b>Table 1.2. Stepper Algorithms</b></p>
<div class="table-contents"><table class="table" summary="Stepper Algorithms">
<colgroup>
<col>
@@ -298,7 +299,7 @@
</div>
<br class="table-break">
</div>
-<div class="section" lang="en">
+<div class="section" title="Integration with Constant Stepsize">
<div class="titlepage"><div><div><h3 class="title">
<a name="odeint.tutorial.integration_with_constant_stepsize"></a><a class="link" href="tutorial.html#odeint.tutorial.integration_with_constant_stepsize" title="Integration with Constant Stepsize">Integration
with Constant Stepsize</a>
@@ -346,14 +347,14 @@
(in-place).
</p>
</div>
-<div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title">
+<div class="section" title="Integration with Adaptive Stepsize"><div class="titlepage"><div><div><h3 class="title">
<a name="odeint.tutorial.integration_with_adaptive_stepsize"></a><a class="link" href="tutorial.html#odeint.tutorial.integration_with_adaptive_stepsize" title="Integration with Adaptive Stepsize">Integration
with Adaptive Stepsize</a>
</h3></div></div></div></div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
-<td align="right"><div class="copyright-footer">Copyright © 2009 Karsten Ahnert and Mario Mulansky<p>
+<td align="right"><div class="copyright-footer">Copyright © 2009 Karsten Ahnert and Mario Mulansky<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>
@@ -361,7 +362,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="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="p" href="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="../boost_sandbox_numeric_odeint/tutorial2.html"><img src="../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>
Modified: sandbox/odeint/libs/numeric/odeint/doc/html/standalone_HTML.manifest
==============================================================================
--- sandbox/odeint/libs/numeric/odeint/doc/html/standalone_HTML.manifest (original)
+++ sandbox/odeint/libs/numeric/odeint/doc/html/standalone_HTML.manifest 2010-02-16 11:23:44 EST (Tue, 16 Feb 2010)
@@ -1,3 +1,7 @@
index.html
odeint/short_example.html
odeint/tutorial.html
+boost_sandbox_numeric_odeint/tutorial2.html
+boost_sandbox_numeric_odeint/stepper.html
+boost_sandbox_numeric_odeint/integration_functions.html
+boost_sandbox_numeric_odeint/container_traits.html
Added: sandbox/odeint/libs/numeric/odeint/doc/integrate_functions.qbk
==============================================================================
--- (empty file)
+++ sandbox/odeint/libs/numeric/odeint/doc/integrate_functions.qbk 2010-02-16 11:23:44 EST (Tue, 16 Feb 2010)
@@ -0,0 +1,11 @@
+[section Integration functions]
+
+[section Constant step-size functions]
+
+[endsect]
+
+[section Adaptive step-size functions]
+
+[endsect]
+
+[endsect]
Modified: sandbox/odeint/libs/numeric/odeint/doc/odeint.qbk
==============================================================================
--- sandbox/odeint/libs/numeric/odeint/doc/odeint.qbk (original)
+++ sandbox/odeint/libs/numeric/odeint/doc/odeint.qbk 2010-02-16 11:23:44 EST (Tue, 16 Feb 2010)
@@ -181,4 +181,14 @@
[endsect]
-[endsect]
\ No newline at end of file
+[endsect]
+
+
+
+[include tutorial.qbk]
+
+[include steppers.qbk]
+
+[include integrate_functions.qbk]
+
+[include container_traits.qbk]
Added: sandbox/odeint/libs/numeric/odeint/doc/steppers.qbk
==============================================================================
--- (empty file)
+++ sandbox/odeint/libs/numeric/odeint/doc/steppers.qbk 2010-02-16 11:23:44 EST (Tue, 16 Feb 2010)
@@ -0,0 +1,45 @@
+[section Stepper]
+
+
+[section Concepts]
+
+; huhu
+
+[section Basic stepper]
+
+definitions
+
+which class models this concept
+
+[endsect]
+
+[section Error stepper]
+
+definitions
+
+which class models this concept
+
+
+[endsect]
+
+[section Controlled stepper]
+
+definitions
+
+which class models this concept
+
+
+[endsect]
+
+[endsect]
+
+
+[section Stepper classes]
+
+overview table
+
+all stepper classes
+
+[endsect]
+
+[endsect]
Added: sandbox/odeint/libs/numeric/odeint/doc/tutorial.qbk
==============================================================================
--- (empty file)
+++ sandbox/odeint/libs/numeric/odeint/doc/tutorial.qbk 2010-02-16 11:23:44 EST (Tue, 16 Feb 2010)
@@ -0,0 +1,25 @@
+[section Tutorial2]
+
+huhu
+
+[section Harmonic oscillator]
+
+define the system, via function and via classes
+
+usage of the steppers
+
+usage of the integration functions
+
+[endsect]
+
+[section Solar system]
+
+define point types via operators
+
+define the system
+
+usage of the steppers
+
+[endsect]
+
+[endsect]
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