ROL
ROL_Solver.hpp
Go to the documentation of this file.
1// @HEADER
2// ************************************************************************
3//
4// Rapid Optimization Library (ROL) Package
5// Copyright (2014) Sandia Corporation
6//
7// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8// license for use of this work by or on behalf of the U.S. Government.
9//
10// Redistribution and use in source and binary forms, with or without
11// modification, are permitted provided that the following conditions are
12// met:
13//
14// 1. Redistributions of source code must retain the above copyright
15// notice, this list of conditions and the following disclaimer.
16//
17// 2. Redistributions in binary form must reproduce the above copyright
18// notice, this list of conditions and the following disclaimer in the
19// documentation and/or other materials provided with the distribution.
20//
21// 3. Neither the name of the Corporation nor the names of the
22// contributors may be used to endorse or promote products derived from
23// this software without specific prior written permission.
24//
25// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36//
37// Questions? Contact lead developers:
38// Drew Kouri (dpkouri@sandia.gov) and
39// Denis Ridzal (dridzal@sandia.gov)
40//
41// ************************************************************************
42// @HEADER
43
44#ifndef ROL_SOLVER_HPP
45#define ROL_SOLVER_HPP
46
51#include "ROL_Problem.hpp"
52
53#include "ROL_ParameterList.hpp"
54#include "ROL_Stream.hpp"
55
61namespace ROL {
62
63template<typename Real>
64class Solver {
65private:
66
67 const Ptr<Problem<Real>> opt_;
69
70 Ptr<TypeU::Algorithm<Real>> algoU_;
71 Ptr<TypeB::Algorithm<Real>> algoB_;
72 Ptr<TypeE::Algorithm<Real>> algoE_;
73 Ptr<TypeG::Algorithm<Real>> algoG_;
74
75public:
76
84 Solver( const Ptr<Problem<Real>> &opt,
85 ParameterList &list );
86
94 int solve( const Ptr<StatusTest<Real>> &status = nullPtr,
95 bool combineStatus = true);
96
105 int solve( std::ostream &outStream,
106 const Ptr<StatusTest<Real>> &status = nullPtr,
107 bool combineStatus = true );
108
113 //Ptr<const AlgorithmState<Real>>& getAlgorithmState() const;
114 Ptr<const AlgorithmState<Real>> getAlgorithmState() const;
115
125 void reset();
126
127}; // class Solver
128
129} // namespace ROL
130
131#include "ROL_Solver_Def.hpp"
132
133#endif // ROL_SOLVER_HPP
134
135
Defines a no-output stream class ROL::NullStream and a function makeStreamPtr which either wraps a re...
Provides a simplified interface for solving a wide range of optimization problems.
Solver(const Ptr< Problem< Real > > &opt, ParameterList &list)
Constructor.
Ptr< TypeG::Algorithm< Real > > algoG_
void reset()
Reset both Algorithm and Step.
Ptr< TypeB::Algorithm< Real > > algoB_
Ptr< TypeE::Algorithm< Real > > algoE_
const Ptr< Problem< Real > > opt_
Ptr< const AlgorithmState< Real > > getAlgorithmState() const
Return the AlgorithmState.
int solve(const Ptr< StatusTest< Real > > &status=nullPtr, bool combineStatus=true)
Solve optimization problem with no iteration output.
const EProblem problemType_
Ptr< TypeU::Algorithm< Real > > algoU_
Provides an interface to check status of optimization algorithms.