ConstrainedOptPack: C++ Tools for Constrained (and Unconstrained) Optimization  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ConstrainedOptPack_DirectLineSearchArmQuad_StrategySetOptions.cpp
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
5 // Copyright (2003) 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 Roscoe A. Bartlett (rabartl@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 #include <assert.h>
43 
44 #include "ConstrainedOptPack_DirectLineSearchArmQuad_StrategySetOptions.hpp"
45 #include "OptionsFromStreamPack_StringToBool.hpp"
46 
47 // Define the options
48 namespace {
49 
50  const int local_num_options = 5;
51 
52  enum local_EOptions {
53  SLOPE_FRAC,
54  MIN_FRAC_STEP,
55  MAX_FRAC_STEP,
56  MAX_LS_ITER,
57  MAX_OUT_LS_ITER
58  };
59 
60  const char* local_SOptions[local_num_options] = {
61  "slope_frac",
62  "min_frac_step",
63  "max_frac_step",
64  "max_ls_iter",
65  "max_out_ls_iter"
66  };
67 
68 }
69 
70 namespace ConstrainedOptPack {
71 
74  , const char opt_grp_name[] )
75  : OptionsFromStreamPack::SetOptionsFromStreamNode(
76  opt_grp_name, local_num_options, local_SOptions )
77  , OptionsFromStreamPack::SetOptionsToTargetBase<
79 {}
80 
82  int option_num, const std::string& option_value )
83 {
84  using OptionsFromStreamPack::StringToBool;
85  switch( (local_EOptions)option_num ) {
86  case SLOPE_FRAC: {
87  target().eta( std::atof( option_value.c_str() ) );
88  break;
89  }
90  case MIN_FRAC_STEP: {
91  target().min_frac( std::atof( option_value.c_str() ) );
92  break;
93  }
94  case MAX_FRAC_STEP: {
95  target().max_frac( std::atof( option_value.c_str() ) );
96  break;
97  }
98  case MAX_LS_ITER: {
99  target().set_max_iter( std::atof( option_value.c_str() ) );
100  break;
101  }
102  case MAX_OUT_LS_ITER: {
103  target().max_out_iter( StringToBool( "max_out_ls_iter", option_value.c_str() ) );
104  break;
105  }
106  default:
107  TEUCHOS_TEST_FOR_EXCEPT(true); // Local error only?
108  }
109 }
110 
111 } // end namespace ConstrainedOptPack
DirectLineSearchArmQuad_StrategySetOptions(DirectLineSearchArmQuad_Strategy *qp_solver=0, const char opt_grp_name[]="DirectLineSearchArmQuad")
Performs a line search using the Armijo condition and uses quadratic interpolation to select each new...
void setOption(int option_num, const std::string &option_value)
Overridden from SetOptionsFromStreamNode.
#define TEUCHOS_TEST_FOR_EXCEPT(throw_exception_test)