ROL
ROL_LineSearchFactory.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_LINESEARCHFACTORY_H
45#define ROL_LINESEARCHFACTORY_H
46
47#include "ROL_Types.hpp"
48
49#include "ROL_ParameterList.hpp"
50#include "ROL_Ptr.hpp"
51
52#include "ROL_LineSearch.hpp"
55#include "ROL_BackTracking.hpp"
56#include "ROL_CubicInterp.hpp"
57#include "ROL_Bisection.hpp"
58#include "ROL_GoldenSection.hpp"
59#include "ROL_Brents.hpp"
61
62namespace ROL {
63 template<class Real>
64 inline ROL::Ptr<LineSearch<Real> > LineSearchFactory(ROL::ParameterList &parlist) {
66 parlist.sublist("Step").sublist("Line Search").sublist("Line-Search Method").get("Type","Cubic Interpolation"));
67 switch(els) {
68 case LINESEARCH_ITERATIONSCALING: return ROL::makePtr<IterationScaling<Real>>(parlist);
69 case LINESEARCH_PATHBASEDTARGETLEVEL: return ROL::makePtr<PathBasedTargetLevel<Real>>(parlist);
70 case LINESEARCH_BACKTRACKING: return ROL::makePtr<BackTracking<Real>>(parlist);
71 case LINESEARCH_CUBICINTERP: return ROL::makePtr<CubicInterp<Real>>(parlist);
72// case LINESEARCH_BISECTION: return ROL::makePtr<Bisection<Real>>(parlist);
73// case LINESEARCH_BRENTS: return ROL::makePtr<Brents<Real>>(parlist);
74// case LINESEARCH_GOLDENSECTION: return ROL::makePtr<GoldenSection<Real>>(parlist);
77 case LINESEARCH_BISECTION: return ROL::makePtr<ScalarMinimizationLineSearch<Real>>(parlist);
78 default: return ROL::nullPtr;
79 }
80 }
81}
82
83#endif
Contains definitions of custom data types in ROL.
ELineSearch
Definition: ROL_Types.hpp:658
@ LINESEARCH_BISECTION
Definition: ROL_Types.hpp:662
@ LINESEARCH_BACKTRACKING
Definition: ROL_Types.hpp:661
@ LINESEARCH_CUBICINTERP
Definition: ROL_Types.hpp:664
@ LINESEARCH_BRENTS
Definition: ROL_Types.hpp:665
@ LINESEARCH_GOLDENSECTION
Definition: ROL_Types.hpp:663
@ LINESEARCH_PATHBASEDTARGETLEVEL
Definition: ROL_Types.hpp:660
@ LINESEARCH_ITERATIONSCALING
Definition: ROL_Types.hpp:659
ROL::Ptr< LineSearch< Real > > LineSearchFactory(ROL::ParameterList &parlist)
ELineSearch StringToELineSearch(std::string s)
Definition: ROL_Types.hpp:724