/usr/include/trilinos/MoochoPack_CheckConvergence_Strategy.hpp is in libtrilinos-dev 10.4.0.dfsg-1ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 | // @HEADER
// ***********************************************************************
//
// Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
// Copyright (2003) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov)
//
// ***********************************************************************
// @HEADER
#ifndef CHECK_CONVERGENCE_STRATEGY_H
#define CHECK_CONVERGENCE_STRATEGY_H
#include "MoochoPack_Types.hpp"
#include "Teuchos_StandardMemberCompositionMacros.hpp"
#include "OptionsFromStreamPack_SetOptionsFromStreamNode.hpp"
#include "OptionsFromStreamPack_SetOptionsToTargetBase.hpp"
namespace MoochoPack {
/** \brief Strategy interface for performing convergence checks.
*
* This object can not change the flow of control or do anything fancy. It just
* checks convergence by calculating norm errors and comparing with tolerance
* It can update iteration quantities if desired.
*
* See the printed documentation generated by \c this->print_step().
*/
class CheckConvergence_Strategy
{
public:
enum EOptErrorCheck
{
OPT_ERROR_REDUCED_GRADIENT_LAGR,
OPT_ERROR_GRADIENT_LAGR
};
/** \brief <<std member comp>> members for whether to check the reduced
* or full gradient of the Lagrangian.
*/
STANDARD_MEMBER_COMPOSITION_MEMBERS( EOptErrorCheck, opt_error_check );
enum EScaleKKTErrorBy
{
SCALE_BY_ONE,
SCALE_BY_NORM_2_X,
SCALE_BY_NORM_INF_X
};
/** \brief <<std member comp>> members for how the optimality condition should
* be scaled
*/
STANDARD_MEMBER_COMPOSITION_MEMBERS( EScaleKKTErrorBy, scale_opt_error_by );
/** \brief <<std member comp>> members for how the feasibility condition should
* be scaled
*/
STANDARD_MEMBER_COMPOSITION_MEMBERS( EScaleKKTErrorBy, scale_feas_error_by );
/** \brief <<std member comp>> members for how the complimentarity condition should
* be scaled
*/
STANDARD_MEMBER_COMPOSITION_MEMBERS( EScaleKKTErrorBy, scale_comp_error_by );
/** \brief <<std member comp>> members for whether the optimality conditions
* should be scaled by the
*/
STANDARD_MEMBER_COMPOSITION_MEMBERS( bool, scale_opt_error_by_Gf );
/** \brief . */
CheckConvergence_Strategy(
EOptErrorCheck opt_error_check = OPT_ERROR_REDUCED_GRADIENT_LAGR,
EScaleKKTErrorBy scale_opt_error_by = SCALE_BY_ONE,
EScaleKKTErrorBy scale_feas_error_by = SCALE_BY_ONE,
EScaleKKTErrorBy scale_comp_error_by = SCALE_BY_ONE,
bool scale_opt_error_by_Gf = true
);
/** \brief . */
virtual bool Converged( Algorithm& _algo)=0;
/** \brief . */
virtual void print_step( const Algorithm& _algo, std::ostream& out, const std::string& L ) const =0;
}; // end interface CheckConvergence_Strategy
/** \brief Set options for CheckConvergence_Strategy from an
* OptionsFromStream object.
*
* The default options group name is CheckConvergenceStrategy.
*
* The options group is:
*
\begin{verbatim}
options_group CheckConvergenceStrategy {
scale_kkt_error_by = SCALE_BY_ONE;
scale_opt_error_by_Gf = true;
}
\end{verbatim}
*
* \begin{description}
* \item[scale_kkt_error_by] Determines if and how the optimality (opt_kkt_err)
* and feasiblity (feas_kkt_err)
* errors for the convergence check are scaled by for the unkowns x before
* comparing it to the set tolerances of opt_tol and feas_tol (see the
* class \Ref{CheckConvergenceStd_AddedStep} and its printed algorithm
* for more details).
* \begin{description}
* \item[SCALE_BY_ONE] no scaling by x
* \item[SCALE_BY_NORM_2_X] scale opt_kkt_err and feas_kkt_err by 1/||x||2
* \item[SCALE_BY_NORM_INF_X] scale opt_kkt_err and feas_kkt_err by 1/||x||inf
* \end{description}
* \item[scale_opt_error_by_Gf] Determines if opt_kkt_err is scaled by
* ||Gf_k||inf or not.
* \end{description}
*/
class CheckConvergence_StrategySetOptions
: public OptionsFromStreamPack::SetOptionsFromStreamNode,
public OptionsFromStreamPack::SetOptionsToTargetBase<
CheckConvergence_Strategy >
{
public:
/** \brief . */
CheckConvergence_StrategySetOptions(
CheckConvergence_Strategy* target = 0
, const char opt_grp_name[] = "CheckConvergenceStrategy" );
protected:
/// Overridden from SetOptionsFromStreamNode
void setOption( int option_num, const std::string& option_value );
}; // end class CheckConvergence_Strategy
} // end namespace MoochoPack
#endif // CHECK_CONVERGENCE_STRATEGY_H
|