ROL
ROL_TestProblem.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
49#ifndef ROL_TESTPROBLEMS_HPP
50#define ROL_TESTPROBLEMS_HPP
51
53
54namespace ROL {
55
56template<class Real>
58public:
59 virtual ~TestProblem(void) {}
60 TestProblem(void) {}
61 virtual Ptr<Objective<Real>> getObjective(void) const = 0;
62 virtual Ptr<Vector<Real>> getInitialGuess(void) const = 0;
63 virtual Ptr<Vector<Real>> getSolution(const int i = 0) const = 0;
64 virtual int getNumSolutions(void) const {
65 return 1;
66 }
67 virtual Ptr<BoundConstraint<Real>> getBoundConstraint(void) const {
68 return nullPtr;
69 }
70 virtual Ptr<Constraint<Real>> getEqualityConstraint(void) const {
71 return nullPtr;
72 }
73 virtual Ptr<Vector<Real>> getEqualityMultiplier(void) const {
74 return nullPtr;
75 }
76 virtual Ptr<Constraint<Real>> getInequalityConstraint(void) const {
77 return nullPtr;
78 }
79 virtual Ptr<Vector<Real>> getInequalityMultiplier(void) const {
80 return nullPtr;
81 }
82 virtual Ptr<BoundConstraint<Real>> getSlackBoundConstraint(void) const {
83 return nullPtr;
84 }
85
86 void get(Ptr<OptimizationProblem<Real>> &problem,
87 Ptr<Vector<Real>> &x0,
88 std::vector<Ptr<Vector<Real>>> &x) const {
89 x0 = getInitialGuess()->clone(); x0->set(*getInitialGuess());
90 x.resize(getNumSolutions());
91 for (int i = 0; i < getNumSolutions(); ++i) {
92 x[i] = getSolution(i)->clone(); x[i]->set(*getSolution(i));
93 }
94
95 problem = makePtr<OptimizationProblem<Real>>(getObjective(),
96 x0,
103 }
104};
105} // namespace ROL
106
107#endif
virtual Ptr< Vector< Real > > getInitialGuess(void) const =0
virtual Ptr< Vector< Real > > getEqualityMultiplier(void) const
virtual Ptr< BoundConstraint< Real > > getSlackBoundConstraint(void) const
virtual Ptr< Constraint< Real > > getInequalityConstraint(void) const
virtual Ptr< BoundConstraint< Real > > getBoundConstraint(void) const
virtual Ptr< Constraint< Real > > getEqualityConstraint(void) const
virtual Ptr< Objective< Real > > getObjective(void) const =0
virtual Ptr< Vector< Real > > getSolution(const int i=0) const =0
virtual int getNumSolutions(void) const
virtual ~TestProblem(void)
void get(Ptr< OptimizationProblem< Real > > &problem, Ptr< Vector< Real > > &x0, std::vector< Ptr< Vector< Real > > > &x) const
virtual Ptr< Vector< Real > > getInequalityMultiplier(void) const
Defines the linear algebra or vector space interface.
Definition: ROL_Vector.hpp:84