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

Class container for the hyperbolic cosine function. More...

#include <Cosh.hh>

Inherits Optimist::Function< Real, 1, 1, Cosh< Real > >.

Public Member Functions

 Cosh ()
std::string name_impl () const
void evaluate_impl (Real x, Real &out) const
void first_derivative_impl (Real x, Real &out) const
void second_derivative_impl (Real x, Real &out) const
Public Member Functions inherited from Optimist::Function< Real, 1, 1, Cosh< 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, Cosh< 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

Additional Inherited Members

Public Types inherited from Optimist::Function< Real, 1, 1, Cosh< Real > >
using InputVector
using OutputVector
using Matrix
using Tensor
Public Types inherited from Optimist::FunctionBase< Real, N, M, Cosh< Real >, false >
using InputType
using OutputType
using FirstDerivativeType
using SecondDerivativeType
Protected Attributes inherited from Optimist::FunctionBase< Real, N, M, Cosh< Real >, false >
std::vector< InputTypem_solutions
std::vector< InputTypem_guesses

Detailed Description

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

Class container for the hyperbolic cosine function, which is defined as:

\[f(x) = \cosh(x) = \displaystyle\frac{e^x + e^{-x}}{2} \text{.} \]

The function has a minimum at \(x = 0\), with \(f(x) = 1\). The initial guesses are generated on the range \(x \in \left[-10, 10\right]\).

Template Parameters
RealScalar number type.

Constructor & Destructor Documentation

◆ Cosh()

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

< Basic constants. Class constructor for the hyperbolic cosine function.

Member Function Documentation

◆ evaluate_impl()

template<typename Real>
void Optimist::TestSet::Cosh< Real >::evaluate_impl ( Real 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::Cosh< Real >::first_derivative_impl ( Real x,
Real & 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::Cosh< Real >::name_impl ( ) const
inline

Get the function name.

Returns
The function name.

◆ second_derivative_impl()

template<typename Real>
void Optimist::TestSet::Cosh< Real >::second_derivative_impl ( Real x,
Real & out ) const
inline

Compute the second derivative value at the input point.

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

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