devn00b
/
EQ2EMu


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882
							<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>State Algebra Operations</title>
<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../index.html" title="Chapter&#160;1.&#160;Boost.Numeric.Odeint">
<link rel="up" href="../concepts.html" title="Concepts">
<link rel="prev" href="dense_output_stepper.html" title="Dense Output Stepper">
<link rel="next" href="state_wrapper.html" title="State Wrapper">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../logo.jpg"></td>
<td align="center"><a href="../../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="dense_output_stepper.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../concepts.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="state_wrapper.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_numeric_odeint.concepts.state_algebra_operations"></a><a class="link" href="state_algebra_operations.html" title="State Algebra Operations">State
      Algebra Operations</a>
</h3></div></div></div>
<div class="toc"><dl class="toc">
<dt><span class="section"><a href="state_algebra_operations.html#boost_numeric_odeint.concepts.state_algebra_operations.operations">Operations</a></span></dt>
<dt><span class="section"><a href="state_algebra_operations.html#boost_numeric_odeint.concepts.state_algebra_operations.algebra">Algebra</a></span></dt>
<dt><span class="section"><a href="state_algebra_operations.html#boost_numeric_odeint.concepts.state_algebra_operations.pre_defined_implementations">Pre-Defined
        implementations</a></span></dt>
<dt><span class="section"><a href="state_algebra_operations.html#boost_numeric_odeint.concepts.state_algebra_operations.example_expressions">Example
        expressions</a></span></dt>
</dl></div>
<div class="note"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../../doc/src/images/note.png"></td>
<th align="left">Note</th>
</tr>
<tr><td align="left" valign="top"><p>
          The following does not apply to implicit steppers like implicit_euler or
          Rosenbrock 4 as there the <code class="computeroutput"><span class="identifier">state_type</span></code>
          can not be changed from <code class="computeroutput"><span class="identifier">ublas</span><span class="special">::</span><span class="identifier">vector</span></code>
          and no algebra/operations are used.
        </p></td></tr>
</table></div>
<h5>
<a name="boost_numeric_odeint.concepts.state_algebra_operations.h0"></a>
        <span class="phrase"><a name="boost_numeric_odeint.concepts.state_algebra_operations.description"></a></span><a class="link" href="state_algebra_operations.html#boost_numeric_odeint.concepts.state_algebra_operations.description">Description</a>
      </h5>
<p>
        The <code class="computeroutput"><span class="identifier">State</span></code>, <code class="computeroutput"><span class="identifier">Algebra</span></code> and <code class="computeroutput"><span class="identifier">Operations</span></code>
        together define a concept describing how the mathematical vector operations
        required for the stepper algorithms are performed. The typical vector operation
        done within steppers is
      </p>
<p>
        <span class="emphasis"><em><span class="bold"><strong>y</strong></span> = &#931; &#945;<sub>i</sub> <span class="bold"><strong>x<sub>i</sub></strong></span></em></span>.
      </p>
<p>
        The <code class="computeroutput"><span class="identifier">State</span></code> represents the
        state variable of an ODE, usually denoted with <span class="emphasis"><em>x</em></span>. Algorithmically,
        the state is often realized as a <code class="computeroutput"><span class="identifier">vector</span><span class="special">&lt;</span> <span class="keyword">double</span> <span class="special">&gt;</span></code> or <code class="computeroutput"><span class="identifier">array</span><span class="special">&lt;</span> <span class="keyword">double</span> <span class="special">,</span> <span class="identifier">N</span> <span class="special">&gt;</span></code>,
        however, the genericity of odeint enables you to basically use anything as
        a state type. The algorithmic counterpart of such mathematical expressions
        is divided into two parts. First, the <code class="computeroutput"><span class="identifier">Algebra</span></code>
        is used to account for the vector character of the equation. In the case
        of a <code class="computeroutput"><span class="identifier">vector</span></code> as state type
        this means the <code class="computeroutput"><span class="identifier">Algebra</span></code> is
        responsible for iteration over all vector elements. Second, the <code class="computeroutput"><span class="identifier">Operations</span></code> are used to represent the actual
        operation applied to each of the vector elements. So the <code class="computeroutput"><span class="identifier">Algebra</span></code>
        iterates over all elements of the <code class="computeroutput"><span class="identifier">State</span></code>s
        and calls an operation taken from the <code class="computeroutput"><span class="identifier">Operations</span></code>
        for each element. This is where <code class="computeroutput"><span class="identifier">State</span></code>,
        <code class="computeroutput"><span class="identifier">Algebra</span></code> and <code class="computeroutput"><span class="identifier">Operations</span></code> have to work together to make
        odeint running. Please have a look at the <code class="computeroutput"><span class="identifier">range_algebra</span></code>
        and <code class="computeroutput"><span class="identifier">default_operations</span></code> to
        see an example how this is implemented.
      </p>
