ROL
ROL_StatusTestFactory.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_STATUSFACTORY_H
45 #define ROL_STATUSFACTORY_H
46 
47 #include "ROL_Types.hpp"
48 
49 #include "Teuchos_ParameterList.hpp"
50 #include "Teuchos_RCP.hpp"
51 
52 #include "ROL_StatusTest.hpp"
53 #include "ROL_BundleStatusTest.hpp"
55 
56 namespace ROL {
57  template<class Real>
58  class StatusTestFactory {
59  public:
61 
62  Teuchos::RCP<StatusTest<Real> > getStatusTest(const std::string step,
63  Teuchos::ParameterList &parlist) {
64  EStep els = StringToEStep(step);
65  switch(els) {
66  case STEP_BUNDLE: return Teuchos::rcp( new BundleStatusTest<Real>(parlist) );
67  case STEP_AUGMENTEDLAGRANGIAN: return Teuchos::rcp( new ConstraintStatusTest<Real>(parlist) );
68  case STEP_COMPOSITESTEP: return Teuchos::rcp( new ConstraintStatusTest<Real>(parlist) );
69  case STEP_MOREAUYOSIDAPENALTY: return Teuchos::rcp( new ConstraintStatusTest<Real>(parlist) );
70  case STEP_INTERIORPOINT: return Teuchos::rcp( new ConstraintStatusTest<Real>(parlist) );
71  case STEP_LINESEARCH: return Teuchos::rcp( new StatusTest<Real>(parlist) );
72  case STEP_PRIMALDUALACTIVESET: return Teuchos::rcp( new StatusTest<Real>(parlist) );
73  case STEP_TRUSTREGION: return Teuchos::rcp( new StatusTest<Real>(parlist) );
74  default: return Teuchos::null;
75  }
76  }
77  };
78 }
79 
80 #endif
EStep StringToEStep(std::string s)
Definition: ROL_Types.hpp:224
Contains definitions of custom data types in ROL.
Provides an interface to check status of optimization algorithms for problems with equality constrain...
Provides an interface to check status of optimization algorithms.
Teuchos::RCP< StatusTest< Real > > getStatusTest(const std::string step, Teuchos::ParameterList &parlist)
EStep
Enumeration of step types.
Definition: ROL_Types.hpp:159