This file is indexed.

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

#include "MoochoPack_quasi_newton_stats.hpp"
#include "IterationPack_AlgorithmTracker.hpp"
#include "StopWatchPack_stopwatch.hpp"

namespace MoochoPack {

/** \brief This is a simple track class for getting statistics about a solved (or not
 * solved) NLP.
 *
 * When output_final(...) is called the output stream will have the following
 * written to it:
 *
 \begin{verbatim}
 status         =      solved; # solved, except, max_iter, max_run_time
 niter          =          10; # Number of rSQP iterations
 nfunc          =          15; # max( number f(x) evals, number c(x) evals ) 
 ngrad          =          13; # max( number Gf(x) evals, number Gc(x) evals ) 
 CPU            =        0.50; # Number of CPU seconds total
 obj_func       =    1.046e-2; # Objective function value f(x) at final point
 feas_kkt_err   =   2.457e-10; # Feasibility error at final point (scaled ||c(x)||inf)
 opt_kkt_err    =    4.568e-7; # Optimality error at final point (scaled ||rGL||inf)
 nact           =          40; # Number of total active constraints at the final point
 nbasis_change  =           1; # Number of basis changes
 nquasi_newton  =           6; # Number of quasi-newton updates
 \end{verbatim}
 *
 * Any statistic that is not known will be given the value '-'.  If the returned status
 * is 'execpt' then some exception was thrown or some other error occured so current
 * information may not be available.  In this case every effort is made to fill the rest
 * of the information from prior iterations.
 * The names of these fields will not change and the 'stat = value; # comment' format
 * can be counted.  However, the spacing and the precision of the numbers may be different
 * from what is shown above.
 */
class MoochoTrackerStatsStd
  : public IterationPack::AlgorithmTracker
 {
public:

  /// Construct with an output stream object.
  MoochoTrackerStatsStd( const ostream_ptr_t& o, const ostream_ptr_t& journal_out );

  /** \brief . */
  /* Set the output stream for statistics outputting.
   */
  void set_output_stream(const ostream_ptr_t& o);

  /// Get the output stream for statistics outputting.
  const ostream_ptr_t& get_output_stream() const;

  /** @name Overridden from AlgorithmTracker */
  //@{

  /// Restarts the timer
  void initialize();
  /** \brief . */
  void output_iteration(const Algorithm& algo) const;
  /** \brief . */
  void output_final(const Algorithm& algo, EAlgoReturn algo_return) const;

  //@}

protected:

  std::ostream& o() const
  {	return *o_; }

private:
  ostream_ptr_t                       o_;
  mutable int		                    num_QN_updates_;
  quasi_newton_stats_iq_member	    quasi_newton_stats_;
  mutable StopWatchPack::stopwatch    timer_;

  // Not defined and not to be called
  MoochoTrackerStatsStd();

};	// end class MoochoTrackerStatsStd

}	// end namespace MoochoPack 

#endif	// RSQP_TRACK_STATS_STD_H