MOOCHO (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MoochoPack_DampenCrossTermStd_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 DAMPEN_CROSS_TERM_STD_STEP_H
43 #define DAMPEN_CROSS_TERM_STD_STEP_H
44 
45 #include "rSQPAlgo_Step.h"
47 
48 namespace MoochoPack {
49 
75 class DampenCrossTermStd_Step : public rSQPAlgo_Step {
76 public:
77 
80 
82  DampenCrossTermStd_Step(const value_type& frac_descent = 0.9);
83 
84  // ////////////////////
85  // Overridden
86 
88  bool do_step(Algorithm& algo, poss_type step_poss, IterationPack::EDoStepType type
89  , poss_type assoc_step_poss);
90 
92  void print_step( const Algorithm& algo, poss_type step_poss, IterationPack::EDoStepType type
93  , poss_type assoc_step_poss, std::ostream& out, const std::string& leading_str ) const;
94 
95 }; // end class DampenCrossTermStd_Step
96 
97 } // end namespace MoochoPack
98 
99 #endif // DAMPEN_CROSS_TERM_STD_STEP_H
void print_step(const Algorithm &algo, poss_type step_poss, IterationPack::EDoStepType type, poss_type assoc_step_poss, std::ostream &out, const std::string &leading_str) const
std::ostream * out
STANDARD_MEMBER_COMPOSITION_MEMBERS(value_type, frac_descent)
«std comp» members for frac_descent
AbstractLinAlgPack::value_type value_type
Acts as the central hub for an iterative algorithm.
DampenCrossTermStd_Step(const value_type &frac_descent=0.9)
bool do_step(Algorithm &algo, poss_type step_poss, IterationPack::EDoStepType type, poss_type assoc_step_poss)
Compute a dampening term zeta_k for the cross term w_k such that Gf'*Z*pz <= 0.