ROL
|
Provides a simplified interface for solving a wide range of optimization problems. More...
#include <ROL_Solver.hpp>
Public Member Functions | |
Solver (const Ptr< Problem< Real >> &opt, ParameterList &list, const Ptr< Secant< Real >> &secant=nullPtr) | |
Constructor. More... | |
int | solve (const Ptr< StatusTest< Real >> &status=nullPtr, bool combineStatus=true) |
Solve optimization problem with no iteration output. More... | |
int | solve (std::ostream &outStream, const Ptr< StatusTest< Real >> &status=nullPtr, bool combineStatus=true) |
Solve optimization problem. More... | |
Ptr< const AlgorithmState< Real > > | getAlgorithmState () const |
Return the AlgorithmState. More... | |
void | reset () |
Reset both Algorithm and Step. More... | |
Private Attributes | |
const Ptr< Problem< Real > > | opt_ |
const EProblem | problemType_ |
Ptr< TypeU::Algorithm< Real > > | algoU_ |
Ptr< TypeB::Algorithm< Real > > | algoB_ |
Ptr< TypeE::Algorithm< Real > > | algoE_ |
Ptr< TypeG::Algorithm< Real > > | algoG_ |
Provides a simplified interface for solving a wide range of optimization problems.
Definition at line 64 of file ROL_Solver.hpp.
ROL::Solver< Real >::Solver | ( | const Ptr< Problem< Real >> & | opt, |
ParameterList & | list, | ||
const Ptr< Secant< Real >> & | secant = nullPtr |
||
) |
Constructor.
[in] | opt | the OptimizationProblem to be solved |
[in] | parlist | algorithm and step input parameters |
Definition at line 50 of file ROL_Solver_Def.hpp.
References ROL::Solver< Real >::algoB_, ROL::Solver< Real >::algoE_, ROL::Solver< Real >::algoG_, ROL::Solver< Real >::algoU_, ROL::Solver< Real >::problemType_, ROL::TYPE_B, ROL::TYPE_E, ROL::TYPE_EB, ROL::TYPE_LAST, and ROL::TYPE_U.
int ROL::Solver< Real >::solve | ( | const Ptr< StatusTest< Real >> & | status = nullPtr , |
bool | combineStatus = true |
||
) |
Solve optimization problem with no iteration output.
[in] | status | is a user-defined StatusTest |
[in] | combineStatus | if true, the user-defined StatusTest will be combined with the default StatusTest |
Definition at line 66 of file ROL_Solver_Def.hpp.
References ROL::solve().
Referenced by main(), and ROL::ProgressiveHedging< Real >::presolve().
int ROL::Solver< Real >::solve | ( | std::ostream & | outStream, |
const Ptr< StatusTest< Real >> & | status = nullPtr , |
||
bool | combineStatus = true |
||
) |
Solve optimization problem.
[in] | outStream | is the output stream to collect iteration history |
[in] | status | is a user-defined StatusTest |
[in] | combineStatus | if true, the user-defined StatusTest will be combined with the default StatusTest |
Definition at line 73 of file ROL_Solver_Def.hpp.
References ROL::TYPE_B, ROL::TYPE_E, ROL::TYPE_EB, ROL::TYPE_LAST, and ROL::TYPE_U.
Ptr< const AlgorithmState< Real > > ROL::Solver< Real >::getAlgorithmState | ( | void | ) | const |
Return the AlgorithmState.
Definition at line 105 of file ROL_Solver_Def.hpp.
References ROL::TYPE_B, ROL::TYPE_E, ROL::TYPE_EB, ROL::TYPE_LAST, and ROL::TYPE_U.
void ROL::Solver< Real >::reset | ( | void | ) |
Reset both Algorithm and Step.
This function will reset the AlgorithmState and reinitialize the Step. This function does not permit changing the Step specified upon construction. To change the Step, reinitialize the OptimizationSolver.
Definition at line 120 of file ROL_Solver_Def.hpp.
References ROL::TYPE_B, ROL::TYPE_E, ROL::TYPE_EB, ROL::TYPE_LAST, and ROL::TYPE_U.
Referenced by ROL::ProgressiveHedging< Real >::presolve().
|
private |
Definition at line 67 of file ROL_Solver.hpp.
|
private |
Definition at line 68 of file ROL_Solver.hpp.
Referenced by ROL::Solver< Real >::Solver().
|
private |
Definition at line 70 of file ROL_Solver.hpp.
Referenced by ROL::Solver< Real >::Solver().
|
private |
Definition at line 71 of file ROL_Solver.hpp.
Referenced by ROL::Solver< Real >::Solver().
|
private |
Definition at line 72 of file ROL_Solver.hpp.
Referenced by ROL::Solver< Real >::Solver().
|
private |
Definition at line 73 of file ROL_Solver.hpp.
Referenced by ROL::Solver< Real >::Solver().