<p>
        In the following we describe how <code class="computeroutput"><span class="identifier">State</span></code>,
        <code class="computeroutput"><span class="identifier">Algebra</span></code> and <code class="computeroutput"><span class="identifier">Operations</span></code> are used together within the
        stepper implementations.
      </p>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="boost_numeric_odeint.concepts.state_algebra_operations.operations"></a><a class="link" href="state_algebra_operations.html#boost_numeric_odeint.concepts.state_algebra_operations.operations" title="Operations">Operations</a>
</h4></div></div></div>
<h6>
<a name="boost_numeric_odeint.concepts.state_algebra_operations.operations.h0"></a>
          <span class="phrase"><a name="boost_numeric_odeint.concepts.state_algebra_operations.operations.notation"></a></span><a class="link" href="state_algebra_operations.html#boost_numeric_odeint.concepts.state_algebra_operations.operations.notation">Notation</a>
        </h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl class="variablelist">
<dt><span class="term"><code class="computeroutput"><span class="identifier">Operations</span></code></span></dt>
<dd><p>
                The operations type
              </p></dd>
<dt><span class="term"><code class="computeroutput"><span class="identifier">Value1</span></code>, ... ,
            <code class="computeroutput"><span class="identifier">ValueN</span></code></span></dt>
<dd><p>
                Types representing the value or time type of stepper
              </p></dd>
<dt><span class="term"><code class="computeroutput"><span class="identifier">Scale</span></code></span></dt>
<dd><p>
                Type of the scale operation
              </p></dd>
<dt><span class="term"><code class="computeroutput"><span class="identifier">scale</span></code></span></dt>
<dd><p>
                Object of type <code class="computeroutput"><span class="identifier">Scale</span></code>
              </p></dd>
<dt><span class="term"><code class="literal">ScaleSum<span class="emphasis"><em>N</em></span></code></span></dt>
<dd><p>
                Type that represents a general scale_sum operation, <code class="literal"><span class="emphasis"><em>N</em></span></code>
                should be replaced by a number from 1 to 14.
              </p></dd>
<dt><span class="term"><code class="literal">scale_sum<span class="emphasis"><em>N</em></span></code></span></dt>
<dd><p>
                Object of type <code class="literal">ScaleSum<span class="emphasis"><em>N</em></span></code>,
                <code class="literal"><span class="emphasis"><em>N</em></span></code> should be replaced by a
                number from 1 to 14.
              </p></dd>
<dt><span class="term"><code class="computeroutput"><span class="identifier">ScaleSumSwap2</span></code></span></dt>
<dd><p>
                Type of the scale sum swap operation
              </p></dd>
<dt><span class="term"><code class="computeroutput"><span class="identifier">scale_sum_swap2</span></code></span></dt>
<dd><p>
                Object of type <code class="computeroutput"><span class="identifier">ScaleSumSwap2</span></code>
              </p></dd>
<dt><span class="term"><code class="computeroutput"><span class="identifier">a1</span><span class="special">,</span>
            <span class="identifier">a2</span><span class="special">,</span>
            <span class="special">...</span></code></span></dt>
<dd><p>
                Objects of type <code class="computeroutput"><span class="identifier">Value1</span></code>,
                <code class="computeroutput"><span class="identifier">Value2</span></code>, ...
              </p></dd>
<dt><span class="term"><code class="computeroutput"><span class="identifier">y</span><span class="special">,</span>
            <span class="identifier">x1</span><span class="special">,</span>
            <span class="identifier">x2</span><span class="special">,</span>
            <span class="special">...</span></code></span></dt>
<dd><p>
                Objects of <code class="computeroutput"><span class="identifier">State</span></code>'s
                value type
              </p></dd>
