IterationPack_AlgorithmTracker.hpp

// @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 {

class AlgorithmTracker {
public:

  virtual ~AlgorithmTracker() {}


  typedef Teuchos::RCP<std::ostream>    ostream_ptr_t;



  AlgorithmTracker(const ostream_ptr_t& journal_out);
  
  
  
  virtual void initialize();

  virtual void output_iteration(const Algorithm& algo) const;

  virtual void output_final(const Algorithm& algo, EAlgoReturn algo_return) const;



  virtual void set_journal_out(const ostream_ptr_t& journal_out);

  const ostream_ptr_t& get_journal_out() const;

  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

---