1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>State Wrapper</title> 5<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css"> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="../../index.html" title="Chapter 1. Boost.Numeric.Odeint"> 8<link rel="up" href="../concepts.html" title="Concepts"> 9<link rel="prev" href="state_algebra_operations.html" title="State Algebra Operations"> 10<link rel="next" href="../literature.html" title="Literature"> 11</head> 12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 13<table cellpadding="2" width="100%"><tr> 14<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../logo.jpg"></td> 15<td align="center"><a href="../../../../../../../index.html">Home</a></td> 16<td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td> 17<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 18<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 19<td align="center"><a href="../../../../../../../more/index.htm">More</a></td> 20</tr></table> 21<hr> 22<div class="spirit-nav"> 23<a accesskey="p" href="state_algebra_operations.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="../literature.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h3 class="title"> 27<a name="boost_numeric_odeint.concepts.state_wrapper"></a><a class="link" href="state_wrapper.html" title="State Wrapper">State Wrapper</a> 28</h3></div></div></div> 29<h5> 30<a name="boost_numeric_odeint.concepts.state_wrapper.h0"></a> 31 <span class="phrase"><a name="boost_numeric_odeint.concepts.state_wrapper.description"></a></span><a class="link" href="state_wrapper.html#boost_numeric_odeint.concepts.state_wrapper.description">Description</a> 32 </h5> 33<p> 34 The <code class="computeroutput"><span class="identifier">State</span> <span class="identifier">Wrapper</span></code> 35 concept describes the way odeint creates temporary state objects to store 36 intermediate results within the stepper's <code class="computeroutput"><span class="identifier">do_step</span></code> 37 methods. 38 </p> 39<h5> 40<a name="boost_numeric_odeint.concepts.state_wrapper.h1"></a> 41 <span class="phrase"><a name="boost_numeric_odeint.concepts.state_wrapper.notation"></a></span><a class="link" href="state_wrapper.html#boost_numeric_odeint.concepts.state_wrapper.notation">Notation</a> 42 </h5> 43<div class="variablelist"> 44<p class="title"><b></b></p> 45<dl class="variablelist"> 46<dt><span class="term"><code class="computeroutput"><span class="identifier">State</span></code></span></dt> 47<dd><p> 48 A type that is the <code class="computeroutput"><span class="identifier">state_type</span></code> 49 of the ODE 50 </p></dd> 51<dt><span class="term"><code class="computeroutput"><span class="identifier">WrappedState</span></code></span></dt> 52<dd><p> 53 A type that is a model of State Wrapper for the state type <code class="computeroutput"><span class="identifier">State</span></code>. 54 </p></dd> 55<dt><span class="term"><code class="computeroutput"><span class="identifier">x</span></code></span></dt> 56<dd><p> 57 Object of type <code class="computeroutput"><span class="identifier">State</span></code> 58 </p></dd> 59<dt><span class="term"><code class="computeroutput"><span class="identifier">w</span></code></span></dt> 60<dd><p> 61 Object of type <code class="computeroutput"><span class="identifier">WrappedState</span></code> 62 </p></dd> 63</dl> 64</div> 65<h5> 66<a name="boost_numeric_odeint.concepts.state_wrapper.h2"></a> 67 <span class="phrase"><a name="boost_numeric_odeint.concepts.state_wrapper.valid_expressions"></a></span><a class="link" href="state_wrapper.html#boost_numeric_odeint.concepts.state_wrapper.valid_expressions">Valid 68 Expressions</a> 69 </h5> 70<div class="informaltable"><table class="table"> 71<colgroup> 72<col> 73<col> 74<col> 75<col> 76</colgroup> 77<thead><tr> 78<th> 79 <p> 80 Name 81 </p> 82 </th> 83<th> 84 <p> 85 Expression 86 </p> 87 </th> 88<th> 89 <p> 90 Type 91 </p> 92 </th> 93<th> 94 <p> 95 Semantics 96 </p> 97 </th> 98</tr></thead> 99<tbody> 100<tr> 101<td> 102 <p> 103 Get resizeability 104 </p> 105 </td> 106<td> 107 <p> 108 <code class="computeroutput"><span class="identifier">is_resizeable</span><span class="special"><</span> 109 <span class="identifier">State</span> <span class="special">></span></code> 110 </p> 111 </td> 112<td> 113 <p> 114 <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">false_type</span></code> or <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">true_type</span></code> 115 </p> 116 </td> 117<td> 118 <p> 119 Returns <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">true_type</span></code> if the <code class="computeroutput"><span class="identifier">State</span></code> is resizeable, <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">false_type</span></code> otherwise. 120 </p> 121 </td> 122</tr> 123<tr> 124<td> 125 <p> 126 Create <code class="computeroutput"><span class="identifier">WrappedState</span></code> 127 type 128 </p> 129 </td> 130<td> 131 <p> 132 <code class="computeroutput"><span class="identifier">state_wrapper</span><span class="special"><</span> 133 <span class="identifier">State</span> <span class="special">></span></code> 134 </p> 135 </td> 136<td> 137 <p> 138 <code class="computeroutput"><span class="identifier">WrappedState</span></code> 139 </p> 140 </td> 141<td> 142 <p> 143 Creates the type for a <code class="computeroutput"><span class="identifier">WrappedState</span></code> 144 for the state type <code class="computeroutput"><span class="identifier">State</span></code> 145 </p> 146 </td> 147</tr> 148<tr> 149<td> 150 <p> 151 Constructor 152 </p> 153 </td> 154<td> 155 <p> 156 <code class="computeroutput"><span class="identifier">WrappedState</span><span class="special">()</span></code> 157 </p> 158 </td> 159<td> 160 <p> 161 <code class="computeroutput"><span class="identifier">WrappedState</span></code> 162 </p> 163 </td> 164<td> 165 <p> 166 Constructs a state wrapper with an empty state 167 </p> 168 </td> 169</tr> 170<tr> 171<td> 172 <p> 173 Copy Constructor 174 </p> 175 </td> 176<td> 177 <p> 178 <code class="computeroutput"><span class="identifier">WrappedState</span><span class="special">(</span> 179 <span class="identifier">w</span> <span class="special">)</span></code> 180 </p> 181 </td> 182<td> 183 <p> 184 <code class="computeroutput"><span class="identifier">WrappedState</span></code> 185 </p> 186 </td> 187<td> 188 <p> 189 Constructs a state wrapper with a state of the same size as the 190 state in <code class="computeroutput"><span class="identifier">w</span></code> 191 </p> 192 </td> 193</tr> 194<tr> 195<td> 196 <p> 197 Get state 198 </p> 199 </td> 200<td> 201 <p> 202 <code class="computeroutput"><span class="identifier">w</span><span class="special">.</span><span class="identifier">m_v</span></code> 203 </p> 204 </td> 205<td> 206 <p> 207 <code class="computeroutput"><span class="identifier">State</span></code> 208 </p> 209 </td> 210<td> 211 <p> 212 Returns the <code class="computeroutput"><span class="identifier">State</span></code> 213 object of this state wrapper. 214 </p> 215 </td> 216</tr> 217</tbody> 218</table></div> 219</div> 220<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 221<td align="left"></td> 222<td align="right"><div class="copyright-footer">Copyright © 2009-2015 Karsten Ahnert and Mario Mulansky<p> 223 Distributed under the Boost Software License, Version 1.0. (See accompanying 224 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>) 225 </p> 226</div></td> 227</tr></table> 228<hr> 229<div class="spirit-nav"> 230<a accesskey="p" href="state_algebra_operations.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="../literature.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> 231</div> 232</body> 233</html> 234
