Cnst< T > Class Template Reference

Cnst<T> encapsulates something that only can be constant and never has a derivative. More...

#include <jacobian.hpp>

List of all members.

Public Types
typedef Traits< T >::derivType	derivType
typedef T	exprType
typedef Traits< T >::valueType	valueType
Public Member Functions
derivType	deriv (int i) const
	returns the derivative towards the ith variable. Should never be called.
derivType &	deriv (int i)
	returns the derivative towards the ith variable. Should never be called.
JacobianBitset	getDerivs () const
	stores a bitset containing to target
bool	hasDeriv (int i) const
	indicates whether ith derivative is zero or not.
bool	hasDerivs () const
	indicates whether all derivatives are zero.
int	nrOfDeriv () const
	returns the number of variables to which the derivative is taken.
Cnst< T > &	operator= (const T &expr)
	assigns the argument to the current object
void	setDeriv (int i, bool s=true)
	specify whether all derivatives are zero or not.
valueType &	value ()
	returns the value of this entity
valueType	value () const
	returns the value of this entity
Private Attributes
valueType	val

---

Detailed Description

template<typename T>
class Cnst< T >

Cnst<T> encapsulates something that only can be constant and never has a derivative.

Definition at line 338 of file experimental/jacobian.hpp.

---

Member Typedef Documentation

template<typename T >

typedef Traits<T>::derivType Cnst< T >::derivType

GeomTriats classes are used to derive the type of the derivatives of instances of type T.

Definition at line 346 of file experimental/jacobian.hpp.

template<typename T >

typedef T Cnst< T >::exprType

Definition at line 340 of file experimental/jacobian.hpp.

template<typename T >

typedef Traits<T>::valueType Cnst< T >::valueType

Definition at line 341 of file experimental/jacobian.hpp.

---

Member Function Documentation

template<typename T >

derivType Cnst< T >::deriv

(

int

i

)

const [inline]

returns the derivative towards the ith variable. Should never be called.

Definition at line 361 of file experimental/jacobian.hpp.

template<typename T >

derivType& Cnst< T >::deriv

(

int

i

)

[inline]

returns the derivative towards the ith variable. Should never be called.

Definition at line 370 of file experimental/jacobian.hpp.

template<typename T >

JacobianBitset Cnst< T >::getDerivs

(

)

const [inline]

stores a bitset containing to target

target[i] is true if ith variable has a derivative.

Definition at line 424 of file experimental/jacobian.hpp.

template<typename T >

bool Cnst< T >::hasDeriv

(

int

i

)

const [inline]

indicates whether ith derivative is zero or not.

Definition at line 407 of file experimental/jacobian.hpp.

template<typename T >

bool Cnst< T >::hasDerivs

(

)

const [inline]

indicates whether all derivatives are zero.

Definition at line 414 of file experimental/jacobian.hpp.

template<typename T >

int Cnst< T >::nrOfDeriv

(

)

const [inline]

returns the number of variables to which the derivative is taken.

Definition at line 399 of file experimental/jacobian.hpp.

template<typename T >

Cnst<T>& Cnst< T >::operator=

(

const T &

expr

)

[inline]

assigns the argument to the current object

Assigns the argument to the stored value and makes all derivatives zero. isConstant() is true after this assignment.

Definition at line 444 of file experimental/jacobian.hpp.

template<typename T >

void Cnst< T >::setDeriv	(	int	i,
		bool	s = true
	)		[inline]

specify whether all derivatives are zero or not.

Warning:

Should never be called.

Definition at line 433 of file experimental/jacobian.hpp.

template<typename T >

valueType& Cnst< T >::value

(

)

[inline]

returns the value of this entity

This method will be used with non-const declarations of Jacobian<T>. It that case value() can be an lvalue.

Definition at line 381 of file experimental/jacobian.hpp.

template<typename T >

valueType Cnst< T >::value

(

)

const [inline]

returns the value of this entity

This method will be used with a const Jacobian<T>& declaration. It is impossible to use value() as an lvalue.

Definition at line 391 of file experimental/jacobian.hpp.

---

Member Data Documentation

template<typename T >

valueType Cnst< T >::val [private]

Definition at line 348 of file experimental/jacobian.hpp.

---

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

• experimental/jacobian.hpp