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

Class container for the linear function. More...

#include <Linear.hh>

Inherits Optimist::ScalarFunction< Real, Linear< Real > >.

Public Member Functions
	Linear ()
std::string	name_impl () const
void	evaluate_impl (Real x, Real &out) const
void	first_derivative_impl (Real, Real &out) const
void	second_derivative_impl (Real, Real &out) const
Public Member Functions inherited from Optimist::ScalarFunction< Real, Linear< Real > >
	ScalarFunction ()
std::string	name () const
void	evaluate (Real x, Real &out) const
void	first_derivative (Real x, Real &out) const
void	second_derivative (Real x, Real &out) const
Public Member Functions inherited from Optimist::Function< Real, 1, 1, Linear< Real > >
	Function ()
std::string	name () const
void	evaluate (const InputType &x, OutputType &out) const
void	first_derivative (const InputType &x, FirstDerivativeType &out) const
void	second_derivative (const InputType &x, SecondDerivativeType &out) const
constexpr Integer	input_dimension () const
constexpr Integer	output_dimension () const
const std::vector< InputType > &	solutions () const
const std::vector< InputType > &	guesses () const
const InputType &	solution (const Integer i) const
const InputType &	guess (const Integer i) const
bool	is_solution (const InputType &x, const Real tol=EPSILON_LOW) const

Private Attributes
Real	m_m {1.0}
Real	m_q {1.0}

Additional Inherited Members
Public Types inherited from Optimist::Function< Real, 1, 1, Linear< Real > >
using	InputType
using	OutputType
using	FirstDerivativeType
using	SecondDerivativeType
Public Attributes inherited from Optimist::ScalarFunction< Real, Linear< Real > >
friend	Function< Real, 1, 1, ScalarFunction< Real, DerivedFunction > >
Protected Attributes inherited from Optimist::Function< Real, 1, 1, Linear< Real > >
std::vector< InputType >	m_solutions
std::vector< InputType >	m_guesses

Detailed Description

template<typename Real>
class Optimist::TestSet::Linear< Real >

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

Real	Scalar number type.

Constructor & Destructor Documentation

Linear()

template<typename Real>

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

inline

< Basic constants. Class constructor for the linear function.

Member Function Documentation

evaluate_impl()

template<typename Real>

void Optimist::TestSet::Linear< Real >::evaluate_impl ( Real x, Real & out ) const

inline

Compute the function value at the input point.

Parameters

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

first_derivative_impl()

template<typename Real>

void Optimist::TestSet::Linear< Real >::first_derivative_impl ( Real , Real & out ) const

inline

Compute the first derivative value at the input point.

Parameters

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

name_impl()

template<typename Real>

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

inline

Get the function name.

Returns

The function name.

second_derivative_impl()

template<typename Real>

void Optimist::TestSet::Linear< Real >::second_derivative_impl ( Real , Real & out ) const

inline

Compute the second derivative value at the input point.

Parameters

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

Member Data Documentation

m_m

template<typename Real>

Real Optimist::TestSet::Linear< Real >::m_m {1.0}

private

Coefficient \( m \).

m_q

template<typename Real>

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

private

Coefficient \( q \).

---

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

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