Emily Boudreaux
856ab51b4c
we need an autodiff library at some point (or we need to roll our own but I do not think that makes sense). CppAD is well tested and header only and easy to include. It is also Liscene compatible with GPL v3.0. Here we bring it in as a dependency
61 lines
1.5 KiB
C++
61 lines
1.5 KiB
C++
# ifndef CPPAD_CORE_EPSILON_HPP
|
|
# define CPPAD_CORE_EPSILON_HPP
|
|
/* --------------------------------------------------------------------------
|
|
CppAD: C++ Algorithmic Differentiation: Copyright (C) 2003-16 Bradley M. Bell
|
|
|
|
CppAD is distributed under the terms of the
|
|
Eclipse Public License Version 2.0.
|
|
|
|
This Source Code may also be made available under the following
|
|
Secondary License when the conditions for such availability set forth
|
|
in the Eclipse Public License, Version 2.0 are satisfied:
|
|
GNU General Public License, Version 2.0 or later.
|
|
---------------------------------------------------------------------------- */
|
|
|
|
/*
|
|
------------------------------------------------------------------------------
|
|
$begin epsilon$$
|
|
$spell
|
|
std
|
|
eps
|
|
CppAD
|
|
namespace
|
|
const
|
|
$$
|
|
|
|
$section Machine Epsilon For AD Types$$
|
|
|
|
$head Deprecated 2012-06-17$$
|
|
This routine has been deprecated.
|
|
You should use the $cref numeric_limits$$ $code epsilon$$ instead.
|
|
|
|
$head Syntax$$
|
|
$icode%eps% = epsilon<%Float%>()%$$
|
|
|
|
$head Purpose$$
|
|
Obtain the value of machine epsilon corresponding
|
|
to the type $icode%Float%$$.
|
|
|
|
$head Float$$
|
|
this type can either be $codei%AD<%Base%>%$$,
|
|
or it can be $icode Base$$ for any $codei%AD<%Base%>%$$ type.
|
|
|
|
$head eps$$
|
|
The result $icode eps$$ has prototype
|
|
$codei%
|
|
%Float% eps
|
|
%$$
|
|
|
|
$end
|
|
------------------------------------------------------------------------------
|
|
*/
|
|
|
|
namespace CppAD {
|
|
|
|
template <class Type>
|
|
inline Type epsilon(void)
|
|
{ return Type ( numeric_limits<Type>::epsilon() ); }
|
|
|
|
}
|
|
# endif
|