MOOCHO (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MoochoPack_CheckConvergenceStd_AddedStepSetOptions.cpp
Go to the documentation of this file.
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 
48 
49 // Define the options
50 namespace {
51 
52  const int local_num_options = 2;
53 
54  enum local_EOptions {
55  SCALE_KKT_ERROR_BY,
56  SCALE_OPT_ERROR_BY_GF
57  };
58 
59  const char* local_SOptions[local_num_options] = {
60  "scale_kkt_error_by",
61  "scale_opt_error_by_Gf",
62  };
63 
64 }
65 
66 namespace MoochoPack {
67 
69  CheckConvergenceStd_AddedStep* target
70  , const char opt_grp_name[] )
71  : OptionsFromStreamPack::SetOptionsFromStreamNode(
72  opt_grp_name, local_num_options, local_SOptions )
73  , OptionsFromStreamPack::SetOptionsToTargetBase<
74  CheckConvergenceStd_AddedStep >( target )
75 {}
76 
78  int option_num, const std::string& option_value )
79 {
81 
82  typedef CheckConvergenceStd_AddedStep target_t;
83  switch( (local_EOptions)option_num ) {
84  case SCALE_KKT_ERROR_BY:
85  {
86  const std::string &option = option_value.c_str();
87  if( option == "SCALE_BY_ONE" )
88  target().scale_kkt_error_by( target_t::SCALE_BY_ONE );
89  else if( option == "SCALE_BY_NORM_2_X" )
90  target().scale_kkt_error_by( target_t::SCALE_BY_NORM_2_X );
91  else if( option == "SCALE_BY_NORM_INF_X" )
92  target().scale_kkt_error_by( target_t::SCALE_BY_NORM_INF_X );
93  else
94  throw std::invalid_argument( "Error, incorrect value for "
95  "\"scale_kkt_error_by\". Only the options "
96  "SCALE_BY_ONE, SCALE_BY_NORM_2_X, and SCALE_BY_NORM_INF_X "
97  "are available" );
98  break;
99  }
100  case SCALE_OPT_ERROR_BY_GF: {
101  target().scale_opt_error_by_Gf(
102  StringToBool( "scale_opt_error_by_Gf", option_value.c_str() ) );
103  break;
104  }
105  default:
106  TEUCHOS_TEST_FOR_EXCEPT(true); // Local error only?
107  }
108 }
109 
110 } // end namespace MoochoPack
111 
112 #endif // 0
bool StringToBool(const char *opt_name, const char *str)
Convert a string "true" or "false" into bool #true# or #false#.
CheckConvergenceStd_AddedStepSetOptions(CheckConvergenceStd_AddedStep *target=0, const char opt_grp_name[]="CheckConvergenceStd")
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)