MOOCHO (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MoochoPack_BFGSUpdate_StrategySetOptions.cpp
Go to the documentation of this file.
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 #include <math.h>
44 
47 
48 // Define the options
49 namespace {
50 
51  const int local_num_options = 5;
52 
54  RESCALE_INIT_IDENTITY
55  ,USE_DAMPENING
56  ,SECANT_TESTING
57  ,SECANT_WARNING_TOL
58  ,SECANT_ERROR_TOL
59  };
60 
61  const char* local_SOptions[local_num_options] = {
62  "rescale_init_identity"
63  ,"use_dampening"
64  ,"secant_testing"
65  ,"secant_warning_tol"
66  ,"secant_error_tol"
67  };
68 
69 }
70 
71 namespace MoochoPack {
72 
74  BFGSUpdate_Strategy* target
75  , const char opt_grp_name[] )
76  : OptionsFromStreamPack::SetOptionsFromStreamNode(
77  opt_grp_name, local_num_options, local_SOptions )
78  , OptionsFromStreamPack::SetOptionsToTargetBase<
79  BFGSUpdate_Strategy >( target )
80 {}
81 
83  int option_num, const std::string& option_value )
84 {
86  typedef BFGSUpdate_Strategy target_t;
87  switch( (local_EOptions)option_num ) {
88  case RESCALE_INIT_IDENTITY:
89  target().rescale_init_identity(
90  StringToBool( "rescale_init_identity", option_value.c_str() ));
91  break;
92  case USE_DAMPENING:
93  target().use_dampening(
94  StringToBool( "use_dampening", option_value.c_str() ));
95  break;
96  case SECANT_TESTING:
97  {
98  const std::string &option = option_value.c_str();
99  if( option == "DEFAULT" )
100  target().secant_testing( target_t::SECANT_TEST_DEFAULT );
101  else if( option == "TEST" )
102  target().secant_testing( target_t::SECANT_TEST_ALWAYS );
103  else if( option == "NO_TEST" )
104  target().secant_testing( target_t::SECANT_NO_TEST );
105  else
106  throw std::invalid_argument( "Error, incorrect value for "
107  "\"secant_testing\"." );
108  break;
109  }
110  case SECANT_WARNING_TOL:
111  target().secant_warning_tol(std::fabs(std::atof(option_value.c_str())));
112  break;
113  case SECANT_ERROR_TOL:
114  target().secant_error_tol(std::fabs(std::atof(option_value.c_str())));
115  break;
116  default:
117  TEUCHOS_TEST_FOR_EXCEPT(true); // Local error only?
118  }
119 }
120 
121 } // end namespace MoochoPack
bool StringToBool(const char *opt_name, const char *str)
Convert a string "true" or "false" into bool #true# or #false#.
BFGSUpdate_StrategySetOptions(BFGSUpdate_Strategy *target=0, const char opt_grp_name[]="BFGSUpdate")
Strategy interface which contains the guts for a dampened BFGS update.
void setOption(int option_num, const std::string &option_value)
Overridden from SetOptionsFromStreamNode.
#define TEUCHOS_TEST_FOR_EXCEPT(throw_exception_test)
const std::string & option_value(OptionsGroup::const_iterator &itr)