Drake
dummy_value< T > Struct Template Reference

Provides a "dummy" value for a ScalarType – a value that is unlikely to be mistaken for a purposefully-computed value, useful for initializing a value before the true result is available. More...

#include <drake/common/dummy_value.h>

Static Public Member Functions

static constexpr T get ()
 

Detailed Description

template<typename T>
struct drake::dummy_value< T >

Provides a "dummy" value for a ScalarType – a value that is unlikely to be mistaken for a purposefully-computed value, useful for initializing a value before the true result is available.

Defaults to using std::numeric_limits::quiet_NaN when available; it is a compile-time error to call the unspecialized dummy_value::get() when quiet_NaN is unavailable.

See autodiff_overloads.h to use this with Eigen's AutoDiffScalar.

Member Function Documentation

static constexpr T get ( )
inlinestatic

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