Optimist  0.0.0
A C++ library for optimization
Loading...
Searching...
No Matches
Optimist::TestSet::EllipticParaboloid< Real > Class Template Reference

Class container for the paraboloid function. More...

#include <EllipticParaboloid.hh>

Inherits Optimist::Function< Real, 2, 1, EllipticParaboloid< Real > >.

Public Types

using Vector = typename Function<Real, 2, 1, EllipticParaboloid<Real>>::Vector
using RowVector = typename Function<Real, 2, 1, EllipticParaboloid<Real>>::RowVector
using Matrix = typename Function<Real, 2, 1, EllipticParaboloid<Real>>::Matrix
Public Types inherited from Optimist::Function< Real, 2, 1, EllipticParaboloid< Real > >
using InputVector
using OutputVector
using Matrix
using Tensor
Public Types inherited from Optimist::FunctionBase< Real, N, M, EllipticParaboloid< Real >, false >
using InputType
using OutputType
using FirstDerivativeType
using SecondDerivativeType

Public Member Functions

 EllipticParaboloid ()
std::string name_impl () const
void evaluate_impl (const Vector &x, Real &out) const
void first_derivative_impl (const Vector &x, RowVector &out) const
void second_derivative_impl (const Vector &, Matrix &out) const
Public Member Functions inherited from Optimist::Function< Real, 2, 1, EllipticParaboloid< Real > >
 Function ()
std::string name () const
void evaluate (const InputVector &x, OutputVector &out) const
void jacobian (const InputVector &x, Matrix &out) const
void hessian (const InputVector &x, Tensor &out) const
Public Member Functions inherited from Optimist::FunctionBase< Real, N, M, EllipticParaboloid< Real >, false >
 FunctionBase ()
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 InputTypesolution (const Integer i) const
const InputTypeguess (const Integer i) const
bool is_solution (const InputType &x, const Real tol=EPSILON_LOW) const

Private Attributes

Real m_a {1.0}
Real m_b {1.0}

Additional Inherited Members

Protected Attributes inherited from Optimist::FunctionBase< Real, N, M, EllipticParaboloid< Real >, false >
std::vector< InputTypem_solutions
std::vector< InputTypem_guesses

Detailed Description

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

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

\[f(\mathbf{x}) = ax^2 + by^2 \text{.} \]

The function has global minima at \(\mathbf{x} = (0, 0)\), with \(f(\mathbf{x}) = 0\). The initial guesses are generated on the square \(x_i \in \left[-100, 100\right]\).

Template Parameters
RealScalar number type.

Member Typedef Documentation

◆ Matrix

template<typename Real>
using Optimist::TestSet::EllipticParaboloid< Real >::Matrix = typename Function<Real, 2, 1, EllipticParaboloid<Real>>::Matrix

◆ RowVector

template<typename Real>
using Optimist::TestSet::EllipticParaboloid< Real >::RowVector = typename Function<Real, 2, 1, EllipticParaboloid<Real>>::RowVector

◆ Vector

template<typename Real>
using Optimist::TestSet::EllipticParaboloid< Real >::Vector = typename Function<Real, 2, 1, EllipticParaboloid<Real>>::Vector

< Basic constants.

Constructor & Destructor Documentation

◆ EllipticParaboloid()

template<typename Real>
Optimist::TestSet::EllipticParaboloid< Real >::EllipticParaboloid ( )
inline

Class constructor for the paraboloid function.

Member Function Documentation

◆ evaluate_impl()

template<typename Real>
void Optimist::TestSet::EllipticParaboloid< Real >::evaluate_impl ( const Vector & x,
Real & out ) const
inline

Compute the function value at the input point.

Parameters
[in]xInput point.
[out]outThe function value.

◆ first_derivative_impl()

template<typename Real>
void Optimist::TestSet::EllipticParaboloid< Real >::first_derivative_impl ( const Vector & x,
RowVector & out ) const
inline

Compute the first derivative value at the input point.

Parameters
[in]xInput point.
[out]outThe first derivative value.

◆ name_impl()

template<typename Real>
std::string Optimist::TestSet::EllipticParaboloid< Real >::name_impl ( ) const
inline

Get the function name.

Returns
The function name.

◆ second_derivative_impl()

template<typename Real>
void Optimist::TestSet::EllipticParaboloid< Real >::second_derivative_impl ( const Vector & ,
Matrix & out ) const
inline

Compute the second derivative value at the input point.

Parameters
[in]xInput point.
[out]outThe second derivative value.

Member Data Documentation

◆ m_a

template<typename Real>
Real Optimist::TestSet::EllipticParaboloid< Real >::m_a {1.0}
private

Coefficient \( a \).

◆ m_b

template<typename Real>
Real Optimist::TestSet::EllipticParaboloid< Real >::m_b {1.0}
private

Coefficient \( b \).


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