Public Types | Static Public Member Functions | List of all members
Eigen::NumTraits< stan::math::var > Struct Template Reference

#include "stan/math/rev/mat/fun/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 ()
 
static int digits10 ()
 

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

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

Definition at line 22 of file Eigen_NumTraits.hpp.

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

Definition at line 21 of file Eigen_NumTraits.hpp.

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

Definition at line 20 of file Eigen_NumTraits.hpp.

Member Enumeration Documentation

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.

34  {
35  /**
36  * stan::math::var is not complex.
37  */
38  IsComplex = 0,
39 
40  /**
41  * stan::math::var is not an integer.
42  */
43  IsInteger = 0,
44 
45  /**
46  * stan::math::var is signed.
47  */
48  IsSigned = 1,
49 
50  /**
51  * stan::math::var does not require initialization.
52  */
54 
55  /**
56  * Twice the cost of copying a double.
57  */
58  ReadCost = 2 * NumTraits<double>::ReadCost,
59 
60  /**
61  * This is just forward cost, but it's the cost of a single
62  * addition (plus memory overhead) in the forward direction.
63  */
64  AddCost = NumTraits<double>::AddCost,
65 
66  /**
67  * Multiply cost is single multiply going forward, but there's
68  * also memory allocation cost.
69  */
70  MulCost = NumTraits<double>::MulCost
71  };

Member Function Documentation

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 78 of file Eigen_NumTraits.hpp.

References cols, MECModelEnuComparisons::i, runNovaSAM::Index, fillBadChanDBTables::rows, updateRunHistoryTables::run, and PandAna.Demos.tute_pid_validation::var.

78 { return std::numeric_limits<double>::digits10; }
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.

30  {
31  return NumTraits<double>::dummy_precision();
32  }

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