IterationPack_AlgorithmState.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.
// 
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
// 
// ***********************************************************************
// @HEADER

#ifndef ALGORITHM_STATE_H
#define ALGORITHM_STATE_H

#include <limits>
#include <vector>
#include <map>
#include <string>
#include <sstream>
#include <iosfwd>

#include "IterationPack_IterQuantity.hpp"
#include "Teuchos_RCP.hpp"

namespace IterationPack {

class AlgorithmState {
public:


  typedef size_t                          iq_id_type;
  typedef Teuchos::RCP<IterQuantity>    IQ_ptr;
  enum { DOES_NOT_EXIST = INT_MAX }; // should not ever be this many insertions.

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

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


  virtual ~AlgorithmState() {}


  explicit AlgorithmState(size_t reserve_size = 0);



  void k(int k);
  int k() const;
  int incr_k();


  
  virtual size_t num_iter_quant() const;

  virtual iq_id_type set_iter_quant(const std::string& iq_name, const IQ_ptr& iq);

  virtual void erase_iter_quant(const std::string& iq_name);

  virtual iq_id_type get_iter_quant_id(const std::string& iq_name) const;

  virtual IQ_ptr& get_iter_quant(iq_id_type iq_id);

  virtual const IQ_ptr& get_iter_quant(iq_id_type iq_id) const;



  virtual IterQuantity& iter_quant(const std::string& iq_name );
  virtual const IterQuantity& iter_quant(const std::string& iq_name ) const;
  virtual IterQuantity& iter_quant(iq_id_type iq_id);
  virtual const IterQuantity& iter_quant(iq_id_type iq_id) const;



  virtual void next_iteration(bool incr_k = true);



  virtual void dump_iter_quant(std::ostream& out) const;


private:
  // ///////////////////////////////////////////////////////////
  // Private types

  typedef std::vector<IQ_ptr>         iq_t;
  typedef std::map<std::string,iq_id_type>  iq_name_to_id_t;

  // ///////////////////////////////////////////////////////////
  // Private data members

  int k_;   // Iteration counter.

  iq_t          iq_;
  // Array of RCP objects that point to set iteration quantities.
  // The index into this array is the iq_id for an IQ object.  This array
  // is filled sequantially from the beginning using push_back(...).
  // When erase_iter_quant(...) is called the iq_[iq_id] is set to null which
  // reduces the reference count of the IQ object (possible deleing it if
  // there are no other references).  Then if the user tries to access and
  // IQ object with this abandonded iq_id, the dereferencing operator for
  // RCP<...> will throw an exception.
#ifdef DOXYGEN_COMPILE
  IterQuantity  *iteration_quantities;
#endif

  iq_name_to_id_t     iq_name_to_id_;
  // Mapping of an IQ name to its id.

  // ///////////////////////////////////////////////////////////
  // Private member functions
  
  iq_name_to_id_t::iterator find_and_assert(const std::string& iq_name);
  iq_name_to_id_t::const_iterator find_and_assert(const std::string& iq_name) const;

};  // end class AlgorithmState

// /////////////////////////////////////////////////////////////////////////////////
// Inline member definitions for AlgorithmState

inline
AlgorithmState::AlgorithmState(size_t reserve_size)
  : k_(0)
{ iq_.reserve(reserve_size); }

// iteration counter

inline
void AlgorithmState::k(int k)
{ k_ = k; }

inline
int AlgorithmState::k() const
{ return k_; }

inline
int AlgorithmState::incr_k()
{ return ++k_; }

// 

inline
size_t AlgorithmState::num_iter_quant() const {
  return iq_name_to_id_.size();
}

inline
AlgorithmState::iq_id_type AlgorithmState::get_iter_quant_id(
  const std::string& iq_name) const
{
  const iq_name_to_id_t::const_iterator itr = iq_name_to_id_.find(iq_name);
  return itr == iq_name_to_id_.end() ? DOES_NOT_EXIST : (*itr).second;
}

inline
AlgorithmState::IQ_ptr& AlgorithmState::get_iter_quant(iq_id_type iq_id) {
  return iq_.at(iq_id);
}

inline
const AlgorithmState::IQ_ptr& AlgorithmState::get_iter_quant(
  iq_id_type iq_id) const
{
  return iq_.at(iq_id);
}

inline
IterQuantity& AlgorithmState::iter_quant(const std::string& iq_name ) {
  return *iq_[(*find_and_assert(iq_name)).second];
}

inline
const IterQuantity& AlgorithmState::iter_quant(const std::string& iq_name ) const {
  return *iq_[(*find_and_assert(iq_name)).second];
}

} // end namespace IterationPack 

#endif // ALGORITHM_STATE_H