GQCP
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Public Attributes | List of all members
GQCP::MinimizationEnvironment< _Scalar > Class Template Reference

#include <MinimizationEnvironment.hpp>

Inheritance diagram for GQCP::MinimizationEnvironment< _Scalar >:
Inheritance graph
Collaboration diagram for GQCP::MinimizationEnvironment< _Scalar >:
Collaboration graph

Public Types

using Scalar = _Scalar
 
- Public Types inherited from GQCP::OptimizationEnvironment< VectorX< _Scalar > >
using Iterate = VectorX< _Scalar >
 
using Scalar = typename Iterate::Scalar
 

Public Member Functions

 MinimizationEnvironment (const VectorX< _Scalar > &initial_guess, const VectorFunction< Scalar > &gradient_function, const MatrixFunction< Scalar > &hessian_function)
 
- Public Member Functions inherited from GQCP::OptimizationEnvironment< VectorX< _Scalar > >
 OptimizationEnvironment (const Iterate &initial_guess)
 

Public Attributes

VectorFunction< Scalargradient_function
 
MatrixFunction< Scalarhessian_function
 
std::deque< double > function_values
 
- Public Attributes inherited from GQCP::OptimizationEnvironment< VectorX< _Scalar > >
std::deque< VectorX< _Scalar > > variables
 

Detailed Description

template<typename _Scalar>
class GQCP::MinimizationEnvironment< _Scalar >

An environment that can be used to minimize scalar functions.

Template Parameters
_Scalarthe scalar type that is used to represent the variables of scalar function

Member Typedef Documentation

◆ Scalar

template<typename _Scalar >
using GQCP::MinimizationEnvironment< _Scalar >::Scalar = _Scalar

Constructor & Destructor Documentation

◆ MinimizationEnvironment()

template<typename _Scalar >
GQCP::MinimizationEnvironment< _Scalar >::MinimizationEnvironment ( const VectorX< _Scalar > &  initial_guess,
const VectorFunction< Scalar > &  gradient_function,
const MatrixFunction< Scalar > &  hessian_function 
)
inline

Initialize the optimization environment with an initial guess

Parameters
initial_guessthe initial guess for the variables
gradient_functiona callable function that produces the gradient of the scalar function, evaluated at the given variables
hessian_functiona callable function that produces the Hessian of the scalar function, evaluated at the given variables

Member Data Documentation

◆ function_values

template<typename _Scalar >
std::deque<double> GQCP::MinimizationEnvironment< _Scalar >::function_values

◆ gradient_function

template<typename _Scalar >
VectorFunction<Scalar> GQCP::MinimizationEnvironment< _Scalar >::gradient_function

◆ hessian_function

template<typename _Scalar >
MatrixFunction<Scalar> GQCP::MinimizationEnvironment< _Scalar >::hessian_function

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