Sacado_TemplateIterator.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//                           Sacado Package
//
// Copyright 2006 NTESS and the Sacado contributors.
// SPDX-License-Identifier: LGPL-2.1-or-later
// *****************************************************************************
// @HEADER

#ifndef SACADO_TEMPLATEITERATOR_HPP
#define SACADO_TEMPLATEITERATOR_HPP

#include <vector>
#include <iterator>

namespace Sacado {

  template <typename BaseT>
  class TemplateIterator : public std::iterator<std::input_iterator_tag,
                                                BaseT> {
  public:

    TemplateIterator(
      typename std::vector< Teuchos::RCP<BaseT> >::iterator p) :
      object_iterator(p) {}
    
    // No default constructor
    // Use default copy constructor and copy assignment

    bool operator==(const TemplateIterator& t) const {
      return object_iterator == t.objectIterator; 
    }

    bool operator!=(const TemplateIterator& t) const {
      return object_iterator != t.object_iterator; 
    }

    typename Sacado::TemplateIterator<BaseT>::reference 
    operator*() const {
      return *(*object_iterator);
    }

    typename Sacado::TemplateIterator<BaseT>::pointer 
    operator->() const {
      return &(*(*object_iterator));
    }

    TemplateIterator& operator++() {
      ++object_iterator;
      return *this;
    }

    TemplateIterator operator++(int) {
      TemplateIterator tmp = *this;
      ++(*this);
      return tmp;
    }

    Teuchos::RCP<BaseT> rcp() const {
      return *object_iterator;
    }

  private:

    typename std::vector< Teuchos::RCP<BaseT> >::iterator object_iterator;
    
  };

  template <typename BaseT>
  class ConstTemplateIterator : public std::iterator<std::input_iterator_tag,
                                                     BaseT> {
  public:

    ConstTemplateIterator(
       typename std::vector< Teuchos::RCP<BaseT> >::const_iterator p) :
      object_iterator(p) {}
    
    // No default constructor
    // Use default copy constructor and copy assignment

    bool operator==(const ConstTemplateIterator& t) const {
      return object_iterator == t.objectIterator; 
    }

    bool operator!=(const ConstTemplateIterator& t) const {
      return object_iterator != t.object_iterator; 
    }

    typename Sacado::ConstTemplateIterator<BaseT>::reference 
    operator*() const {
      return *(*object_iterator);
    }

    typename Sacado::ConstTemplateIterator<BaseT>::pointer 
    operator->() const {
      return &(*(*object_iterator));
    }

    ConstTemplateIterator& operator++() {
      ++object_iterator;
      return *this;
    }

    ConstTemplateIterator operator++(int) {
      ConstTemplateIterator tmp = *this;
      ++(*this);
      return tmp;
    }

    Teuchos::RCP<BaseT> rcp() const {
      return *object_iterator;
    }

  private:

    typename std::vector< Teuchos::RCP<BaseT> >::const_iterator object_iterator;
    
  };

}

#endif