proxsuite::nlp::math Namespace Reference

Math utilities. More...

Functions
template<typename MatType >
MatType::Scalar	infty_norm (const Eigen::MatrixBase< MatType > &z)
template<typename MatType >
MatType::Scalar	infty_norm (const std::vector< MatType > &z)
template<typename Scalar >
bool	check_scalar (const Scalar value)
	Check that a scalar is neither inf, nor NaN.
template<typename Scalar >
bool	scalar_close (const Scalar a, const Scalar b, const Scalar prec=std::numeric_limits< Scalar >::epsilon())
	Tests whether a and b are close, within absolute and relative precision prec.
template<typename T , typename = std::enable_if_t<std::is_scalar<T>::value>>
bool	check_value (const T &x)
template<typename MatrixType >
bool	check_value (const Eigen::MatrixBase< MatrixType > &x)
template<typename T >
T	sign (const T &x)

Detailed Description

Math utilities.

Function Documentation

infty_norm() [1/2]

template<typename MatType >

MatType::Scalar proxsuite::nlp::math::infty_norm

(

const Eigen::MatrixBase< MatType > &

z

)

Definition at line 51 of file math.hpp.

infty_norm() [2/2]

template<typename MatType >

MatType::Scalar proxsuite::nlp::math::infty_norm

(

const std::vector< MatType > &

z

)

Definition at line 60 of file math.hpp.

check_scalar()

template<typename Scalar >

bool proxsuite::nlp::math::check_scalar ( const Scalar value )

inline

Check that a scalar is neither inf, nor NaN.

Definition at line 70 of file math.hpp.

scalar_close()

template<typename Scalar >

bool proxsuite::nlp::math::scalar_close	(	const Scalar	a,
		const Scalar	b,
		const Scalar	prec = std::numeric_limits<Scalar>::epsilon() )

Tests whether a and b are close, within absolute and relative precision prec.

Definition at line 79 of file math.hpp.

check_value() [1/2]

template<typename T , typename = std::enable_if_t<std::is_scalar<T>::value>>

bool proxsuite::nlp::math::check_value

(

const T &

x

)

Definition at line 85 of file math.hpp.

check_value() [2/2]

template<typename MatrixType >

bool proxsuite::nlp::math::check_value

(

const Eigen::MatrixBase< MatrixType > &

x

)

Definition at line 91 of file math.hpp.

sign()

template<typename T >

T proxsuite::nlp::math::sign

(

const T &

x

)

Definition at line 95 of file math.hpp.