</dl>
</div>
<h6>
<a name="boost_numeric_odeint.concepts.state_algebra_operations.operations.h1"></a>
          <span class="phrase"><a name="boost_numeric_odeint.concepts.state_algebra_operations.operations.valid_expressions"></a></span><a class="link" href="state_algebra_operations.html#boost_numeric_odeint.concepts.state_algebra_operations.operations.valid_expressions">Valid
          Expressions</a>
        </h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                  <p>
                    Name
                  </p>
                </th>
<th>
                  <p>
                    Expression
                  </p>
                </th>
<th>
                  <p>
                    Type
                  </p>
                </th>
<th>
                  <p>
                    Semantics
                  </p>
                </th>
</tr></thead>
<tbody>
<tr>
<td>
                  <p>
                    Get scale operation
                  </p>
                </td>
<td>
                  <p>
                    <code class="computeroutput"><span class="identifier">Operations</span><span class="special">::</span><span class="identifier">scale</span><span class="special">&lt;</span>
                    <span class="identifier">Value</span> <span class="special">&gt;</span></code>
                  </p>
                </td>
<td>
                  <p>
                    <code class="computeroutput"><span class="identifier">Scale</span></code>
                  </p>
                </td>
<td>
                  <p>
                    Get <code class="computeroutput"><span class="identifier">Scale</span></code> from
                    <code class="computeroutput"><span class="identifier">Operations</span></code>
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <code class="computeroutput"><span class="identifier">Scale</span></code> constructor
                  </p>
                </td>
<td>
                  <p>
                    <code class="computeroutput"><span class="identifier">Scale</span><span class="special">&lt;</span>
                    <span class="identifier">Value</span> <span class="special">&gt;(</span>
                    <span class="identifier">a</span> <span class="special">)</span></code>
                  </p>
                </td>
<td>
                  <p>
                    <code class="computeroutput"><span class="identifier">Scale</span></code>
                  </p>
                </td>
<td>
                  <p>
                    Constructs a <code class="computeroutput"><span class="identifier">Scale</span></code>
                    object
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <code class="computeroutput"><span class="identifier">Scale</span></code> operation
                  </p>
                </td>
<td>
                  <p>
                    <code class="computeroutput"><span class="identifier">scale</span><span class="special">(</span>
                    <span class="identifier">x</span> <span class="special">)</span></code>
                  </p>
                </td>
<td>
                  <p>
                    <code class="computeroutput"><span class="keyword">void</span></code>
                  </p>
                </td>
<td>
                  <p>
                    Calculates <code class="computeroutput"><span class="identifier">x</span> <span class="special">*=</span> <span class="identifier">a</span></code>
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    Get general <code class="computeroutput"><span class="identifier">scale_sum</span></code>
                    operation
                  </p>
                </td>
<td>
                  <p>
                    <code class="literal">Operations::scale_sum<span class="emphasis"><em>N</em></span>&lt; Value1
                    , ... , ValueN &gt;</code>
                  </p>
                </td>
<td>
                  <p>
                    <code class="literal">ScaleSum<span class="emphasis"><em>N</em></span></code>
                  </p>
                </td>
<td>
                  <p>
                    Get the <code class="literal">ScaleSum<span class="emphasis"><em>N</em></span></code> type
                    from <code class="computeroutput"><span class="identifier">Operations</span></code>,
                    <code class="literal"><span class="emphasis"><em>N</em></span></code> should be replaced
                    by a number from 1 to 14.
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <code class="computeroutput"><span class="identifier">scale_sum</span></code> constructor
                  </p>
                </td>
<td>
                  <p>
                    <code class="literal">ScaleSum<span class="emphasis"><em>N</em></span>&lt; Value1 , ... , ValueN
                    &gt;( a1 , ... , aN )</code>
                  </p>
                </td>
<td>
                  <p>
                    <code class="literal">ScaleSum<span class="emphasis"><em>N</em></span></code>
                  </p>
                </td>
<td>
                  <p>
                    Constructs a <code class="computeroutput"><span class="identifier">scale_sum</span></code>
                    object given <code class="literal"><span class="emphasis"><em>N</em></span></code> parameter
                    values with <code class="literal"><span class="emphasis"><em>N</em></span></code> between
                    1 and 14.
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <code class="computeroutput"><span class="identifier">scale_sum</span></code> operation
                  </p>
                </td>
<td>
                  <p>
                    <code class="literal">scale_sum<span class="emphasis"><em>N</em></span>( y , x1 , ... , xN )</code>
                  </p>
                </td>
