ADORe
ADORe is a modular open source software library and toolkit for decision making, planning, control and simulation of automated vehicles
adore::mad::LHeading< T > Class Template Reference

#include <heading.h>

Inheritance diagram for adore::mad::LHeading< T >:
Inheritance graph
Collaboration diagram for adore::mad::LHeading< T >:
Collaboration graph

Public Types

typedef adoreMatrix< T, 2, 1 > CTDF
 
typedef T DT
 
typedef T CT
 

Public Member Functions

 LHeading (AScalarToN< T, 2 > *df)
 
virtual ~LHeading ()
 
virtual void setLimits (DT lo, DT hi) override
 
virtual DT limitHi () const override
 
virtual DT limitLo () const override
 
virtual CT f (DT x) const override
 
virtual ALFunction< DT, CT > * clone () override
 
virtual ALFunction< DT, CT > * create_derivative () override
 
virtual void bound (const DT &xmin, const DT &xmax, CT &ymin, CT &ymax)
 
- Public Member Functions inherited from adore::mad::ALFunction< T, T >
virtual void f (T *xvec, T *yvec, unsigned int count) const
 
void bound (T &ymin, T &ymax)
 
virtual ~ALFunction ()
 
 ALFunction ()
 
const T operator() (T x) const
 
bool isInDomain (T x)
 
f_bounded (T x)
 
void invalidateCachedBounds ()
 

Private Attributes

AScalarToN< T, 2 > * m_df
 

Detailed Description

template<typename T>
class adore::mad::LHeading< T >

provides heading for dimensions 0,1 of a function

Member Typedef Documentation

◆ CT

template<typename T >
typedef T adore::mad::LHeading< T >::CT

◆ CTDF

template<typename T >
typedef adoreMatrix<T, 2, 1> adore::mad::LHeading< T >::CTDF

◆ DT

template<typename T >
typedef T adore::mad::LHeading< T >::DT

Constructor & Destructor Documentation

◆ LHeading()

template<typename T >
adore::mad::LHeading< T >::LHeading ( AScalarToN< T, 2 > *  df)
inline

◆ ~LHeading()

template<typename T >
virtual adore::mad::LHeading< T >::~LHeading ( )
inlinevirtual

Member Function Documentation

◆ bound()

template<typename T >
virtual void adore::mad::LHeading< T >::bound ( const DT xmin,
const DT xmax,
CT ymin,
CT ymax 
)
inlinevirtual

bound function values in the x-range defined by the hypercube between corner points lower left xmin and upper right xmax

Implements adore::mad::ALFunction< T, T >.

Here is the call graph for this function:

◆ clone()

template<typename T >
virtual ALFunction<DT, CT>* adore::mad::LHeading< T >::clone ( )
inlineoverridevirtual

create a copy of child class object - is used for function operations

Implements adore::mad::ALFunction< T, T >.

Here is the call graph for this function:

◆ create_derivative()

template<typename T >
virtual ALFunction<DT, CT>* adore::mad::LHeading< T >::create_derivative ( )
inlineoverridevirtual

creates a function providing the derivative of the heading

Implements adore::mad::ALFunction< T, T >.

Here is the call graph for this function:

◆ f()

template<typename T >
virtual CT adore::mad::LHeading< T >::f ( DT  x) const
inlineoverridevirtual

function evaluation returns y of codomain type CT for a value x of domain type DT

Implements adore::mad::ALFunction< T, T >.

Here is the call graph for this function:

◆ limitHi()

template<typename T >
virtual DT adore::mad::LHeading< T >::limitHi ( ) const
inlineoverridevirtual

query upper limit of the domain

Implements adore::mad::ALFunction< T, T >.

Here is the call graph for this function:

◆ limitLo()

template<typename T >
virtual DT adore::mad::LHeading< T >::limitLo ( ) const
inlineoverridevirtual

lower limit of the domain

Implements adore::mad::ALFunction< T, T >.

Here is the call graph for this function:

◆ setLimits()

template<typename T >
virtual void adore::mad::LHeading< T >::setLimits ( DT  lo,
DT  hi 
)
inlineoverridevirtual

reduce or increase the limit of the function, without changing y

Implements adore::mad::ALFunction< T, T >.

Here is the call graph for this function:

Member Data Documentation

◆ m_df

template<typename T >
AScalarToN<T, 2>* adore::mad::LHeading< T >::m_df
private

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