ROL
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ROL::TypeE::Algorithm< Real > Class Template Referenceabstract

#include <ROL_TypeE_Algorithm.hpp>

Public Member Functions

virtual ~Algorithm ()
 Algorithm ()
 Constructor, given a step and a status test.
void setStatusTest (const Ptr< StatusTest< Real > > &status, bool combineStatus=false)
virtual void run (Problem< Real > &problem, std::ostream &outStream=std::cout)
 Run algorithm on equality constrained problems (Type-E). This is the primary Type-E interface.
virtual void run (Vector< Real > &x, Objective< Real > &obj, Constraint< Real > &econ, Vector< Real > &emul, std::ostream &outStream=std::cout)
 Run algorithm on equality constrained problems (Type-E). This is the primary Type-E interface.
virtual void run (Vector< Real > &x, const Vector< Real > &g, Objective< Real > &obj, Constraint< Real > &econ, Vector< Real > &emul, const Vector< Real > &eres, std::ostream &outStream=std::cout)=0
 Run algorithm on equality constrained problems (Type-E). This general interface supports the use of dual optimization vector spaces, where the user does not define the dual() method.
virtual void run (Vector< Real > &x, Objective< Real > &obj, Constraint< Real > &econ, Vector< Real > &emul, Constraint< Real > &linear_econ, Vector< Real > &linear_emul, std::ostream &outStream=std::cout)
 Run algorithm on equality constrained problems with explicit linear equality constraints (Type-E). This is the primary Type-E with explicit linear equality constraints interface.
virtual void run (Vector< Real > &x, const Vector< Real > &g, Objective< Real > &obj, Constraint< Real > &econ, Vector< Real > &emul, const Vector< Real > &eres, Constraint< Real > &linear_econ, Vector< Real > &linear_emul, const Vector< Real > &linear_eres, std::ostream &outStream=std::cout)
 Run algorithm on equality constrained problems with explicit linear equality constraints (Type-E). This general interface supports the use of dual optimization vector spaces, where the user does not define the dual() method.
virtual void writeHeader (std::ostream &os) const
 Print iterate header.
virtual void writeName (std::ostream &os) const
 Print step name.
virtual void writeOutput (std::ostream &os, const bool write_header=false) const
 Print iterate status.
virtual void writeExitStatus (std::ostream &os) const
Ptr< const AlgorithmState< Real > > getState () const
void reset ()

Protected Member Functions

void initialize (const Vector< Real > &x, const Vector< Real > &g, const Vector< Real > &mul, const Vector< Real > &c)

Protected Attributes

const Ptr< CombinedStatusTest< Real > > status_
const Ptr< AlgorithmState< Real > > state_

Detailed Description

template<typename Real>
class ROL::TypeE::Algorithm< Real >

Definition at line 54 of file ROL_TypeE_Algorithm.hpp.

Constructor & Destructor Documentation

◆ ~Algorithm()

template<typename Real>
virtual ROL::TypeE::Algorithm< Real >::~Algorithm ( )
inlinevirtual

Definition at line 66 of file ROL_TypeE_Algorithm.hpp.

◆ Algorithm()

template<typename Real>
ROL::TypeE::Algorithm< Real >::Algorithm ( )

Constructor, given a step and a status test.

Member Function Documentation

◆ initialize()

template<typename Real>
void ROL::TypeE::Algorithm< Real >::initialize ( const Vector< Real > & x,
const Vector< Real > & g,
const Vector< Real > & mul,
const Vector< Real > & c )
protected

Referenced by ROL::TypeE::AugmentedLagrangianAlgorithm< Real >::initialize(), ROL::TypeE::FletcherAlgorithm< Real >::initialize(), and ROL::TypeE::StabilizedLCLAlgorithm< Real >::initialize().

◆ setStatusTest()

template<typename Real>
void ROL::TypeE::Algorithm< Real >::setStatusTest ( const Ptr< StatusTest< Real > > & status,
bool combineStatus = false )

◆ run() [1/5]

template<typename Real>
virtual void ROL::TypeE::Algorithm< Real >::run ( Problem< Real > & problem,
std::ostream & outStream = std::cout )
virtual

Run algorithm on equality constrained problems (Type-E). This is the primary Type-E interface.

◆ run() [2/5]

template<typename Real>
virtual void ROL::TypeE::Algorithm< Real >::run ( Vector< Real > & x,
Objective< Real > & obj,
Constraint< Real > & econ,
Vector< Real > & emul,
std::ostream & outStream = std::cout )
virtual

Run algorithm on equality constrained problems (Type-E). This is the primary Type-E interface.

◆ run() [3/5]

template<typename Real>
virtual void ROL::TypeE::Algorithm< Real >::run ( Vector< Real > & x,
const Vector< Real > & g,
Objective< Real > & obj,
Constraint< Real > & econ,
Vector< Real > & emul,
const Vector< Real > & eres,
std::ostream & outStream = std::cout )
pure virtual

Run algorithm on equality constrained problems (Type-E). This general interface supports the use of dual optimization vector spaces, where the user does not define the dual() method.

◆ run() [4/5]

template<typename Real>
virtual void ROL::TypeE::Algorithm< Real >::run ( Vector< Real > & x,
Objective< Real > & obj,
Constraint< Real > & econ,
Vector< Real > & emul,
Constraint< Real > & linear_econ,
Vector< Real > & linear_emul,
std::ostream & outStream = std::cout )
virtual

Run algorithm on equality constrained problems with explicit linear equality constraints (Type-E). This is the primary Type-E with explicit linear equality constraints interface.

◆ run() [5/5]

template<typename Real>
virtual void ROL::TypeE::Algorithm< Real >::run ( Vector< Real > & x,
const Vector< Real > & g,
Objective< Real > & obj,
Constraint< Real > & econ,
Vector< Real > & emul,
const Vector< Real > & eres,
Constraint< Real > & linear_econ,
Vector< Real > & linear_emul,
const Vector< Real > & linear_eres,
std::ostream & outStream = std::cout )
virtual

Run algorithm on equality constrained problems with explicit linear equality constraints (Type-E). This general interface supports the use of dual optimization vector spaces, where the user does not define the dual() method.

◆ writeHeader()

template<typename Real>
virtual void ROL::TypeE::Algorithm< Real >::writeHeader ( std::ostream & os) const
virtual

Print iterate header.

◆ writeName()

template<typename Real>
virtual void ROL::TypeE::Algorithm< Real >::writeName ( std::ostream & os) const
virtual

Print step name.

◆ writeOutput()

template<typename Real>
virtual void ROL::TypeE::Algorithm< Real >::writeOutput ( std::ostream & os,
const bool write_header = false ) const
virtual

Print iterate status.

◆ writeExitStatus()

template<typename Real>
virtual void ROL::TypeE::Algorithm< Real >::writeExitStatus ( std::ostream & os) const
virtual

Referenced by ROL::TypeE::AugmentedLagrangianAlgorithm< Real >::run(), ROL::TypeE::FletcherAlgorithm< Real >::run(), and ROL::TypeE::StabilizedLCLAlgorithm< Real >::run().

◆ getState()

template<typename Real>
Ptr< const AlgorithmState< Real > > ROL::TypeE::Algorithm< Real >::getState ( ) const

◆ reset()

template<typename Real>
void ROL::TypeE::Algorithm< Real >::reset ( )

Member Data Documentation

◆ status_

template<typename Real>
const Ptr<CombinedStatusTest<Real> > ROL::TypeE::Algorithm< Real >::status_
protected

Definition at line 56 of file ROL_TypeE_Algorithm.hpp.

◆ state_

template<typename Real>
const Ptr<AlgorithmState<Real> > ROL::TypeE::Algorithm< Real >::state_
protected

Definition at line 57 of file ROL_TypeE_Algorithm.hpp.

The documentation for this class was generated from the following file:
Generated by doxygen 1.15.0