/usr/include/trilinos/IterationPack_AlgorithmTracker.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 | // @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 ALGORITHM_TRACK_H
#define ALGORITHM_TRACK_H
#include <iosfwd>
#include "IterationPack_Types.hpp"
#include "Teuchos_RCP.hpp"
namespace IterationPack {
/** \brief Used to ouput iteration results and other information.
*
* This interface can be implemented by outside clients of an iterative
* algorithm to monitor or "track" the progress of the algorithm.
*
* ToDo: Write more documentation!
*/
class AlgorithmTracker {
public:
/** \brief . */
virtual ~AlgorithmTracker() {}
/** @name Public types */
//@{
/** \brief . */
typedef Teuchos::RCP<std::ostream> ostream_ptr_t;
//@}
/** @name Constructors */
//@{
/** \brief Construct with an output stream for journal_out.
*
* Preconditions:<ul>
* <li> <tt>journal_out.get() != NULL</tt> (throw <tt>std::invalid_argument</tt>).
* </ul>
*/
AlgorithmTracker(const ostream_ptr_t& journal_out);
//@}
/** @name Algorithm iteration state notification */
//@{
/** \brief Reinitialize the track object right before it is used.
*
* The default implementation does nothing.
*/
virtual void initialize();
/** \brief Output information about an iteration just completed.
*
* The default just does nothing.
*/
virtual void output_iteration(const Algorithm& algo) const;
/** \brief Output information about a just completed algorithm.
*
* The default just does nothing.
*/
virtual void output_final(const Algorithm& algo, EAlgoReturn algo_return) const;
//@}
/** @name Journal file access */
//@{
/** \brief Set a smart pointer to the journal file.
*/
virtual void set_journal_out(const ostream_ptr_t& journal_out);
/** \brief Get the smart pointer to the journal file.
*/
const ostream_ptr_t& get_journal_out() const;
/** \brief Return a reference to a <tt>std::ostream</tt> to be used to output debug information
* and the like.
*/
virtual std::ostream& journal_out() const;
//@}
private:
#ifndef DOXYGEN_COMPILE
ostream_ptr_t journal_out_;
#endif
// not defined and not to be called
AlgorithmTracker();
}; // end class AlgorithmTracker
} // end namespace IterationPack
#endif // ALGORITHM_TRACK_H
|