<td>
                  <p>
                    <code class="computeroutput"><span class="keyword">void</span></code>
                  </p>
                </td>
<td>
                  <p>
                    Calculates <code class="computeroutput"><span class="identifier">y</span> <span class="special">=</span> <span class="identifier">a1</span><span class="special">*</span><span class="identifier">x1</span>
                    <span class="special">+</span> <span class="identifier">a2</span><span class="special">*</span><span class="identifier">x2</span>
                    <span class="special">+</span> <span class="special">...</span>
                    <span class="special">+</span> <span class="identifier">aN</span><span class="special">*</span><span class="identifier">xN</span></code>.
                    Note that this is an <code class="literal"><span class="emphasis"><em>N</em></span>+1</code>-ary
                    function call.
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    Get scale sum swap operation
                  </p>
                </td>
<td>
                  <p>
                    <code class="computeroutput"><span class="identifier">Operations</span><span class="special">::</span><span class="identifier">scale_sum_swap2</span><span class="special">&lt;</span>
                    <span class="identifier">Value1</span> <span class="special">,</span>
                    <span class="identifier">Value2</span> <span class="special">&gt;</span></code>
                  </p>
                </td>
<td>
                  <p>
                    <code class="computeroutput"><span class="identifier">ScaleSumSwap2</span></code>
                  </p>
                </td>
<td>
                  <p>
                    Get scale sum swap from operations
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <code class="computeroutput"><span class="identifier">ScaleSumSwap2</span></code>
                    constructor
                  </p>
                </td>
<td>
                  <p>
                    <code class="computeroutput"><span class="identifier">ScaleSumSwap2</span><span class="special">&lt;</span> <span class="identifier">Value1</span>
                    <span class="special">,</span> <span class="identifier">Value2</span>
                    <span class="special">&gt;(</span> <span class="identifier">a1</span>
                    <span class="special">,</span> <span class="identifier">a2</span>
                    <span class="special">)</span></code>
                  </p>
                </td>
<td>
                  <p>
                    <code class="computeroutput"><span class="identifier">ScaleSumSwap2</span></code>
                  </p>
                </td>
<td>
                  <p>
                    Constructor
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <code class="computeroutput"><span class="identifier">ScaleSumSwap2</span></code>
                    operation
                  </p>
                </td>
<td>
                  <p>
                    <code class="computeroutput"><span class="identifier">scale_sum_swap2</span><span class="special">(</span> <span class="identifier">x1</span>
                    <span class="special">,</span> <span class="identifier">x2</span>
                    <span class="special">,</span> <span class="identifier">x3</span>
                    <span class="special">)</span></code>
                  </p>
                </td>
<td>
                  <p>
                    <code class="computeroutput"><span class="keyword">void</span></code>
                  </p>
                </td>
<td>
                  <p>
                    Calculates <code class="computeroutput"><span class="identifier">tmp</span> <span class="special">=</span> <span class="identifier">x1</span></code>,
                    <code class="computeroutput"><span class="identifier">x1</span> <span class="special">=</span>
                    <span class="identifier">a1</span><span class="special">*</span><span class="identifier">x2</span> <span class="special">+</span>
                    <span class="identifier">a2</span><span class="special">*</span><span class="identifier">x3</span></code> and <code class="computeroutput"><span class="identifier">x2</span>
                    <span class="special">=</span> <span class="identifier">tmp</span></code>.
                  </p>
                </td>
</tr>
</tbody>
</table></div>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="boost_numeric_odeint.concepts.state_algebra_operations.algebra"></a><a class="link" href="state_algebra_operations.html#boost_numeric_odeint.concepts.state_algebra_operations.algebra" title="Algebra">Algebra</a>
</h4></div></div></div>
<h6>
<a name="boost_numeric_odeint.concepts.state_algebra_operations.algebra.h0"></a>
          <span class="phrase"><a name="boost_numeric_odeint.concepts.state_algebra_operations.algebra.notation"></a></span><a class="link" href="state_algebra_operations.html#boost_numeric_odeint.concepts.state_algebra_operations.algebra.notation">Notation</a>
        </h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl class="variablelist">
<dt><span class="term"><code class="computeroutput"><span class="identifier">State</span></code></span></dt>
<dd><p>
                The state type
              </p></dd>
<dt><span class="term"><code class="computeroutput"><span class="identifier">Algebra</span></code></span></dt>
<dd><p>
                The algebra type
              </p></dd>
