Optimist::Function< Real, N, M, DerivedFunction, ForceEigen > Class Template Reference

Class container for the vector-valued function. More...

#include <Function.hh>

Inherits Optimist::FunctionBase< Real, N, M, DerivedFunction, false >.

Public Types
using	InputVector = typename FunctionBase<Real, N, M, DerivedFunction, ForceEigen>::InputType
using	OutputVector = typename FunctionBase<Real, N, M, DerivedFunction, ForceEigen>::OutputType
using	Matrix = typename FunctionBase<Real, N, M, DerivedFunction, ForceEigen>::FirstDerivativeType
using	Tensor = typename FunctionBase<Real, N, M, DerivedFunction, ForceEigen>::SecondDerivativeType
Public Types inherited from Optimist::FunctionBase< Real, N, M, DerivedFunction, false >
using	InputType
using	OutputType
using	FirstDerivativeType
using	SecondDerivativeType

Public Member Functions
	Function ()
std::string	name () const
bool	evaluate (const InputVector &x, OutputVector &out) const
bool	jacobian (const InputVector &x, Matrix &out) const
bool	hessian (const InputVector &x, Tensor &out) const
Public Member Functions inherited from Optimist::FunctionBase< Real, N, M, DerivedFunction, false >
	FunctionBase ()
std::string	name () const
bool	evaluate (const InputType &x, OutputType &out) const
bool	first_derivative (const InputType &x, FirstDerivativeType &out) const
bool	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 (Integer const i) const
const InputType &	guess (Integer const i) const
bool	is_solution (const InputType &x, Real const tol=EPSILON_LOW) const

Friends
class	FunctionBase< Real, N, M, Function< Real, N, M, DerivedFunction, ForceEigen > >

Additional Inherited Members
Protected Attributes inherited from Optimist::FunctionBase< Real, N, M, DerivedFunction, false >
std::vector< InputType >	m_solutions
std::vector< InputType >	m_guesses

Detailed Description

template<typename Real, Integer N, Integer M, typename DerivedFunction, bool ForceEigen = false>
class Optimist::Function< Real, N, M, DerivedFunction, ForceEigen >

Template Parameters

N	The input dimension of the vector-valued function.
M	The output dimension of the vector-valued function.
DerivedFunction	Derived vector-valued function class.
ForceEigen	Force the use of Eigen types for input and output.

Member Typedef Documentation

InputVector

template<typename Real, Integer N, Integer M, typename DerivedFunction, bool ForceEigen = false>

using Optimist::Function< Real, N, M, DerivedFunction, ForceEigen >::InputVector = typename FunctionBase<Real, N, M, DerivedFunction, ForceEigen>::InputType

Matrix

template<typename Real, Integer N, Integer M, typename DerivedFunction, bool ForceEigen = false>

using Optimist::Function< Real, N, M, DerivedFunction, ForceEigen >::Matrix = typename FunctionBase<Real, N, M, DerivedFunction, ForceEigen>::FirstDerivativeType

OutputVector

template<typename Real, Integer N, Integer M, typename DerivedFunction, bool ForceEigen = false>

using Optimist::Function< Real, N, M, DerivedFunction, ForceEigen >::OutputVector = typename FunctionBase<Real, N, M, DerivedFunction, ForceEigen>::OutputType

Tensor

template<typename Real, Integer N, Integer M, typename DerivedFunction, bool ForceEigen = false>

using Optimist::Function< Real, N, M, DerivedFunction, ForceEigen >::Tensor = typename FunctionBase<Real, N, M, DerivedFunction, ForceEigen>::SecondDerivativeType

Constructor & Destructor Documentation

Function()

template<typename Real, Integer N, Integer M, typename DerivedFunction, bool ForceEigen = false>

Optimist::Function< Real, N, M, DerivedFunction, ForceEigen >::Function ( )

inline

Class constructor for the vector-valued function.

Member Function Documentation

evaluate()

template<typename Real, Integer N, Integer M, typename DerivedFunction, bool ForceEigen = false>

bool Optimist::Function< Real, N, M, DerivedFunction, ForceEigen >::evaluate ( const InputVector & x, OutputVector & 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.

hessian()

template<typename Real, Integer N, Integer M, typename DerivedFunction, bool ForceEigen = false>

bool Optimist::Function< Real, N, M, DerivedFunction, ForceEigen >::hessian ( const InputVector & x, Tensor & out ) const

inline

Compute the function second derivative at the input point.

Parameters

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

Returns

The boolean flag for successful evaluation.

jacobian()

template<typename Real, Integer N, Integer M, typename DerivedFunction, bool ForceEigen = false>

bool Optimist::Function< Real, N, M, DerivedFunction, ForceEigen >::jacobian ( const InputVector & x, Matrix & out ) const

inline

Compute the function first derivative at the input point.

Parameters

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

Returns

The boolean flag for successful evaluation.

name()

template<typename Real, Integer N, Integer M, typename DerivedFunction, bool ForceEigen = false>

std::string Optimist::Function< Real, N, M, DerivedFunction, ForceEigen >::name ( ) const

inline

Get the function name.

Returns

The function name.

Friends And Related Symbol Documentation

FunctionBase< Real, N, M, Function< Real, N, M, DerivedFunction, ForceEigen > >

template<typename Real, Integer N, Integer M, typename DerivedFunction, bool ForceEigen = false>

friend class FunctionBase< Real, N, M, Function< Real, N, M, DerivedFunction, ForceEigen > >

friend

---

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

• include/Optimist/Function.hh