Analytics Template Library
 All Classes Namespaces Functions Variables Pages
Public Types | Public Member Functions | Public Attributes | List of all members
atl::Real< REAL_T > Struct Template Reference

#include <Real.hpp>

Inheritance diagram for atl::Real< REAL_T >:
atl::ExpressionBase< REAL_T, Real< REAL_T > > atl::ExpressionBase< REAL_T, Real< REAL_T > >

Public Types

typedef REAL_T base_type
 
typedef REAL_T base_type
 

Public Member Functions

 Real (REAL_T v=static_cast< REAL_T >(0.0))
 
 Real (const Real< REAL_T > &other)
 
Real & operator= (const REAL_T &v)
 
 operator REAL_T () const
 
const REAL_T GetValue () const
 
const REAL_T GetValue (size_t i, size_t j=0) const
 
void PushIds (typename atl::StackEntry< REAL_T >::vi_storage &ids) const
 
void PushIds (typename atl::StackEntry< REAL_T >::vi_storage &ids, size_t i, size_t j=0) const
 
REAL_T EvaluateDerivative (uint32_t a) const
 
REAL_T EvaluateDerivative (uint32_t a, uint32_t b) const
 
REAL_T EvaluateDerivative (uint32_t x, uint32_t y, uint32_t z) const
 
REAL_T EvaluateDerivative (uint32_t a, size_t i, size_t j=0) const
 
REAL_T EvaluateDerivative (uint32_t a, uint32_t b, size_t i, size_t j=0) const
 
REAL_T EvaluateDerivative (uint32_t x, uint32_t y, uint32_t z, size_t i, size_t j=0) const
 
size_t GetColumns () const
 
size_t GetRows () const
 
bool IsScalar () const
 
 Real (REAL_T v=static_cast< REAL_T >(0.0))
 
 Real (const Real< REAL_T > &other)
 
Real & operator= (const REAL_T &v)
 
 operator REAL_T () const
 
const REAL_T GetValue () const
 
const REAL_T GetValue (size_t i, size_t j=0) const
 
bool IsNonlinear () const
 
void PushIds (typename atl::StackEntry< REAL_T >::vi_storage &ids) const
 
void PushIds (typename atl::StackEntry< REAL_T >::vi_storage &ids, size_t i, size_t j=0) const
 
REAL_T EvaluateDerivative (uint32_t x) const
 
REAL_T EvaluateDerivative (uint32_t x, uint32_t y) const
 
REAL_T EvaluateDerivative (uint32_t x, uint32_t y, uint32_t z) const
 
REAL_T EvaluateDerivative (uint32_t x, size_t i, size_t j=0) const
 
REAL_T EvaluateDerivative (uint32_t x, uint32_t y, size_t i, size_t j=0) const
 
REAL_T EvaluateDerivative (uint32_t x, uint32_t y, uint32_t z, size_t i, size_t j=0) const
 
size_t GetColumns () const
 
size_t GetRows () const
 
bool IsScalar () const
 
const std::string ToExpressionTemplateString () const
 
- Public Member Functions inherited from atl::ExpressionBase< REAL_T, Real< REAL_T > >
const Real< REAL_T > & Cast () const
 
const Real< REAL_T > & Cast () const
 
const REAL_T GetValue () const
 
const REAL_T GetValue (size_t i, size_t j=0) const
 
const REAL_T GetValue () const
 
const REAL_T GetValue (size_t i, size_t j=0) const
 
bool IsNonlinear () const
 
bool IsNonlinear () const
 
void PushIds (typename atl::StackEntry< REAL_T >::vi_storage &ids) const
 
void PushIds (typename atl::StackEntry< REAL_T >::vi_storage &ids, size_t i, size_t j=0) const
 
void PushIds (typename atl::StackEntry< REAL_T >::vi_storage &ids) const
 
void PushIds (typename atl::StackEntry< REAL_T >::vi_storage &ids, size_t i, size_t j=0) const
 
REAL_T EvaluateDerivative (uint32_t a) const
 
REAL_T EvaluateDerivative (uint32_t a, uint32_t b) const
 
REAL_T EvaluateDerivative (uint32_t x, uint32_t y, uint32_t z) const
 
REAL_T EvaluateDerivative (uint32_t a, size_t i, size_t j=0) const
 
REAL_T EvaluateDerivative (uint32_t a, uint32_t b, size_t i, size_t j=0) const
 
REAL_T EvaluateDerivative (uint32_t x, uint32_t y, uint32_t z, size_t i, size_t j=0) const
 
REAL_T EvaluateDerivative (uint32_t x) const
 
REAL_T EvaluateDerivative (uint32_t x, uint32_t y) const
 