<dt><span class="term"><code class="literal">Operation<span class="emphasis"><em>N</em></span></code></span></dt>
<dd><p>
                An <code class="literal"><span class="emphasis"><em>N</em></span></code>-ary operation type,
                <code class="literal"><span class="emphasis"><em>N</em></span></code> should be a number from
                1 to 14.
              </p></dd>
<dt><span class="term"><code class="computeroutput"><span class="identifier">algebra</span></code></span></dt>
<dd><p>
                Object of type <code class="computeroutput"><span class="identifier">Algebra</span></code>
              </p></dd>
<dt><span class="term"><code class="literal">operation<span class="emphasis"><em>N</em></span></code></span></dt>
<dd><p>
                Object of type <code class="literal">Operation<span class="emphasis"><em>N</em></span></code>
              </p></dd>
<dt><span class="term"><code class="computeroutput"><span class="identifier">y</span><span class="special">,</span>
            <span class="identifier">x1</span><span class="special">,</span>
            <span class="identifier">x2</span><span class="special">,</span>
            <span class="special">...</span></code></span></dt>
<dd><p>
                Objects of type <code class="computeroutput"><span class="identifier">State</span></code>
              </p></dd>
</dl>
</div>
<h6>
<a name="boost_numeric_odeint.concepts.state_algebra_operations.algebra.h1"></a>
          <span class="phrase"><a name="boost_numeric_odeint.concepts.state_algebra_operations.algebra.valid_expressions"></a></span><a class="link" href="state_algebra_operations.html#boost_numeric_odeint.concepts.state_algebra_operations.algebra.valid_expressions">Valid
          Expressions</a>
        </h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                  <p>
                    Name
                  </p>
                </th>
<th>
                  <p>
                    Expression
                  </p>
                </th>
<th>
                  <p>
                    Type
                  </p>
                </th>
<th>
                  <p>
                    Semantics
                  </p>
                </th>
</tr></thead>
<tbody>
<tr>
<td>
                  <p>
                    Vector Operation with arity 2
                  </p>
                </td>
<td>
                  <p>
                    <code class="computeroutput"><span class="identifier">algebra</span><span class="special">.</span><span class="identifier">for_each2</span><span class="special">(</span>
                    <span class="identifier">y</span> <span class="special">,</span>
                    <span class="identifier">x</span> <span class="special">,</span>
                    <span class="identifier">operation2</span> <span class="special">)</span></code>
                  </p>
                </td>
<td>
                  <p>
                    void
                  </p>
                </td>
<td>
                  <p>
                    Calls <code class="computeroutput"><span class="identifier">operation2</span><span class="special">(</span> <span class="identifier">y_i</span>
                    <span class="special">,</span> <span class="identifier">x_i</span>
                    <span class="special">)</span></code> for each element <code class="computeroutput"><span class="identifier">y_i</span></code> of <code class="computeroutput"><span class="identifier">y</span></code>
                    and <code class="computeroutput"><span class="identifier">x_i</span></code> of <code class="computeroutput"><span class="identifier">x</span></code>.
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    Vector Operation with arity 3
                  </p>
                </td>
<td>
                  <p>
                    <code class="computeroutput"><span class="identifier">algebra</span><span class="special">.</span><span class="identifier">for_each3</span><span class="special">(</span>
                    <span class="identifier">y</span> <span class="special">,</span>
                    <span class="identifier">x1</span> <span class="special">,</span>
                    <span class="identifier">x2</span> <span class="special">,</span>
                    <span class="identifier">operation3</span> <span class="special">)</span></code>
                  </p>
                </td>
<td>
                  <p>
                    void
                  </p>
                </td>
<td>
                  <p>
                    Calls <code class="computeroutput"><span class="identifier">operation3</span><span class="special">(</span> <span class="identifier">y_i</span>
                    <span class="special">,</span> <span class="identifier">x1_i</span>
                    <span class="special">,</span> <span class="identifier">x2_i</span>
                    <span class="special">)</span></code> for each element <code class="computeroutput"><span class="identifier">y_i</span></code> of <code class="computeroutput"><span class="identifier">y</span></code>
                    and <code class="computeroutput"><span class="identifier">x1_i</span></code> of
                    <code class="computeroutput"><span class="identifier">x1</span></code> and <code class="computeroutput"><span class="identifier">x2_i</span></code> of <code class="computeroutput"><span class="identifier">x2</span></code>.
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    Vector Operation with arity <code class="literal"><span class="emphasis"><em>N</em></span></code>
                  </p>
                </td>
