MOOCHO (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
NLPInterfacePack_NLPDirectTesterSetOptions.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 = 8;
52 
54  GF_TESTING_METHOD
55  ,GF_WARNING_TOL
56  ,GF_ERROR_TOL
57  ,GC_TESTING_METHOD
58  ,GC_WARNING_TOL
59  ,GC_ERROR_TOL
60  ,NUM_FD_DIRECTIONS
61  ,DUMP_ALL
62  };
63 
64  const char* local_SOptions[local_num_options] = {
65  "Gf_testing_method"
66  ,"Gf_warning_tol"
67  ,"Gf_error_tol"
68  ,"Gc_testing_method"
69  ,"Gc_warning_tol"
70  ,"Gc_error_tol"
71  ,"num_fd_directions"
72  ,"dump_all"
73  };
74 
75 }
76 
77 namespace NLPInterfacePack {
78 
80  NLPDirectTester* target
81  ,const char opt_grp_name[]
82  )
83  :OptionsFromStreamPack::SetOptionsFromStreamNode(opt_grp_name,local_num_options,local_SOptions)
84  ,OptionsFromStreamPack::SetOptionsToTargetBase<NLPDirectTester>( target )
85 {}
86 
88  int option_num, const std::string& option_value
89  )
90 {
91  namespace ofsp = OptionsFromStreamPack;
92  using ofsp::StringToBool;
93  typedef NLPDirectTester target_t;
94  switch( (local_EOptions)option_num ) {
95  case GF_TESTING_METHOD:
96  {
97  const std::string &option = option_value.c_str();
98  if( option == "FD_COMPUTE_ALL" )
99  target().Gf_testing_method( target_t::FD_COMPUTE_ALL );
100  else if( option == "FD_DIRECTIONAL" )
101  target().Gf_testing_method( target_t::FD_DIRECTIONAL );
102  else
103  throw std::invalid_argument( "Error, incorrect value for "
104  "\"Gf_testing_method\". Only the options "
105  "FD_COMPUTE_ALL and FD_DIRECTIONAL are available" );
106  break;
107  }
108  case GF_WARNING_TOL:
109  target().Gf_warning_tol(std::fabs(std::atof(option_value.c_str())));
110  break;
111  case GF_ERROR_TOL:
112  target().Gf_error_tol(std::fabs(std::atof(option_value.c_str())));
113  break;
114  case GC_TESTING_METHOD:
115  {
116  const std::string &option = option_value.c_str();
117  if( option == "FD_COMPUTE_ALL" )
118  target().Gc_testing_method( target_t::FD_COMPUTE_ALL );
119  else if( option == "FD_DIRECTIONAL" )
120  target().Gc_testing_method( target_t::FD_DIRECTIONAL );
121  else
122  throw std::invalid_argument( "Error, incorrect value for "
123  "\"Gc_testing_method\". Only the options "
124  "FD_COMPUTE_ALL and FD_DIRECTIONAL are available" );
125  break;
126  }
127  case GC_WARNING_TOL:
128  target().Gc_warning_tol(std::fabs(std::atof(option_value.c_str())));
129  break;
130  case GC_ERROR_TOL:
131  target().Gc_error_tol(std::fabs(std::atof(option_value.c_str())));
132  break;
133  case NUM_FD_DIRECTIONS:
134  target().num_fd_directions(std::abs(std::atoi(option_value.c_str())));
135  break;
136  case DUMP_ALL:
137  target().dump_all(StringToBool("dump_all",option_value.c_str()));
138  break;
139  default:
140  TEUCHOS_TEST_FOR_EXCEPT(true); // Local error only?
141  }
142 }
143 
144 } // end namespace NLPInterfacePack
NLPDirectTesterSetOptions(NLPDirectTester *target=0, const char opt_grp_name[]="NLPDirectTester")
bool StringToBool(const char *opt_name, const char *str)
Convert a string "true" or "false" into bool #true# or #false#.
void abs(DVectorSlice *vs_lhs, const DVectorSlice &vs_rhs)
vs_lhs = abs(vs_rhs)
Concrete class that tests the computed values of the NLPDirect interface using finite differences...
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)