MOOCHO (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MoochoPack_PreEvalNewPointBarrier_Step.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 PRE_EVAL_NEW_POINT_BARRIER_STEP_H
43 #define PRE_EVAL_NEW_POINT_BARRIER_STEP_H
44 
45 
49 
50 #include "MoochoPack_Types.hpp"
52 
55 
56 namespace MoochoPack {
57 
65  : public IterationPack::AlgorithmStep // doxygen needs full path
66  {
67  public:
68 
82  STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, relative_bound_push );
83 
97  STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, absolute_bound_push );
98 
102  bool do_step(Algorithm& algo, poss_type step_poss, IterationPack::EDoStepType type
103  , poss_type assoc_step_poss);
104 
105 
107  , poss_type assoc_step_poss, std::ostream& out, const std::string& leading_str ) const;
109 
113  const value_type relative_bound_push = 0.01,
114  const value_type absolute_bound_push = 0.001
115  );
117 
118  }; // end class PreEvalNewPointBarrier_Step
119 
122  public OptionsFromStreamPack::SetOptionsToTargetBase< PreEvalNewPointBarrier_Step >
123  {
124  public:
127  const char opt_grp_name[] = "PreEvalNewPointBarrier" );
128 
129  protected:
130 
132  void setOption( int option_num, const std::string& option_value );
133 
134  }; // end class PreEvalNewPointBarrier_StepSetOptions
135 
136 
137 } // end namespace MoochoPack
138 
139 #endif // PRE_EVAL_NEW_POINT_BARRIER_STEP_H
Base type for all objects that perform steps in an Algorithm.
void print_step(const IterationPack::Algorithm &algo, poss_type step_poss, IterationPack::EDoStepType type, poss_type assoc_step_poss, std::ostream &out, const std::string &leading_str) const
Called by Algorithm::print_algorithm() to print out what this step does in Matlab like format...
PreEvalNewPointBarrier_Step(const value_type relative_bound_push=0.01, const value_type absolute_bound_push=0.001)
Templated node class manipulating a reference to a target object who will have its options set...
bool do_step(Algorithm &algo, poss_type step_poss, IterationPack::EDoStepType type, poss_type assoc_step_poss)
std::ostream * out
PreEvalNewPointBarrier_StepSetOptions(PreEvalNewPointBarrier_Step *target=0, const char opt_grp_name[]="PreEvalNewPointBarrier")
STANDARD_MEMBER_COMPOSITION_MEMBERS(value_type, relative_bound_push)
relative fraction for initializing x within bounds. xl_sb = min(xl+relative_bound_push*(xu-xl), xl + absolute_bound_push) xu_sb = max(xu-relative_bound_push*(xu-xl), xu - absolute_bound_push) if (xl_sb > xu_sb) then x = (xl + (xu-xl)/2 else if (x < xl_sb) then x = xl_sb else if (x > xu_sb) then x = xu_sb
AbstractLinAlgPack::value_type value_type
Acts as the central hub for an iterative algorithm.
Standard evaluation step class for extra parameters in primal/dual barrier method.
void setOption(int option_num, const std::string &option_value)
Overridden from SetOptionsFromStreamNode.
const std::string & option_value(OptionsGroup::const_iterator &itr)