Stan Math Library  2.15.0
reverse mode automatic differentiation
Public Types | Static Public Member Functions | List of all members
Eigen::NumTraits< stan::math::var > Struct Template Reference

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

#include <Eigen_NumTraits.hpp>

Inheritance diagram for Eigen::NumTraits< stan::math::var >:

Public Types

enum  {
  IsComplex = 0, IsInteger = 0, IsSigned = 1, RequireInitialization = 0,
  ReadCost = 2 * NumTraits<double>::ReadCost, AddCost = NumTraits<double>::AddCost, MulCost = NumTraits<double>::MulCost
}
 
typedef stan::math::var Real
 
typedef stan::math::var NonInteger
 
typedef stan::math::var Nested
 

Static Public Member Functions

static stan::math::var dummy_precision ()
 Return the precision for stan::math::var delegates to precision for douboe. More...
 
static int digits10 ()
 Return the number of decimal digits that can be represented without change. More...
 

Detailed Description

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

Numerical traits template override for Eigen for automatic gradient variables.

Documentation here: http://eigen.tuxfamily.org/dox/structEigen_1_1NumTraits.html

Definition at line 19 of file Eigen_NumTraits.hpp.

Member Typedef Documentation

§ Nested

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

Definition at line 22 of file Eigen_NumTraits.hpp.

§ NonInteger

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

Definition at line 21 of file Eigen_NumTraits.hpp.

§ Real

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

Definition at line 20 of file Eigen_NumTraits.hpp.

Member Enumeration Documentation

§ anonymous enum

anonymous enum
Enumerator
IsComplex 

stan::math::var is not complex.

IsInteger 

stan::math::var is not an integer.

IsSigned 

stan::math::var is signed.

RequireInitialization 

stan::math::var does not require initialization.

ReadCost 

Twice the cost of copying a double.

AddCost 

This is just forward cost, but it's the cost of a single addition (plus memory overhead) in the forward direction.

MulCost 

Multiply cost is single multiply going forward, but there's also memory allocation cost.

Definition at line 34 of file Eigen_NumTraits.hpp.

Member Function Documentation

§ digits10()

static int Eigen::NumTraits< stan::math::var >::digits10 ( )
inlinestatic

Return the number of decimal digits that can be represented without change.

Delegates to std::numeric_limits<double>::digits10().

Definition at line 79 of file Eigen_NumTraits.hpp.

§ dummy_precision()

static stan::math::var Eigen::NumTraits< stan::math::var >::dummy_precision ( )
inlinestatic

Return the precision for stan::math::var delegates to precision for douboe.

Returns
precision

Definition at line 30 of file Eigen_NumTraits.hpp.


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

     [ Stan Home Page ] © 2011–2016, Stan Development Team.