IterationPack_IterQuantity.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
//
// Change Log:
//  11/18/99:
//    * last_updated() Added
//    * set_not_updated(k) Added

#ifndef ITER_QUANTITY_H
#define ITER_QUANTITY_H

#include <stdexcept>
#include <string>
#include <iomanip>
#include <limits>

#include "IterationPack_Types.hpp"

namespace IterationPack {

class IterQuantity {
public:


  enum { NONE_UPDATED = INT_MIN };

  class NoStorageAvailable : public std::logic_error
  {public: NoStorageAvailable(const std::string& what_arg) : std::logic_error(what_arg) {}};

  class QuanityNotSet : public std::logic_error
  {public: QuanityNotSet(const std::string& what_arg) : std::logic_error(what_arg) {}};
  


  // Virtual destructor
  virtual ~IterQuantity() {}

  // Clone this iteration quantity
  virtual IterQuantity* clone() const = 0;



  virtual const char* name() const = 0; 
  
  virtual bool has_storage_k(int offset) const = 0;
  
  virtual bool updated_k(int offset) const = 0;

  virtual int last_updated() const = 0;

  virtual bool will_loose_mem(int offset, int set_offset) const = 0;



  virtual void set_not_updated_k(int offset) = 0;

  virtual void set_all_not_updated() = 0;



  virtual void next_iteration() = 0;



  virtual void print_concrete_type( std::ostream& out ) const = 0;



  void assert_has_storage_k(int offset) const;

  void assert_updated_k(int offset) const;


};  // end class IterQuantity 

} // end namespace IterationPack

#endif  // ITER_QUANTITY_H