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

#include <OptimizationEnvironment.hpp>

Collaboration diagram for GQCP::OptimizationEnvironment< _Iterate >:
Collaboration graph

Public Types

using Iterate = _Iterate
 
using Scalar = typename Iterate::Scalar
 

Public Member Functions

 OptimizationEnvironment (const Iterate &initial_guess)
 

Public Attributes

std::deque< _Iterate > variables
 

Detailed Description

template<typename _Iterate>
class GQCP::OptimizationEnvironment< _Iterate >

A standard environment that stores the iterative variables of an iterative algorithm

Template Parameters
_Iteratethe type of the iterative variables

Member Typedef Documentation

◆ Iterate

template<typename _Iterate >
using GQCP::OptimizationEnvironment< _Iterate >::Iterate = _Iterate

◆ Scalar

template<typename _Iterate >
using GQCP::OptimizationEnvironment< _Iterate >::Scalar = typename Iterate::Scalar

Constructor & Destructor Documentation

◆ OptimizationEnvironment()

template<typename _Iterate >
GQCP::OptimizationEnvironment< _Iterate >::OptimizationEnvironment ( const Iterate initial_guess)
inline

Initialize the optimization environment with an initial guess

Parameters
initial_guessthe initial guess for the variables

Member Data Documentation

◆ variables

template<typename _Iterate >
std::deque<_Iterate> GQCP::OptimizationEnvironment< _Iterate >::variables

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