<td>
                  <p>
                    <code class="literal">algebra.for_each<span class="emphasis"><em>N</em></span>( y , x1 , ...
                    , xN , operation<span class="emphasis"><em>N</em></span> )</code>
                  </p>
                </td>
<td>
                  <p>
                    void
                  </p>
                </td>
<td>
                  <p>
                    Calls <code class="literal">operation<span class="emphasis"><em>N</em></span>( y_i , x1_i ,
                    ... , xN_i )</code> for each element <code class="computeroutput"><span class="identifier">y_i</span></code>
                    of <code class="computeroutput"><span class="identifier">y</span></code> and <code class="computeroutput"><span class="identifier">x1_i</span></code> of <code class="computeroutput"><span class="identifier">x1</span></code>
                    and so on. <code class="literal"><span class="emphasis"><em>N</em></span></code> should be
                    replaced by a number between 1 and 14.
                  </p>
                </td>
</tr>
</tbody>
</table></div>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="boost_numeric_odeint.concepts.state_algebra_operations.pre_defined_implementations"></a><a class="link" href="state_algebra_operations.html#boost_numeric_odeint.concepts.state_algebra_operations.pre_defined_implementations" title="Pre-Defined implementations">Pre-Defined
        implementations</a>
</h4></div></div></div>
<p>
          As standard configuration odeint uses the <code class="computeroutput"><span class="identifier">range_algebra</span></code>
          and <code class="computeroutput"><span class="identifier">default_operations</span></code>
          which suffices most situations. However, a few more possibilities exist
          either to gain better performance or to ensure interoperability with other
          libraries. In the following we list the existing <code class="computeroutput"><span class="identifier">Algebra</span></code>/<code class="computeroutput"><span class="identifier">Operations</span></code> configurations that can be
          used in the steppers.
        </p>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                  <p>
                    <code class="computeroutput"><span class="identifier">State</span></code>
                  </p>
                </th>
<th>
                  <p>
                    <code class="computeroutput"><span class="identifier">Algebra</span></code>
                  </p>
                </th>
<th>
                  <p>
                    <code class="computeroutput"><span class="identifier">Operations</span></code>
                  </p>
                </th>
<th>
                  <p>
                    Remarks
                  </p>
                </th>
</tr></thead>
<tbody>
<tr>
<td>
                  <p>
                    Anything supporting <a href="http://www.boost.org/doc/libs/release/libs/range/" target="_top">Boost.Range</a>,
                    like <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span></code>, <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">list</span></code>,
                    <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">array</span></code>,... based on a <code class="computeroutput"><span class="identifier">value_type</span></code> that supports operators
                    +,* (typically <code class="computeroutput"><span class="keyword">double</span></code>)
                  </p>
                </td>
<td>
                  <p>
                    <code class="computeroutput"><span class="identifier">range_algebra</span></code>
                  </p>
                </td>
<td>
                  <p>
                    <code class="computeroutput"><span class="identifier">default_operations</span></code>
                  </p>
                </td>
<td>
                  <p>
                    Standard implementation, applicable for most typical situations.
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">array</span></code> based on a <code class="computeroutput"><span class="identifier">value_type</span></code> that supports operators
                    +,*
                  </p>
                </td>
<td>
                  <p>
                    <code class="computeroutput"><span class="identifier">array_algebra</span></code>
                  </p>
                </td>
<td>
                  <p>
                    <code class="computeroutput"><span class="identifier">default_operations</span></code>
                  </p>
                </td>
<td>
                  <p>
                    Special implementation for boost::array with better performance
                    than <code class="computeroutput"><span class="identifier">range_algebra</span></code>
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    Anything that defines operators + within itself and * with scalar
                    (Mathematically spoken, anything that is a vector space).
                  </p>
                </td>
<td>
                  <p>
                    <code class="computeroutput"><span class="identifier">vector_space_algebra</span></code>
                  </p>
                </td>
<td>
                  <p>
                    <code class="computeroutput"><span class="identifier">default_operations</span></code>
                  </p>
                </td>
