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

#include <Fabs.hpp>

Inheritance diagram for atl::Fabs< REAL_T, EXPR >:
atl::ExpressionBase< REAL_T, Fabs< REAL_T, EXPR > > atl::ExpressionBase< REAL_T, Fabs< REAL_T, EXPR > >

Public Types

typedef REAL_T BASE_TYPE
 
typedef REAL_T BASE_TYPE
 

Public Member Functions

 Fabs (const ExpressionBase< REAL_T, EXPR > &a)
 
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
 
const REAL_T EvaluateDerivative (uint32_t id) const
 
REAL_T EvaluateDerivative (uint32_t a, uint32_t b) const
 
REAL_T EvaluateDerivative (uint32_t x, uint32_t y, uint32_t z) const
 
const REAL_T EvaluateDerivative (uint32_t id, 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
 
 Fabs (const ExpressionBase< REAL_T, EXPR > &a)
 
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
 
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
 
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 GetRows () const
 
bool IsScalar () const
 
const std::string ToExpressionTemplateString () const
 
- Public Member Functions inherited from atl::ExpressionBase< REAL_T, Fabs< REAL_T, EXPR > >
const Fabs< REAL_T, EXPR > & Cast () const
 
const Fabs< REAL_T, EXPR > & 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

const EXPR & expr_m
 

Detailed Description

template<class REAL_T, class EXPR>
struct atl::Fabs< REAL_T, EXPR >

Expression template to handle the absolute value for variable or container expressions. Not differentiable at zero. For a differentiable estimate see ad_fabs.

\( \arccos f(x,y) \)

or

\( \arccos f_{i,j}(x,y) \)

Constructor & Destructor Documentation

template<class REAL_T , class EXPR >
atl::Fabs< REAL_T, EXPR >::Fabs ( const ExpressionBase< REAL_T, EXPR > &  a)
inline

Constructor

Parameters
a

Member Function Documentation

template<class REAL_T , class EXPR >
const REAL_T atl::Fabs< REAL_T, EXPR >::EvaluateDerivative ( uint32_t  x) const
inline

Evaluates the first-order derivative with respect to x.

\( {{f(x)\,\left({{d}\over{d\,x}}\,f(x)\right)}\over{ \left| f(x)\right| }} \)

note: undefined at f(x) = 0. see ad_fabs for an alternative.

Parameters
x
Returns
template<class REAL_T , class EXPR >
REAL_T atl::Fabs< REAL_T, EXPR >::EvaluateDerivative ( uint32_t  x,
uint32_t  y 
) const
inline

Evaluates the second-order derivative with respect to x and y.

\( {{f(x,y)\,\left({{d^2}\over{d\,x\,d\,y}}\,f(x,y)\right) }\over{\left| f(x,y)\right| }} \)

Parameters
x
y
Returns
template<class REAL_T , class EXPR >
REAL_T atl::Fabs< REAL_T, EXPR >::EvaluateDerivative ( uint32_t  x,
uint32_t  y,
uint32_t  z 
) const
inline

Evaluates the third-order derivative with respect to x, y, and z at index {i,j}.

\( {{f(x,y,z)\,\left({{d^3}\over{d\,x\,d\,y\,d\,z}}\,f(x,y ,z)\right)}\over{\left| f(x,y,z)\right| }} \)

note: undefined at f(x) = 0. see ad_fabs for an alternative.

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

Evaluates the first-order derivative with respect to x at index {i,j}.

\( {{f_{i,j}(x)\,\left({{d}\over{d\,x}}\,f_{i,j}(x)\right)}\over{ \left| f_{i,j}(x)\right| }} \)

note: undefined at f(x) = 0. see ad_fabs for an alternative.

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

Evaluates the second-order derivative with respect to x and y at index {i,j}.

\( {{f_{i,j}(x,y)\,\left({{d^2}\over{d\,x\,d\,y}}\,f_{i,j}(x,y)\right) }\over{\left| f_{i,j}(x,y)\right| }} \)

note: undefined at f(x) = 0. see ad_fabs for an alternative.

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

Evaluates the third-order derivative with respect to x, y, and z at index {i,j}.

\( {{f_{i,j}(x,y,z)\,\left({{d^3}\over{d\,x\,d\,y\,d\,z}}\,f_{i,j}(x,y ,z)\right)}\over{\left| f_{i,j}(x,y,z)\right| }} \)

note: undefined at f(x) = 0. see ad_fabs for an alternative.

Parameters
x
y
z
i
j
Returns
template<class REAL_T , class EXPR >
size_t atl::Fabs< REAL_T, EXPR >::GetRows ( ) const
inline

Return the number of rows.

Returns
template<class REAL_T , class EXPR >
const REAL_T atl::Fabs< REAL_T, EXPR >::GetValue ( ) const
inline

Computes the absolute value of the evaluated expression.

Returns
template<class REAL_T , class EXPR >
const REAL_T atl::Fabs< REAL_T, EXPR >::GetValue ( size_t  i,
size_t  j = 0 
) const
inline

Computes the absolute value of the evaluated expression at index {i,j}.

Returns
template<class REAL_T , class EXPR >
bool atl::Fabs< REAL_T, EXPR >::IsNonlinear ( ) const
inline

Returns false.

Returns
template<class REAL_T , class EXPR >
bool atl::Fabs< REAL_T, EXPR >::IsScalar ( ) const
inline

True if this expression is a scalar.

Returns
template<class REAL_T , class EXPR >
void atl::Fabs< REAL_T, EXPR >::PushIds ( typename atl::StackEntry< REAL_T >::vi_storage &  ids) const
inline

Push variable info into a set.

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

Push variable info into a set at index {i,j}.

Parameters
ids
i
j
template<class REAL_T , class EXPR >
const std::string atl::Fabs< REAL_T, EXPR >::ToExpressionTemplateString ( ) const
inline

Create 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