codi::RealTraits::IsTotalZero< T_Type, TapeTraits::EnableIfForwardTape< typename T_Type::Tape > > Struct Template Reference

Function for checking if the value of the type is completely zero.
More...

#include <forwardEvaluation.hpp>

Inheritance diagram for codi::RealTraits::IsTotalZero< T_Type, TapeTraits::EnableIfForwardTape< typename T_Type::Tape > >:

Public Types
using	Real = typename Type::Real
using	Type
	See RealTraits::IsTotalZero.
using	Type
	See IsTotalZero.

Static Public Member Functions
static inlinebool	isTotalZero (Type const &v)
	Checks if the values are completely zero.
static inlinebool	isTotalZero (Type const &v)
	Checks if the values are completely zero.

Detailed Description

template<typename T_Type>
struct codi::RealTraits::IsTotalZero< T_Type, TapeTraits::EnableIfForwardTape< typename T_Type::Tape > >

Function for checking if the value of the type is completely zero.

Template Parameters

T_Type

The type of the real value. Tests whether both value and gradient are zero.

Member Typedef Documentation

Real

template<typename T_Type>

using codi::RealTraits::IsTotalZero< T_Type, TapeTraits::EnableIfForwardTape< typename T_Type::Tape > >::Real = typename Type::Real

See codi::LhsExpressionInterface::Real.

Type

template<typename T_Type>

using codi::RealTraits::IsTotalZero< T_Type, TapeTraits::EnableIfForwardTape< typename T_Type::Tape > >::Type

Initial value:

 
 
 T_Type

See RealTraits::IsTotalZero.

Member Function Documentation

isTotalZero()

template<typename T_Type>

static inlinebool codi::RealTraits::IsTotalZero< T_Type, TapeTraits::EnableIfForwardTape< typename T_Type::Tape > >::isTotalZero ( Type const & v )

inlinestatic

Checks if the values are completely zero.

---

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

• include/codi/tapes/forwardEvaluation.hpp