<td>
                  <p>
                    For the use of <a class="link" href="controlled_stepper.html" title="Controlled Stepper">Controlled
                    Stepper</a>, the template <code class="computeroutput"><span class="identifier">vector_space_reduce</span></code>
                    has to be instantiated.
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <code class="computeroutput"><span class="identifier">thrust</span><span class="special">::</span><span class="identifier">device_vector</span></code>, <code class="computeroutput"><span class="identifier">thrust</span><span class="special">::</span><span class="identifier">host_vector</span></code>
                  </p>
                </td>
<td>
                  <p>
                    <code class="computeroutput"><span class="identifier">thrust_algebra</span></code>
                  </p>
                </td>
<td>
                  <p>
                    <code class="computeroutput"><span class="identifier">thrust_operations</span></code>
                  </p>
                </td>
<td>
                  <p>
                    For running odeint on CUDA devices by using <a href="http://code.google.com/p/thrust/" target="_top">Thrust</a>
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    Any RandomAccessRange
                  </p>
                </td>
<td>
                  <p>
                    <code class="computeroutput"><span class="identifier">openmp_range_algebra</span></code>
                  </p>
                </td>
<td>
                  <p>
                    <code class="computeroutput"><span class="identifier">default_operations</span></code>
                  </p>
                </td>
<td>
                  <p>
                    OpenMP-parallelised range algebra
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <code class="computeroutput"><span class="identifier">openmp_state</span></code>
                  </p>
                </td>
<td>
                  <p>
                    <code class="computeroutput"><span class="identifier">openmp_algebra</span></code>
                  </p>
                </td>
<td>
                  <p>
                    <code class="computeroutput"><span class="identifier">default_operations</span></code>
                  </p>
                </td>
<td>
                  <p>
                    OpenMP-parallelised algebra for split data
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">array</span></code> or anything which allocates
                    the elements in a C-like manner
                  </p>
                </td>
<td>
                  <p>
                    <code class="computeroutput"><span class="identifier">vector_space_algebra</span></code>
                  </p>
                </td>
<td>
                  <p>
                    <code class="computeroutput"><span class="identifier">mkl_operations</span></code>
                  </p>
                </td>
<td>
                  <p>
                    Using the <a href="http://software.intel.com/en-us/articles/intel-mkl/" target="_top">Intel
                    Math Kernel Library</a> in odeint for maximum performance.
                    Currently, only the RK4 stepper is supported.
                  </p>
                </td>
</tr>
</tbody>
</table></div>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="boost_numeric_odeint.concepts.state_algebra_operations.example_expressions"></a><a class="link" href="state_algebra_operations.html#boost_numeric_odeint.concepts.state_algebra_operations.example_expressions" title="Example expressions">Example
        expressions</a>
</h4></div></div></div>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                  <p>
                    Name
                  </p>
                </th>
<th>
                  <p>
                    Expression
                  </p>
                </th>
<th>
                  <p>
                    Type
                  </p>
                </th>
<th>
                  <p>
                    Semantics
                  </p>
                </th>
</tr></thead>
<tbody><tr>
<td>
                  <p>
                    Vector operation
                  </p>
                </td>
<td>
                  <p>
                    <code class="computeroutput"><span class="identifier">algebra</span><span class="special">.</span><span class="identifier">for_each3</span><span class="special">(</span>
                    <span class="identifier">y</span> <span class="special">,</span>
                    <span class="identifier">x1</span> <span class="special">,</span>
                    <span class="identifier">x2</span> <span class="special">,</span>
                    <span class="identifier">Operations</span><span class="special">::</span><span class="identifier">scale_sum2</span><span class="special">&lt;</span>
                    <span class="identifier">Value1</span> <span class="special">,</span>
                    <span class="identifier">Value2</span> <span class="special">&gt;(</span>
                    <span class="identifier">a1</span> <span class="special">,</span>
                    <span class="identifier">a2</span> <span class="special">)</span>
                    <span class="special">)</span></code>
                  </p>
                </td>
<td>
                  <p>
                    void
                  </p>
                </td>
<td>
                  <p>
                    Calculates <span class="emphasis"><em><span class="bold"><strong>y</strong></span> = a1
                    <span class="bold"><strong>x1</strong></span> + a2 <span class="bold"><strong>x2</strong></span></em></span>
                  </p>
                </td>
</tr></tbody>
</table></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 &#169; 2009-2015 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 <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="dense_output_stepper.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../concepts.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="state_wrapper.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>