MoochoPack : Framework for Large-Scale Optimization Algorithms  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
MoochoPack_CheckSkipBFGSUpdateStd_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_CheckSkipBFGSUpdateStd_StepSetOptions.hpp"
46 #include "OptionsFromStreamPack_StringToBool.hpp"
47 
48 // Define the options
49 namespace {
50 
51  const int local_num_options = 1;
52 
53  const char options_group_name[] = "CheckSkipBFGSUpdateStd";
54 
55  enum local_EOptions {
56  SKIP_BFGS_PROP_CONST
57  };
58 
59  const char* local_SOptions[local_num_options] = {
60  "skip_bfgs_prop_const"
61  };
62 
63 }
64 
65 namespace MoochoPack {
66 
69  : OptionsFromStreamPack::SetOptionsFromStreamNode(
70  options_group_name, local_num_options, local_SOptions )
71  , OptionsFromStreamPack::SetOptionsToTargetBase<
72  CheckSkipBFGSUpdateStd_Step >( target )
73 {}
74 
76  int option_num, const std::string& option_value )
77 {
78  switch( (local_EOptions)option_num ) {
79  case SKIP_BFGS_PROP_CONST: {
80  target().skip_bfgs_prop_const( std::fabs( std::atof( option_value.c_str() ) ) );
81  break;
82  }
83  default:
84  TEUCHOS_TEST_FOR_EXCEPT(true); // Local error only?
85  }
86 }
87 
88 } // end namespace MoochoPack
Checks if a BFGS update should be preformed.
void setOption(int option_num, const std::string &option_value)
Overridden from SetOptionsFromStreamNode.
#define TEUCHOS_TEST_FOR_EXCEPT(throw_exception_test)