Boost  v1.57.0
doxygen for www.boost.org
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Types | Public Member Functions | Protected Attributes | List of all members
boost::numeric::odeint::algebra_stepper_base< Algebra, Operations > Class Template Reference

Base class for all steppers with algebra and operations. More...

#include <algebra_stepper_base.hpp>

Inheritance diagram for boost::numeric::odeint::algebra_stepper_base< Algebra, Operations >:
Inheritance graph
[legend]
Collaboration diagram for boost::numeric::odeint::algebra_stepper_base< Algebra, Operations >:
Collaboration graph
[legend]

Public Types

typedef Algebra algebra_type
 
typedef Operations operations_type
 

Public Member Functions

 algebra_stepper_base (const algebra_type &algebra=algebra_type())
 Constructs a algebra_stepper_base and creates the algebra. More...
 
algebra_type & algebra ()
 
const algebra_type & algebra () const
 

Protected Attributes

algebra_type m_algebra
 

Detailed Description

template<class Algebra, class Operations>
class boost::numeric::odeint::algebra_stepper_base< Algebra, Operations >

Base class for all steppers with algebra and operations.

This class serves a base class for all steppers with algebra and operations. It holds the algebra and provides access to the algebra. The operations are not instantiated, since they are static classes inside the operations class.

Template Parameters
AlgebraThe type of the algebra. Must fulfill the Algebra Concept, at least partially to work with the stepper.
OperationsThe type of the operations. Must fulfill the Operations Concept, at least partially to work with the stepper.

Member Typedef Documentation

template<class Algebra, class Operations>
typedef Algebra boost::numeric::odeint::algebra_stepper_base< Algebra, Operations >::algebra_type
template<class Algebra, class Operations>
typedef Operations boost::numeric::odeint::algebra_stepper_base< Algebra, Operations >::operations_type

Constructor & Destructor Documentation

template<class Algebra, class Operations>
boost::numeric::odeint::algebra_stepper_base< Algebra, Operations >::algebra_stepper_base ( const algebra_type &  algebra = algebra_type())
inline

Constructs a algebra_stepper_base and creates the algebra.

This constructor can be used as a default constructor if the algebra has a default constructor.

Parameters
algebraThe algebra_stepper_base stores and uses a copy of algebra.

Member Function Documentation

template<class Algebra, class Operations>
algebra_type & boost::numeric::odeint::algebra_stepper_base< Algebra, Operations >::algebra ( )
inline
Returns
A reference to the algebra which is held by this class.
template<class Algebra, class Operations>
const algebra_type & boost::numeric::odeint::algebra_stepper_base< Algebra, Operations >::algebra ( ) const
inline
Returns
A const reference to the algebra which is held by this class.

Member Data Documentation

template<class Algebra, class Operations>
algebra_type boost::numeric::odeint::algebra_stepper_base< Algebra, Operations >::m_algebra
protected

Referenced by boost::numeric::odeint::algebra_stepper_base< algebra_type, operations_type >::algebra(), boost::numeric::odeint::euler< State, Value, Deriv, Time, Algebra, Operations, Resizer >::calc_state(), boost::numeric::odeint::runge_kutta_dopri5< State, Value, Deriv, Time, Algebra, Operations, Resizer >::calc_state(), boost::numeric::odeint::velocity_verlet< Coor, Velocity, Value, Acceleration, Time, TimeSq, Algebra, Operations, Resizer >::do_step(), boost::numeric::odeint::euler< State, Value, Deriv, Time, Algebra, Operations, Resizer >::do_step_impl(), boost::numeric::odeint::modified_midpoint< state_type, value_type, deriv_type, time_type, algebra_type, operations_type, resizer_type >::do_step_impl(), boost::numeric::odeint::runge_kutta4_classic< State, Value, Deriv, Time, Algebra, Operations, Resizer >::do_step_impl(), boost::numeric::odeint::runge_kutta_dopri5< State, Value, Deriv, Time, Algebra, Operations, Resizer >::do_step_impl(), boost::numeric::odeint::runge_kutta_cash_karp54_classic< State, Value, Deriv, Time, Algebra, Operations, Resizer >::do_step_impl(), boost::numeric::odeint::explicit_error_generic_rk< 6, 5, 5, 4, State, Value, Deriv, Time, Algebra, Operations, Resizer >::do_step_impl(), and boost::numeric::odeint::explicit_generic_rk< 4, 4, State, Value, Deriv, Time, Algebra, Operations, Resizer >::do_step_impl().

The documentation for this class was generated from the following file: