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

Provides an interface to run unconstrained optimization algorithms. More...

#include <ROL_TypeU_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 unconstrained problems (Type-U). This is the primary Type-U interface.
virtual void run (Vector< Real > &x, Objective< Real > &obj, std::ostream &outStream=std::cout)
 Run algorithm on unconstrained problems (Type-U). This is the primary Type-U interface.
virtual void run (Vector< Real > &x, Objective< Real > &obj, Constraint< Real > &linear_con, Vector< Real > &linear_mul, std::ostream &outStream=std::cout)
 Run algorithm on unconstrained problems with explicit linear equality constraints (Type-U). This is the primary Type-U with explicit linear equality constraints interface.
virtual void run (Vector< Real > &x, const Vector< Real > &g, Objective< Real > &obj, Constraint< Real > &linear_con, Vector< Real > &linear_mul, const Vector< Real > &linear_c, std::ostream &outStream=std::cout)
 Run algorithm on unconstrained problems with explicit linear equality constraints (Type-U). 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, const Vector< Real > &g, Objective< Real > &obj, std::ostream &outStream=std::cout)=0
 Run algorithm on unconstrained problems (Type-U). 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)

Protected Attributes

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

Detailed Description

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

Provides an interface to run unconstrained optimization algorithms.

Definition at line 49 of file ROL_TypeU_Algorithm.hpp.

Constructor & Destructor Documentation

◆ ~Algorithm()

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

Definition at line 58 of file ROL_TypeU_Algorithm.hpp.

◆ Algorithm()

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

Constructor, given a step and a status test.

Member Function Documentation

◆ initialize()

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

Referenced by ROL::TypeU::BundleAlgorithm< Real >::initialize(), and ROL::TypeU::LineSearchAlgorithm< Real >::initialize().

◆ setStatusTest()

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

◆ run() [1/5]

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

Run algorithm on unconstrained problems (Type-U). This is the primary Type-U interface.

◆ run() [2/5]

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

Run algorithm on unconstrained problems (Type-U). This is the primary Type-U interface.

◆ run() [3/5]

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

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

◆ run() [4/5]

template<typename Real>
virtual void ROL::TypeU::Algorithm< Real >::run ( Vector< Real > & x,
const Vector< Real > & g,
Objective< Real > & obj,
Constraint< Real > & linear_con,
Vector< Real > & linear_mul,
const Vector< Real > & linear_c,
std::ostream & outStream = std::cout )
virtual

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

◆ run() [5/5]

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

Run algorithm on unconstrained problems (Type-U). 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::TypeU::Algorithm< Real >::writeHeader ( std::ostream & os) const
virtual

Print iterate header.

◆ writeName()

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

Print step name.

◆ writeOutput()

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

Print iterate status.

◆ writeExitStatus()

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

Referenced by ROL::TypeU::BundleAlgorithm< Real >::run(), and ROL::TypeU::LineSearchAlgorithm< Real >::run().

◆ getState()

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

◆ reset()

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

Member Data Documentation

◆ status_

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

Definition at line 51 of file ROL_TypeU_Algorithm.hpp.

◆ state_

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

Definition at line 52 of file ROL_TypeU_Algorithm.hpp.

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