MOOCHO (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MoochoPack_NLPAlgoConfigIP.hpp
Go to the documentation of this file.
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 #ifndef ALGO_CONFIG_IP_H
43 #define ALGO_CONFIG_IP_H
44 
46 #include "MoochoPack_NLPAlgo.hpp"
49 
50 namespace MoochoPack {
51 
64 public:
65 
68 
71 
74 
85  void set_options( const options_ptr_t& options );
87  const options_ptr_t& get_options() const;
89  void config_algo_cntr(NLPAlgoContainer* algo_cntr, std::ostream* trase_out);
91  void init_algo(NLPAlgoInterface* algo);
92 
94 
95 public:
96 
99 
123 
125 
128 
130  struct SOptionValues {
131  // Constructor (sets default values)
132  SOptionValues();
133  // Variable Reduction, Range/Null space decompositions
134  value_type max_basis_cond_change_frac_; // If < , don't change default
135  // Reduced Hessian Approximations
138  int num_lbfgs_updates_stored_; // If < 0, don't change default
141  // QP subproblem solvers
144  // Line search methods
148  int full_steps_after_k_; // If < 0, do not use this option at all.
149  };
150 
152 
153 private:
154 
157 
160 
162  SOptionValues uov_; // options set by user
163  SOptionValues cov_; // current option values actually used
164 
165  // ///////////////////////////////////////////////////////
166  // Private member functions
167 
169  static void readin_options(
171  , SOptionValues *option_values, std::ostream* trase_out );
172 
174  static void set_default_options(
175  const SOptionValues& user_option_values
176  , SOptionValues *current_option_values
177  , std::ostream* trase_out );
178 
179 }; // end class NLPAlgoConfigIP
180 
190 } // end namespace MoochoPack
191 
192 #endif // ALGO_CONFIG_IP_H
void config_algo_cntr(NLPAlgoContainer *algo_cntr, std::ostream *trase_out)
Extracts options from a text stream and then allows convenient access to them.
Standard builder object for creating DecompositionSystem, EvalNewPoint Step and other objects and set...
SOptionValues uov_
Options structs.
Teuchos::RCP< const OptionsFromStreamPack::OptionsFromStream > options_ptr_t
Interface NLPAlgoContainer uses to access NLPAlgo.
void init_algo(NLPAlgoInterface *algo)
OptionsFromStreamPack::OptionsFromStream * options
DecompositionSystemStateStepBuilderStd decomp_sys_step_builder_
Builder class for some common code.
Implementation for NLPAlgo solver.
static void readin_options(const OptionsFromStreamPack::OptionsFromStream &options, SOptionValues *option_values, std::ostream *trase_out)
Read in the options from a stream.
Interface for objects responsible for configuring an rSQP algorithm.
static void set_default_options(const SOptionValues &user_option_values, SOptionValues *current_option_values, std::ostream *trase_out)
Set the defaults for options not set by the user.
void set_options(const options_ptr_t &options)
Set the OptionsFromStream object that will be used for specifying the options.
options_ptr_t options_
Smart pointer to options.
AbstractLinAlgPack::value_type value_type
This is a do all configuration class for NLPAlgo.
const options_ptr_t & get_options() const