REAL_T EvaluateDerivative (uint32_t x, uint32_t y, uint32_t z) const
 
REAL_T EvaluateDerivative (uint32_t x, size_t i, size_t j=0) const
 
REAL_T EvaluateDerivative (uint32_t x, uint32_t y, size_t i, size_t j=0) const
 
REAL_T EvaluateDerivative (uint32_t x, uint32_t y, uint32_t z, size_t i, size_t j=0) const
 
const ExpressionBase & operator= (const ExpressionBase &exp) const
 
const ExpressionBase & operator= (const ExpressionBase &exp) const
 
size_t GetColumns () const
 
size_t GetColumns () const
 
size_t GetRows () const
 
size_t GetRows () const
 
bool IsScalar () const
 
bool IsScalar () const
 
std::string ToExpressionTemplateString () const
 

Public Attributes

REAL_T value
 

Detailed Description

template<typename REAL_T>
struct atl::Real< REAL_T >

Wrapper class for real numbers. Used in expression templates to avoid separate templates for operations involving real values in binary expressions.

Constructor & Destructor Documentation

template<typename REAL_T>
atl::Real< REAL_T >::Real ( REAL_T  v = static_cast<REAL_T> (0.0))
inline

Constructor.

Parameters
v
template<typename REAL_T>
atl::Real< REAL_T >::Real ( const Real< REAL_T > &  other)
inline

Copy constructor.

Parameters
other

Member Function Documentation

template<typename REAL_T>
REAL_T atl::Real< REAL_T >::EvaluateDerivative ( uint32_t  x) const
inline

Returns 0.

Parameters
x
Returns
template<typename REAL_T>
REAL_T atl::Real< REAL_T >::EvaluateDerivative ( uint32_t  x,
uint32_t  y 
) const
inline

Returns 0.

Parameters
x
y
Returns
template<typename REAL_T>
REAL_T atl::Real< REAL_T >::EvaluateDerivative ( uint32_t  x,
uint32_t  y,
uint32_t  z 
) const
inline

Returns 0.

Parameters
x
y
z
Returns
template<typename REAL_T>
REAL_T atl::Real< REAL_T >::EvaluateDerivative ( uint32_t  x,
size_t  i,
size_t  j = 0 
) const
inline

Returns 0.

Parameters
x
i
j
Returns
template<typename REAL_T>
REAL_T atl::Real< REAL_T >::EvaluateDerivative ( uint32_t  x,
uint32_t  y,
size_t  i,
size_t  j = 0 
) const
inline

Returns 0.

Parameters
x
y
i
j
Returns
template<typename REAL_T>
REAL_T atl::Real< REAL_T >::EvaluateDerivative ( uint32_t  x,
uint32_t  y,
uint32_t  z,
size_t  i,
size_t  j = 0 
) const
inline

Returns 0.

Parameters
x
y
z
i
j
Returns
template<typename REAL_T>
size_t atl::Real< REAL_T >::GetColumns ( ) const
inline

Returns std::numeric_limits<size_t>::max();

Returns
template<typename REAL_T>
size_t atl::Real< REAL_T >::GetRows ( ) const
inline

std::numeric_limits<size_t>::max();

Returns
template<typename REAL_T>
const REAL_T atl::Real< REAL_T >::GetValue ( ) const
inline

Returns the value.

Returns
template<typename REAL_T>
const REAL_T atl::Real< REAL_T >::GetValue ( size_t  i,
size_t  j = 0 
) const
inline

Returns the value.

Returns
template<typename REAL_T>
bool atl::Real< REAL_T >::IsNonlinear ( ) const
inline

Returns false.

Returns
template<typename REAL_T>
bool atl::Real< REAL_T >::IsScalar ( ) const
inline

Returns true.

Returns
template<typename REAL_T>
Real& atl::Real< REAL_T >::operator= ( const REAL_T &  v)
inline

Assignment operator.

Parameters
v
Returns
template<typename REAL_T>
void atl::Real< REAL_T >::PushIds ( typename atl::StackEntry< REAL_T >::vi_storage &  ids) const
inline

Nothing done.

Parameters
ids
template<typename REAL_T>
void atl::Real< REAL_T >::PushIds ( typename atl::StackEntry< REAL_T >::vi_storage &  ids,
size_t  i,
size_t  j = 0 
) const
inline

Nothing done.

Parameters
ids
i
j
template<typename REAL_T>
const std::string atl::Real< REAL_T >::ToExpressionTemplateString ( ) const
inline

Creates a string representation of this expression template.

Returns
The documentation for this struct was generated from the following file:
Generated on Tue Jan 24 2017 08:59:06 for Analytics Template Library by   doxygen 1.8.8