Eigen::NumTraits< stan::agrad::var > Struct Template Reference

Numerical traits template override for Eigen for automatic gradient variables. More...

#include <matrix.hpp>

Public Types
enum	{   IsInteger = 0, IsSigned = 1, IsComplex = 0, RequireInitialization = 0,   ReadCost = 1, AddCost = 1, MulCost = 1, HasFloatingPoint = 1 }
	Properties for automatic differentiation variables read by Eigen matrix library. More...
typedef stan::agrad::var	Real
	Real-valued variables.
typedef stan::agrad::var	NonInteger
	Non-integer valued variables.
typedef stan::agrad::var	Nested
	Nested variables.

Static Public Member Functions
static Real	epsilon ()
	Return standard library's epsilon for double-precision floating point, std::numeric_limits<double>epsilon().
static Real	dummy_precision ()
	Return dummy precision.
static Real	highest ()
	Return standard library's highest for double-precision floating point, std::numeric_limits<double>max().
static Real	lowest ()
	Return standard library's lowest for double-precision floating point, &#45;std::numeric_limits<double>max().

Detailed Description

template<>
struct Eigen::NumTraits< stan::agrad::var >

Numerical traits template override for Eigen for automatic gradient variables.

Definition at line 59 of file matrix.hpp.

Member Typedef Documentation

typedef stan::agrad::var Eigen::NumTraits< stan::agrad::var >::Nested

Nested variables.

Required for numerical traits.

Definition at line 80 of file matrix.hpp.

typedef stan::agrad::var Eigen::NumTraits< stan::agrad::var >::NonInteger

Non-integer valued variables.

Required for numerical traits.

Definition at line 73 of file matrix.hpp.

typedef stan::agrad::var Eigen::NumTraits< stan::agrad::var >::Real

Real-valued variables.

Required for numerical traits.

Definition at line 66 of file matrix.hpp.

Member Enumeration Documentation

anonymous enum

Properties for automatic differentiation variables read by Eigen matrix library.

Enumerator:

IsInteger
IsSigned
IsComplex
RequireInitialization
ReadCost
AddCost
MulCost
HasFloatingPoint

Definition at line 123 of file matrix.hpp.

Member Function Documentation

static Real Eigen::NumTraits< stan::agrad::var >::dummy_precision ( )

inlinestatic

Return dummy precision.

Definition at line 95 of file matrix.hpp.

static Real Eigen::NumTraits< stan::agrad::var >::epsilon ( )

inlinestatic

Return standard library's epsilon for double-precision floating point, std::numeric_limits<double>epsilon().

Returns

Same epsilon as a double.

Definition at line 88 of file matrix.hpp.

static Real Eigen::NumTraits< stan::agrad::var >::highest ( )

inlinestatic

Return standard library's highest for double-precision floating point, std::numeric_limits<double>max().

Returns

Same highest value as a double.

Definition at line 105 of file matrix.hpp.

static Real Eigen::NumTraits< stan::agrad::var >::lowest ( )

inlinestatic

Return standard library's lowest for double-precision floating point, &#45;std::numeric_limits<double>max().

Returns

Same lowest value as a double.

Definition at line 115 of file matrix.hpp.

---

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

• src/stan/agrad/matrix.hpp