1[/============================================================================ 2 Boost.odeint 3 4 Copyright 2011 Mario Mulansky 5 Copyright 2012 Karsten Ahnert 6 7 Use, modification and distribution is subject to the Boost Software License, 8 Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at 9 http://www.boost.org/LICENSE_1_0.txt) 10=============================================================================/] 11 12 13[section State Wrapper] 14 15[heading Description] 16 17The `State Wrapper` concept describes the way odeint creates temporary state objects to store intermediate results within the stepper's `do_step` methods. 18 19[heading Notation] 20 21[variablelist 22 [[`State`] [A type that is the `state_type` of the ODE]] 23 [[`WrappedState`] [A type that is a model of State Wrapper for the state type `State`.]] 24 [[`x`] [Object of type `State`]] 25 [[`w`] [Object of type `WrappedState`]] 26] 27 28[heading Valid Expressions] 29 30[table 31 [[Name] [Expression] [Type] [Semantics]] 32 [[Get resizeability] [`is_resizeable< State >`] [`boost::false_type` or `boost::true_type`] [Returns `boost::true_type` if the `State` is resizeable, `boost::false_type` otherwise.]] 33 [[Create `WrappedState` type] [`state_wrapper< State >`] [`WrappedState`] [Creates the type for a `WrappedState` for the state type `State`]] 34 [[Constructor] [`WrappedState()`] [`WrappedState`] [Constructs a state wrapper with an empty state]] 35 [[Copy Constructor] [`WrappedState( w )`] [`WrappedState`] [Constructs a state wrapper with a state of the same size as the state in `w`]] 36 [[Get state] [`w.m_v`] [`State`] [Returns the `State` object of this state wrapper.]] 37] 38 39[endsect]