Optimist::TestSet::Linear< Scalar > Class Template Reference

Class container for the linear function. More...

#include <Linear.hh>

Inherits Optimist::Function< Scalar, Scalar, Linear< Scalar > >.

Public Member Functions
	Linear ()
constexpr std::string	name_impl () const
bool	evaluate_impl (const Scalar x, Scalar &out) const
bool	first_derivative_impl (const Scalar, Scalar &out) const
bool	second_derivative_impl (const Scalar, Scalar &out) const
Public Member Functions inherited from Optimist::Function< Scalar, Scalar, Linear< Scalar > >
	Function ()
constexpr std::string	name () const
bool	evaluate (const Scalar &x, Scalar &out) const
bool	jacobian (const Scalar &x, FirstDerivative &out) const
bool	hessian (const Scalar &x, SecondDerivative &out) const
Public Member Functions inherited from Optimist::FunctionBase< Scalar, Scalar, Linear< Scalar > >
	FunctionBase ()
constexpr std::string	name () const
bool	evaluate (const Scalar &x, Scalar &out) const
bool	first_derivative (const Scalar &x, FirstDerivative &out) const
bool	second_derivative (const Scalar &x, SecondDerivative &out) const
constexpr Integer	input_dimension () const
constexpr Integer	output_dimension () const
const std::vector< Scalar > &	solutions () const
const std::vector< Scalar > &	guesses () const
const Scalar &	solution (const Integer i) const
const Scalar &	guess (const Integer i) const
bool	is_solution (const Scalar &x, const Scalar tol=FunctionBase::SQRT_EPSILON) const

Private Attributes
Scalar	m_m {-1.0}
Scalar	m_q {1.0}

Additional Inherited Members
Public Types inherited from Optimist::FunctionBase< Scalar, Scalar, Linear< Scalar > >
using	InputTrait
using	OutputTrait
using	Scalar
using	FirstDerivative
using	SecondDerivative
Protected Attributes inherited from Optimist::FunctionBase< Scalar, Scalar, Linear< Scalar > >
std::vector< Scalar >	m_solutions
std::vector< Scalar >	m_guesses

Detailed Description

template<typename Scalar>
requires TypeTrait<Scalar>::IsScalar
class Optimist::TestSet::Linear< Scalar >

Class container for the linear function, which is defined as:

\[f(x) = mx + q \text{.} \]

The function has roots at

\[x = -\displaystyle\frac{q}{m} \text{.} \]

The default coefficients are \(m = 1\) and \(q = 1\), and the function initial guess is \(x = 0\).

Template Parameters

Scalar

Floating-point number type.

Constructor & Destructor Documentation

Linear()

template<typename Scalar>

Optimist::TestSet::Linear< Scalar >::Linear ( )

inline

Class constructor for the linear function.

Member Function Documentation

evaluate_impl()

template<typename Scalar>

bool Optimist::TestSet::Linear< Scalar >::evaluate_impl ( const Scalar x, Scalar & out ) const

inline

Compute the function value at the input point.

Parameters

[in]	x	Input point.
[out]	out	The function value.

Returns

The boolean flag for successful evaluation.

first_derivative_impl()

template<typename Scalar>

bool Optimist::TestSet::Linear< Scalar >::first_derivative_impl ( const Scalar , Scalar & out ) const

inline

Compute the first derivative value at the input point.

Parameters

[in]	x	Input point.
[out]	out	The first derivative value.

Returns

The boolean flag for successful evaluation.

name_impl()

template<typename Scalar>

std::string Optimist::TestSet::Linear< Scalar >::name_impl ( ) const

inlineconstexpr

Get the function name.

Returns

The function name.

second_derivative_impl()

template<typename Scalar>

bool Optimist::TestSet::Linear< Scalar >::second_derivative_impl ( const Scalar , Scalar & out ) const

inline

Compute the second derivative value at the input point.

Parameters

[in]	x	Input point.
[out]	out	The second derivative value.

Returns

The boolean flag for successful evaluation.

Member Data Documentation

m_m

template<typename Scalar>

Scalar Optimist::TestSet::Linear< Scalar >::m_m {-1.0}

private

Coefficient \( m \).

m_q

template<typename Scalar>

Scalar Optimist::TestSet::Linear< Scalar >::m_q {1.0}

private

Coefficient \( q \).

---

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

• core/include/Optimist/TestSet/Linear.hh