NLPInterfacePack: C++ Interfaces and Implementation for Non-Linear Programs  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
NLPInterfacePack_NLPFirstDerivTesterSetOptions.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 #include <math.h>
44 
45 #include "NLPInterfacePack_NLPFirstDerivTesterSetOptions.hpp"
46 
47 // Define the options
48 namespace {
49 
50  const int local_num_options = 4;
51 
52  enum local_EOptions {
53  FD_TESTING_METHOD
54  ,NUM_FD_DIRECTIONS
55  ,WARNING_TOL
56  ,ERROR_TOL
57  };
58 
59  const char* local_SOptions[local_num_options] = {
60  "fd_testing_method"
61  ,"num_fd_directions"
62  ,"warning_tol"
63  ,"error_tol"
64  };
65 
66 }
67 
68 namespace NLPInterfacePack {
69 
71  NLPFirstDerivTester* target
72  , const char opt_grp_name[] )
73  : OptionsFromStreamPack::SetOptionsFromStreamNode(
74  opt_grp_name, local_num_options, local_SOptions )
75  , OptionsFromStreamPack::SetOptionsToTargetBase<
76  NLPFirstDerivTester >( target )
77 {}
78 
80  int option_num, const std::string& option_value )
81 {
82  typedef NLPFirstDerivTester target_t;
83  switch( (local_EOptions)option_num ) {
84  case FD_TESTING_METHOD:
85  {
86  const std::string &option = option_value.c_str();
87  if( option == "FD_COMPUTE_ALL" )
88  target().fd_testing_method( target_t::FD_COMPUTE_ALL );
89  else if( option == "FD_DIRECTIONAL" )
90  target().fd_testing_method( target_t::FD_DIRECTIONAL );
91  else
92  throw std::invalid_argument( "Error, incorrect value for "
93  "\"fd_testing_method\". Only the options "
94  "FD_COMPUTE_ALL and FD_DIRECTIONAL are available" );
95  break;
96  }
97  case NUM_FD_DIRECTIONS:
98  target().num_fd_directions(std::atoi(option_value.c_str()));
99  break;
100  case WARNING_TOL:
101  target().warning_tol(std::fabs(std::atof(option_value.c_str())));
102  break;
103  case ERROR_TOL:
104  target().error_tol(std::fabs(std::atof(option_value.c_str())));
105  break;
106  default:
107  TEUCHOS_TEST_FOR_EXCEPT(true); // Local error only?
108  }
109 }
110 
111 } // end namespace NLPInterfacePack
NLPFirstDerivTesterSetOptions(NLPFirstDerivTester *target=0, const char opt_grp_name[]="NLPFirstDerivTester")
Concrete class that tests the derivatives using finite differences.
void setOption(int option_num, const std::string &option_value)
Overridden from SetOptionsFromStreamNode.
#define TEUCHOS_TEST_FOR_EXCEPT(throw_exception_test)