ROL
src
algorithm
TypeU
linesearch
ROL_LineSearch_U_Factory.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_LINESEARCH_U_FACTORY_H
45
#define ROL_LINESEARCH_U_FACTORY_H
46
47
#include "
ROL_IterationScaling_U.hpp
"
48
#include "
ROL_PathBasedTargetLevel_U.hpp
"
49
#include "
ROL_BackTracking_U.hpp
"
50
#include "
ROL_CubicInterp_U.hpp
"
51
#include "
ROL_ScalarMinimizationLineSearch_U.hpp
"
52
53
namespace
ROL
{
54
template
<
typename
Real>
55
inline
Ptr<LineSearch_U<Real>>
LineSearchUFactory
(ParameterList &parlist) {
56
ELineSearchU
els =
StringToELineSearchU
(
57
parlist.sublist(
"Step"
).sublist(
"Line Search"
).sublist(
"Line-Search Method"
).get(
"Type"
,
"Cubic Interpolation"
));
58
switch
(els) {
59
case
LINESEARCH_U_ITERATIONSCALING
:
return
makePtr<IterationScaling_U<Real>>(parlist);
60
case
LINESEARCH_U_PATHBASEDTARGETLEVEL
:
return
makePtr<PathBasedTargetLevel_U<Real>>(parlist);
61
case
LINESEARCH_U_BACKTRACKING
:
return
makePtr<BackTracking_U<Real>>(parlist);
62
case
LINESEARCH_U_CUBICINTERP
:
return
makePtr<CubicInterp_U<Real>>(parlist);
63
case
LINESEARCH_U_BRENTS
:
64
case
LINESEARCH_U_GOLDENSECTION
:
65
case
LINESEARCH_U_BISECTION
:
return
makePtr<ScalarMinimizationLineSearch_U<Real>>(parlist);
66
default
:
return
nullPtr;
67
}
68
}
69
}
// namespace ROL
70
71
#endif
ROL_BackTracking_U.hpp
ROL_CubicInterp_U.hpp
ROL_IterationScaling_U.hpp
ROL_PathBasedTargetLevel_U.hpp
ROL_ScalarMinimizationLineSearch_U.hpp
ROL
Definition
ROL_ElementwiseVector.hpp:61
ROL::LineSearchUFactory
Ptr< LineSearch_U< Real > > LineSearchUFactory(ParameterList &parlist)
Definition
ROL_LineSearch_U_Factory.hpp:55
ROL::ELineSearchU
ELineSearchU
Definition
ROL_LineSearch_U_Types.hpp:144
ROL::LINESEARCH_U_PATHBASEDTARGETLEVEL
@ LINESEARCH_U_PATHBASEDTARGETLEVEL
Definition
ROL_LineSearch_U_Types.hpp:146
ROL::LINESEARCH_U_BACKTRACKING
@ LINESEARCH_U_BACKTRACKING
Definition
ROL_LineSearch_U_Types.hpp:147
ROL::LINESEARCH_U_ITERATIONSCALING
@ LINESEARCH_U_ITERATIONSCALING
Definition
ROL_LineSearch_U_Types.hpp:145
ROL::LINESEARCH_U_GOLDENSECTION
@ LINESEARCH_U_GOLDENSECTION
Definition
ROL_LineSearch_U_Types.hpp:149
ROL::LINESEARCH_U_BISECTION
@ LINESEARCH_U_BISECTION
Definition
ROL_LineSearch_U_Types.hpp:148
ROL::LINESEARCH_U_CUBICINTERP
@ LINESEARCH_U_CUBICINTERP
Definition
ROL_LineSearch_U_Types.hpp:150
ROL::LINESEARCH_U_BRENTS
@ LINESEARCH_U_BRENTS
Definition
ROL_LineSearch_U_Types.hpp:151
ROL::StringToELineSearchU
ELineSearchU StringToELineSearchU(std::string s)
Definition
ROL_LineSearch_U_Types.hpp:210
Generated by
1.10.0