MoochoPack : Framework for Large-Scale Optimization Algorithms  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
MoochoPack_TangentialStepWithInequStd_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_TangentialStepWithInequStd_StepSetOptions.hpp"
46 #include "OptionsFromStreamPack_StringToBool.hpp"
47 #include "Teuchos_Assert.hpp"
48 
49 // Define the options
50 namespace {
51 
52  const int local_num_options = 4;
53 
54  enum local_EOptions {
55  WARM_START_FRAC
56  ,QP_TESTING
57  ,PRIMAL_FEASIBLE_POINT_ERROR
58  ,DUAL_FEASIBLE_POINT_ERROR
59  };
60 
61  const char* local_SOptions[local_num_options] = {
62  "warm_start_frac"
63  ,"qp_testing"
64  ,"primal_feasible_point_error"
65  ,"dual_feasible_point_error"
66  };
67 
68 }
69 
70 namespace MoochoPack {
71 
74  ,const char opt_grp_name[]
75  )
76  :OptionsFromStreamPack::SetOptionsFromStreamNode(
77  opt_grp_name, local_num_options, local_SOptions )
78  ,OptionsFromStreamPack::SetOptionsToTargetBase<
80 {}
81 
83  int option_num, const std::string& option_value )
84 {
85  using OptionsFromStreamPack::StringToBool;
86 
87  typedef TangentialStepWithInequStd_Step target_t;
88  switch( (local_EOptions)option_num ) {
89  case WARM_START_FRAC:
90  target().warm_start_frac(std::fabs(std::atof(option_value.c_str())));
91  break;
92  case QP_TESTING:
93  {
94  const std::string &option = option_value.c_str();
95  if( option == "QP_TEST_DEFAULT" )
96  target().qp_testing( target_t::QP_TEST_DEFAULT );
97  else if( option == "QP_TEST" )
98  target().qp_testing( target_t::QP_TEST );
99  else if( option == "QP_NO_TEST" )
100  target().qp_testing( target_t::QP_NO_TEST );
101  else
103  true, std::invalid_argument
104  ,"Error, incorrect value \'" << option << "\' for "
105  "\"qp_testing\". Only the options "
106  "QP_TEST_DEFAULT, QP_TEST, and QP_NO_TEST "
107  "are available" );
108  break;
109  }
110  case PRIMAL_FEASIBLE_POINT_ERROR:
111  target().primal_feasible_point_error(StringToBool("primal_feasible_point_error",option_value.c_str()));
112  break;
113  case DUAL_FEASIBLE_POINT_ERROR:
114  target().dual_feasible_point_error(StringToBool("dual_feasible_point_error",option_value.c_str()));
115  break;
116  default:
117  TEUCHOS_TEST_FOR_EXCEPT(true); // Local error only?
118  }
119 }
120 
121 } // end namespace MoochoPack
TangentialStepWithInequStd_StepSetOptions(TangentialStepWithInequStd_Step *target=NULL, const char opt_grp_name[]="TangentialStepWithInequStd")
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
void setOption(int option_num, const std::string &option_value)
Overridden from SetOptionsFromStreamNode.
Solves the reduced QP subproblem with bounds and/or general inequalities.
#define TEUCHOS_TEST_FOR_EXCEPT(throw_exception_test)