3 boost/numeric/odeint/stepper/base/algebra_stepper_base.hpp
6 Base class for all steppers with an algebra and operations.
9 Copyright 2012-2013 Karsten Ahnert
10 Copyright 2012 Mario Mulansky
12 Distributed under the Boost Software License, Version 1.0.
13 (See accompanying file LICENSE_1_0.txt or
14 copy at http://www.boost.org/LICENSE_1_0.txt)
18 #ifndef BOOST_NUMERIC_ODEINT_STEPPER_BASE_ALGEBRA_STEPPER_BASE_HPP_INCLUDED
19 #define BOOST_NUMERIC_ODEINT_STEPPER_BASE_ALGEBRA_STEPPER_BASE_HPP_INCLUDED
26 template< class Algebra , class Operations >
27 class algebra_stepper_base
31 typedef Algebra algebra_type;
32 typedef Operations operations_type;
34 algebra_stepper_base( const algebra_type &algebra = algebra_type() )
35 : m_algebra( algebra ) { }
37 algebra_type& algebra()
42 const algebra_type& algebra() const
49 algebra_type m_algebra;
53 /******* DOXYGEN *******/
56 * \class algebra_stepper_base
57 * \brief Base class for all steppers with algebra and operations.
59 * This class serves a base class for all steppers with algebra and operations. It holds the
60 * algebra and provides access to the algebra. The operations are not instantiated, since they are
61 * static classes inside the operations class.
63 * \tparam Algebra The type of the algebra. Must fulfill the Algebra Concept, at least partially to work
65 * \tparam Operations The type of the operations. Must fulfill the Operations Concept, at least partially
66 * to work with the stepper.
70 * \fn algebra_stepper_base::algebra_stepper_base( const algebra_type &algebra = algebra_type() )
71 * \brief Constructs a algebra_stepper_base and creates the algebra. This constructor can be used as a default
72 * constructor if the algebra has a default constructor.
73 * \param algebra The algebra_stepper_base stores and uses a copy of algebra.
77 * \fn algebra_type& algebra_stepper_base::algebra()
78 * \return A reference to the algebra which is held by this class.
82 * \fn const algebra_type& algebra_stepper_base::algebra() const
83 * \return A const reference to the algebra which is held by this class.
91 #endif // BOOST_NUMERIC_ODEINT_STEPPER_BASE_ALGEBRA_STEPPER_BASE_HPP_INCLUDED