ROL
src
algorithm
TypeU
trustregion
ROL_TrustRegion_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
49
#ifndef ROL_TRUSTREGION_U_FACTORY_HPP
50
#define ROL_TRUSTREGION_U_FACTORY_HPP
51
52
#include "
ROL_TrustRegion_U_Types.hpp
"
53
#include "
ROL_CauchyPoint_U.hpp
"
54
#include "
ROL_DogLeg_U.hpp
"
55
#include "
ROL_DoubleDogLeg_U.hpp
"
56
#include "
ROL_TruncatedCG_U.hpp
"
57
#include "
ROL_SPGTrustRegion_U.hpp
"
58
59
namespace
ROL
{
60
template
<
typename
Real>
61
inline
Ptr<TrustRegion_U<Real>>
TrustRegionUFactory
(ParameterList &list) {
62
ETrustRegionU
etr =
StringToETrustRegionU
(
63
list.sublist(
"Step"
).sublist(
"Trust Region"
).get(
"Subproblem Solver"
,
"Dogleg"
));
64
switch
(etr) {
65
case
TRUSTREGION_U_CAUCHYPOINT
:
return
makePtr<CauchyPoint_U<Real>>();
66
case
TRUSTREGION_U_DOGLEG
:
return
makePtr<DogLeg_U<Real>>();
67
case
TRUSTREGION_U_DOUBLEDOGLEG
:
return
makePtr<DoubleDogLeg_U<Real>>();
68
case
TRUSTREGION_U_TRUNCATEDCG
:
return
makePtr<TruncatedCG_U<Real>>(list);
69
case
TRUSTREGION_U_SPG
:
return
makePtr<SPGTrustRegion_U<Real>>(list);
70
default
:
return
nullPtr;
71
}
72
}
73
}
// ROL
74
75
#endif
ROL_CauchyPoint_U.hpp
ROL_DogLeg_U.hpp
ROL_DoubleDogLeg_U.hpp
ROL_SPGTrustRegion_U.hpp
ROL_TruncatedCG_U.hpp
ROL_TrustRegion_U_Types.hpp
Contains definitions of enums for trust region algorithms.
ROL
Definition
ROL_ElementwiseVector.hpp:61
ROL::ETrustRegionU
ETrustRegionU
Definition
ROL_TrustRegion_U_Types.hpp:63
ROL::TRUSTREGION_U_TRUNCATEDCG
@ TRUSTREGION_U_TRUNCATEDCG
Definition
ROL_TrustRegion_U_Types.hpp:65
ROL::TRUSTREGION_U_DOUBLEDOGLEG
@ TRUSTREGION_U_DOUBLEDOGLEG
Definition
ROL_TrustRegion_U_Types.hpp:68
ROL::TRUSTREGION_U_DOGLEG
@ TRUSTREGION_U_DOGLEG
Definition
ROL_TrustRegion_U_Types.hpp:67
ROL::TRUSTREGION_U_SPG
@ TRUSTREGION_U_SPG
Definition
ROL_TrustRegion_U_Types.hpp:66
ROL::TRUSTREGION_U_CAUCHYPOINT
@ TRUSTREGION_U_CAUCHYPOINT
Definition
ROL_TrustRegion_U_Types.hpp:64
ROL::StringToETrustRegionU
ETrustRegionU StringToETrustRegionU(std::string s)
Definition
ROL_TrustRegion_U_Types.hpp:120
ROL::TrustRegionUFactory
Ptr< TrustRegion_U< Real > > TrustRegionUFactory(ParameterList &list)
Definition
ROL_TrustRegion_U_Factory.hpp:61
Generated by
1.10.0