This file is indexed.

/usr/include/trilinos/MoochoPack_UpdateBarrierParameter_Step.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
// @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 UPDATE_BARRIER_PARAMETER_STEP_H
#define UPDATE_BARRIER_PARAMETER_STEP_H

#include "MoochoPack_Types.hpp"
#include "IterationPack_AlgorithmStep.hpp"
#include "Teuchos_StandardCompositionMacros.hpp"
#include "Teuchos_StandardMemberCompositionMacros.hpp"

#include "OptionsFromStreamPack_SetOptionsFromStreamNode.hpp"
#include "OptionsFromStreamPack_SetOptionsToTargetBase.hpp"

namespace MoochoPack {

/** \brief Barrier Parameter (mu) Update 
 *
 * This class updates barrier_parameter & e_tol for next iteration
 *
 */

class UpdateBarrierParameter_Step
  : public IterationPack::AlgorithmStep // doxygen needs full path
  {
  public:

    /** @name Constructors / initializers */
    //@{

    /** \brief Initial barrier parameter
     *
     * mu_kp1 = min(tau_mu*mu_k,mu_k^theta_mu)
     */
    STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, init_barrier_parameter );

    /** \brief barrier_parameter decrease fraction (linear decrease)
     *
     * mu_kp1 = min(tau_mu*mu_k,mu_k^theta_mu)
     */
    STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, tau_mu );

    /** \brief barrier_parameter decrease power (for superlinear decrease)
     *
     * mu_kp1 = min(tau_mu*mu_k,mu_k^theta_mu)
     */
    STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, theta_mu );

    /** \brief error tolerance fraction
     *
     * e_tol = min( e_tol_max, tau_epsilon*min(mu_k,mu_k^theta_epsilon))
     */
    STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, tau_epsilon );

    /** \brief error tolerance power
     *
     * e_tol = min( e_tol_max, tau_epsilon*min(mu_k,mu_k^theta_epsilon))
     */
    STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, theta_epsilon );

    /** \brief maximum error tolerance
     *
     */
    STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, e_tol_max );

    /** \brief Constructor.
     */
    UpdateBarrierParameter_Step(
      const value_type init_barrier_parameter = 0.1,
      const value_type tau_mu = 0.2,
      const value_type theta_mu = 1.5,
      const value_type tau_epsilon = 10,
      const value_type theta_epsilon = 1.1,
      const value_type e_tol_max = 1000
      );
    //@}

    /** @name Overridden from AlgorithmStep */
    //@{
    /** \brief . */
    bool do_step(Algorithm& algo, poss_type step_poss, IterationPack::EDoStepType type
           , poss_type assoc_step_poss);
    
    
    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;
    //@}

  private:
    value_type Calculate_e_tol(value_type mu);

  }; // end class UpdateBarrierParameter_Step


class UpdateBarrierParameter_StepSetOptions
  : public OptionsFromStreamPack::SetOptionsFromStreamNode,
    public OptionsFromStreamPack::SetOptionsToTargetBase< UpdateBarrierParameter_Step >
  {
  public:
    UpdateBarrierParameter_StepSetOptions(
      UpdateBarrierParameter_Step* target = 0,
      const char opt_grp_name[] = "UpdateBarrierParameter" );

  protected:

    /// Overridden from SetOptionsFromStreamNode
    void setOption( int option_num, const std::string& option_value );
  
  };	// end class UpdateBarrierParameter_StepSetOptions

} // end namespace MoochoPack

#endif // #if !defined UPDATE_BARRIER_PARAMETER_STEP_H