Integrator< IntegratorType > Struct Template Reference

Base type for all integrators. More...

#include <Integration.h>

Static Public Member Functions
template<typename T, typename BaseSignalSpec, typename TangentSignalSpec>
static bool	integrate (Signal< T, BaseSignalSpec, TangentSignalSpec > &xInt, const Signal< T, TangentSignalSpec, TangentSignalSpec > &x, const double &tf, const bool &insertIntoHistory=false)
	Integrate a signal from the current time to the specified end time.
template<typename T, typename BaseSignalSpec, typename TangentSignalSpec>
static bool	integrate (Signal< T, BaseSignalSpec, TangentSignalSpec > &xInt, const Signal< T, TangentSignalSpec, TangentSignalSpec > &x, const double & > > > > > > > master tf, const double &dt, const bool &insertIntoHistory=false)
	Integrate a signal from the current time to the specified end time, chunked up into smaller integration increments.

Detailed Description

template<typename IntegratorType>
struct Integrator< IntegratorType >

Base type for all integrators.

Provides methods for incremental (e.g., for control) or holistic (e.g., for open-loop simulation) integrations of arbitrary signal types.

Derived types:

• EulerIntegrator
• TrapezoidalIntegrator
• SimpsonIntegrator

Member Function Documentation

integrate() [1/2]

template<typename IntegratorType>

template<typename T, typename BaseSignalSpec, typename TangentSignalSpec>

static bool Integrator< IntegratorType >::integrate ( Signal< T, BaseSignalSpec, TangentSignalSpec > & xInt, const Signal< T, TangentSignalSpec, TangentSignalSpec > & x, const double & > > > > > > , master tf, const double & dt, const bool & insertIntoHistory = false )

inlinestatic

Integrate a signal from the current time to the specified end time, chunked up into smaller integration increments.

Parameters

xInt	The output signal representing the integration.
x	The input signal to be integrated.
tf	The time to integrate to.
dt	Time delta length by which to chunk up the integrations. Ideally this is small.
insertIntoHistory	Whether to store the result in xInt's memory.

Returns

Whether the integration was successful.

integrate() [2/2]

template<typename IntegratorType>

template<typename T, typename BaseSignalSpec, typename TangentSignalSpec>

static bool Integrator< IntegratorType >::integrate ( Signal< T, BaseSignalSpec, TangentSignalSpec > & xInt, const Signal< T, TangentSignalSpec, TangentSignalSpec > & x, const double & tf, const bool & insertIntoHistory = false )

inlinestatic

Integrate a signal from the current time to the specified end time.

Parameters

xInt	The output signal representing the integration.
x	The input signal to be integrated.
tf	The time to integrate to. Ideally the delta from the current time is small.
insertIntoHistory	Whether to store the result in xInt's memory.

Returns

Whether the integration was successful.

---

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

• include/signals/Integration.h