MoochoPack : Framework for Large-Scale Optimization Algorithms  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
MoochoPack_ReducedHessianBFGSStd_StepSetOptions.cpp
1 #if 0
2 
3 // @HEADER
4 // ***********************************************************************
5 //
6 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
7 // Copyright (2003) Sandia Corporation
8 //
9 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
10 // license for use of this work by or on behalf of the U.S. Government.
11 //
12 // Redistribution and use in source and binary forms, with or without
13 // modification, are permitted provided that the following conditions are
14 // met:
15 //
16 // 1. Redistributions of source code must retain the above copyright
17 // notice, this list of conditions and the following disclaimer.
18 //
19 // 2. Redistributions in binary form must reproduce the above copyright
20 // notice, this list of conditions and the following disclaimer in the
21 // documentation and/or other materials provided with the distribution.
22 //
23 // 3. Neither the name of the Corporation nor the names of the
24 // contributors may be used to endorse or promote products derived from
25 // this software without specific prior written permission.
26 //
27 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
28 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
31 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
32 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
33 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
34 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
35 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
36 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
37 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38 //
39 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov)
40 //
41 // ***********************************************************************
42 // @HEADER
43 
44 #include <assert.h>
45 #include <math.h>
46 
47 #include "ReducedHessianBFGSStd_StepSetOptions.h"
48 #include "OptionsFromStreamPack_StringToBool.hpp"
49 
50 // Define the options
51 namespace {
52 
53  const int local_num_options = 5;
54 
55  enum local_EOptions {
56  RESCALE_INIT_IDENTITY
57  ,USE_DAMPENING
58  ,SECANT_TESTING
59  ,SECANT_WARNING_TOL
60  ,SECANT_ERROR_TOL
61  };
62 
63  const char* local_SOptions[local_num_options] = {
64  "rescale_init_identity"
65  ,"use_dampening"
66  ,"secant_testing"
67  ,"secant_warning_tol"
68  ,"secant_error_tol"
69  };
70 
71 }
72 
73 namespace MoochoPack {
74 
75 ReducedHessianBFGSStd_StepSetOptions::ReducedHessianBFGSStd_StepSetOptions(
76  ReducedHessianBFGSStd_Step* target
77  , const char opt_grp_name[] )
78  : OptionsFromStreamPack::SetOptionsFromStreamNode(
79  opt_grp_name, local_num_options, local_SOptions )
80  , OptionsFromStreamPack::SetOptionsToTargetBase<
81  ReducedHessianBFGSStd_Step >( target )
82 {}
83 
84 void ReducedHessianBFGSStd_StepSetOptions::setOption(
85  int option_num, const std::string& option_value )
86 {
87  using OptionsFromStreamPack::StringToBool;
88  typedef ReducedHessianBFGSStd_Step target_t;
89  switch( (local_EOptions)option_num ) {
90  case RESCALE_INIT_IDENTITY:
91  target().rescale_init_identity(
92  StringToBool( "rescale_init_identity", option_value.c_str() ));
93  break;
94  case USE_DAMPENING:
95  target().use_dampening(
96  StringToBool( "use_dampening", option_value.c_str() ));
97  break;
98  case SECANT_TESTING:
99  {
100  const std::string &option = option_value.c_str();
101  if( option == "DEFAULT" )
102  target().secant_testing( target_t::SECANT_TEST_DEFAULT );
103  else if( option == "TEST" )
104  target().secant_testing( target_t::SECANT_TEST_ALWAYS );
105  else if( option == "NO_TEST" )
106  target().secant_testing( target_t::SECANT_NO_TEST );
107  else
108  throw std::invalid_argument( "Error, incorrect value for "
109  "\"secant_testing\"." );
110  break;
111  }
112  case SECANT_WARNING_TOL:
113  target().secant_warning_tol(::fabs(::atof(option_value.c_str())));
114  break;
115  case SECANT_ERROR_TOL:
116  target().secant_error_tol(::fabs(::atof(option_value.c_str())));
117  break;
118  default:
119  TEUCHOS_TEST_FOR_EXCEPT(true); // Local error only?
120  }
121 }
122 
123 } // end namespace MoochoPack
124 
125 #endif // 0
#define TEUCHOS_TEST_FOR_EXCEPT(throw_exception_test)