MoochoPack : Framework for Large-Scale Optimization Algorithms  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
MoochoPack_InitFinDiffReducedHessian_StepSetOptions.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 "MoochoPack_InitFinDiffReducedHessian_StepSetOptions.hpp"
46 #include "OptionsFromStreamPack_StringToBool.hpp"
47 
48 // Define the options
49 namespace {
50 
51  const int local_num_options = 4;
52 
53  enum local_EOptions {
54  INITIALIZATION_METHOD,
55  MAX_COND,
56  MIN_DIAG,
57  STEP_SCALE
58  };
59 
60  const char* local_SOptions[local_num_options] = {
61  "initialization_method",
62  "max_cond",
63  "min_diag",
64  "step_scale"
65  };
66 
67 }
68 
69 namespace MoochoPack {
70 
73  , const char opt_grp_name[] )
74  : OptionsFromStreamPack::SetOptionsFromStreamNode(
75  opt_grp_name, local_num_options, local_SOptions )
76  , OptionsFromStreamPack::SetOptionsToTargetBase<
78 {}
79 
81  int option_num, const std::string& option_value )
82 {
83  typedef InitFinDiffReducedHessian_Step target_t;
84  switch( (local_EOptions)option_num ) {
85  case INITIALIZATION_METHOD:
86  {
87  const std::string &option = option_value.c_str();
88  if( option == "SCALE_IDENTITY" )
89  target().initialization_method( target_t::SCALE_IDENTITY );
90  else if( option == "SCALE_DIAGONAL" )
91  target().initialization_method( target_t::SCALE_DIAGONAL );
92  else if( option == "SCALE_DIAGONAL_ABS" )
93  target().initialization_method( target_t::SCALE_DIAGONAL_ABS );
94  else
95  throw std::invalid_argument( "Error, incorrect value for "
96  "\"initialization_method\"." );
97  break;
98  }
99  case MAX_COND:
100  target().max_cond(std::fabs(std::atof(option_value.c_str())));
101  break;
102  case MIN_DIAG:
103  target().min_diag(std::abs(std::atoi(option_value.c_str())));
104  break;
105  case STEP_SCALE:
106  target().step_scale(std::fabs(std::atof(option_value.c_str())));
107  break;
108  default:
109  TEUCHOS_TEST_FOR_EXCEPT(true); // Local error only?
110  }
111 }
112 
113 } // end namespace MoochoPack
InitFinDiffReducedHessian_StepSetOptions(InitFinDiffReducedHessian_Step *target=0, const char opt_grp_name[]="InitFinDiffReducedHessian")
Initializes the reduced hessian using a single finite difference along the null space of the constrai...
void setOption(int option_num, const std::string &option_value)
Overridden from SetOptionsFromStreamNode.
#define TEUCHOS_TEST_FOR_EXCEPT(throw_exception_test)