Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

This is the documentation for an old version of boost. Click here for the latest Boost documentation.
Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext

Class template algebra_stepper_base

boost::numeric::odeint::algebra_stepper_base — Base class for all steppers with algebra and operations.

Synopsis

// In header: <boost/numeric/odeint/stepper/base/algebra_stepper_base.hpp>

template<typename Algebra, typename Operations> 
class algebra_stepper_base {
public:
  // types
  typedef Algebra    algebra_type;   
  typedef Operations operations_type;

  // construct/copy/destruct
  algebra_stepper_base(const algebra_type & = algebra_type());

  // public member functions
  algebra_type & algebra();
  const algebra_type & algebra() const;
};

Description

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

  1. typename Algebra

    The type of the algebra. Must fulfill the Algebra Concept, at least partially to work with the stepper.

  2. typename Operations

    The type of the operations. Must fulfill the Operations Concept, at least partially to work with the stepper.

algebra_stepper_base public construct/copy/destruct

  1. algebra_stepper_base(const algebra_type & algebra = algebra_type());
    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:

    algebra

    The algebra_stepper_base stores and uses a copy of algebra.

algebra_stepper_base public member functions

  1. algebra_type & algebra();

    Returns:

    A reference to the algebra which is held by this class.

  2. const algebra_type & algebra() const;

    Returns:

    A const reference to the algebra which is held by this class.


PrevUpHomeNext