itkVectorContainer.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef itkVectorContainer_h
#define itkVectorContainer_h

#include "itkObject.h"
#include "itkObjectFactory.h"

#include <utility>
#include <vector>

namespace itk
{
template<
  typename TElementIdentifier,
  typename TElement
  >
class VectorContainer:
  public Object,
  private std::vector< TElement >
{
public:
  typedef VectorContainer            Self;
  typedef Object                     Superclass;
  typedef SmartPointer< Self >       Pointer;
  typedef SmartPointer< const Self > ConstPointer;

  typedef TElementIdentifier ElementIdentifier;
  typedef TElement           Element;

private:
  typedef std::vector< Element >              VectorType;
  typedef typename VectorType::size_type      size_type;
  typedef typename VectorType::iterator       VectorIterator;
  typedef typename VectorType::const_iterator VectorConstIterator;

protected:
  VectorContainer():
    Object(), VectorType() {}
  VectorContainer(size_type n):
    Object(), VectorType(n) {}
  VectorContainer(size_type n, const Element & x):
    Object(), VectorType(n, x) {}
  VectorContainer(const Self & r):
    Object(), VectorType(r) {}
  template< typename TInputIterator >
  VectorContainer(TInputIterator first, TInputIterator last):
    Object(), VectorType(first, last) {}

public:

  typedef VectorType                     STLContainerType;

  itkNewMacro(Self);

  itkTypeMacro(VectorContainer, Object);

  class Iterator;
  class ConstIterator;

  STLContainerType & CastToSTLContainer()
  {
    return dynamic_cast< STLContainerType & >( *this );
  }

  const STLContainerType & CastToSTLConstContainer() const
  {
    return dynamic_cast< const STLContainerType & >( *this );
  }

  using STLContainerType::begin;
  using STLContainerType::end;
  using STLContainerType::rbegin;
  using STLContainerType::rend;

  using STLContainerType::size;
  using STLContainerType::max_size;
  using STLContainerType::resize;
  using STLContainerType::capacity;
  using STLContainerType::empty;
  using STLContainerType::reserve;

  using STLContainerType::operator[];
  using STLContainerType::at;
  using STLContainerType::front;
  using STLContainerType::back;

  using STLContainerType::assign;
  using STLContainerType::push_back;
  using STLContainerType::pop_back;
  using STLContainerType::insert;
  using STLContainerType::erase;
  using STLContainerType::swap;
  using STLContainerType::clear;

  using STLContainerType::get_allocator;

  using typename STLContainerType::reference;
  using typename STLContainerType::const_reference;
  using typename STLContainerType::iterator;
  using typename STLContainerType::const_iterator;
  // already declared before
  // using STLContainerType::size_type;
  using typename STLContainerType::difference_type;
  using typename STLContainerType::value_type;
  using typename STLContainerType::allocator_type;
  using typename STLContainerType::pointer;
  using typename STLContainerType::const_pointer;
  using typename STLContainerType::reverse_iterator;
  using typename STLContainerType::const_reverse_iterator;

  friend class Iterator;
  friend class ConstIterator;

  class Iterator
  {
public:
    typedef typename VectorIterator::iterator_category iterator_category;
    typedef typename VectorIterator::value_type        value_type;
    typedef typename VectorIterator::difference_type   difference_type;
    typedef typename VectorIterator::pointer           pointer;
    typedef typename VectorIterator::reference         reference;

    Iterator() : m_Pos(0) {}
    Iterator(size_type d, const VectorIterator & i):m_Pos(d), m_Iter(i) {}
    Iterator(const Iterator & r): m_Pos(r.m_Pos), m_Iter(r.m_Iter) {}
    Iterator & operator*()    { return *this; }
    Iterator * operator->()   { return this; }
    Iterator & operator++()   { ++m_Pos; ++m_Iter; return *this; }
    Iterator operator++(int) { Iterator temp(*this); ++m_Pos; ++m_Iter; return temp; }
    Iterator & operator--()   { --m_Pos; --m_Iter; return *this; }
    Iterator operator--(int) { Iterator temp(*this); --m_Pos; --m_Iter; return temp; }

    difference_type operator-(const Iterator & r) const { return static_cast< difference_type >( this->m_Pos ) - static_cast< difference_type >( r.m_Pos ); }

    bool operator==(const Iterator & r) const { return m_Iter == r.m_Iter; }
    bool operator!=(const Iterator & r) const { return m_Iter != r.m_Iter; }
    bool operator==(const ConstIterator & r) const { return m_Iter == r.m_Iter; }
    bool operator!=(const ConstIterator & r) const { return m_Iter != r.m_Iter; }
    bool operator<(const Iterator & r) const { return ( this->operator-( r ) ) < 0; }
    bool operator>(const Iterator & r) const { return ( r < *this ); }
    bool operator>=(const Iterator & r) const { return !( *this < r ); }
    bool operator<=(const Iterator & r) const { return !( *this < r ); }

    Iterator & operator+=(difference_type n) { m_Pos += n; m_Iter += n; return *this; };

    ElementIdentifier Index(void) const { return static_cast< ElementIdentifier >( m_Pos ); }

    Element & Value(void) const { return *m_Iter; }

private:
    size_type      m_Pos;
    VectorIterator m_Iter;
    friend class ConstIterator;
  };

  class ConstIterator
  {
public:
    typedef typename VectorConstIterator::iterator_category iterator_category;
    typedef typename VectorConstIterator::value_type        value_type;
    typedef typename VectorConstIterator::difference_type   difference_type;
    typedef typename VectorConstIterator::pointer           pointer;
    typedef typename VectorConstIterator::reference         reference;

    ConstIterator():m_Pos(0) {}
    ConstIterator(size_type d, const VectorConstIterator & i):m_Pos(d), m_Iter(i) {}
    ConstIterator(const Iterator & r) : m_Pos( r.m_Pos ), m_Iter( r.m_Iter ) { }
    ConstIterator & operator*()    { return *this; }
    ConstIterator * operator->()   { return this; }
    ConstIterator & operator++()   { ++m_Pos; ++m_Iter; return *this; }
    ConstIterator operator++(int) { ConstIterator temp(*this); ++m_Pos; ++m_Iter; return temp; }
    ConstIterator & operator--()   { --m_Pos; --m_Iter; return *this; }
    ConstIterator operator--(int) { ConstIterator temp(*this); --m_Pos; --m_Iter; return temp; }
    ConstIterator & operator=(const Iterator & r) { m_Pos = r.m_Pos; m_Iter = r.m_Iter; return *this; }
    ConstIterator & operator+=(difference_type n) { m_Pos += n; m_Iter += n; return *this; };

    difference_type operator-(const ConstIterator & r) const { return static_cast< difference_type >( m_Pos ) - static_cast< difference_type >( r.m_Pos ); }

    bool operator==(const Iterator & r) const { return m_Iter == r.m_Iter; }
    bool operator!=(const Iterator & r) const { return m_Iter != r.m_Iter; }
    bool operator==(const ConstIterator & r) const { return m_Iter == r.m_Iter; }
    bool operator!=(const ConstIterator & r) const { return m_Iter != r.m_Iter; }
    bool operator<(const ConstIterator & r) const { return ( this->operator-(r) < 0 ); }
    bool operator>(const ConstIterator & r) const { return ( r < *this ); }
    bool operator<=(const ConstIterator & r) const { return !( *this > r ); }
    bool operator>=(const ConstIterator & r) const { return !( *this < r ); }


    ElementIdentifier Index(void) const { return static_cast< ElementIdentifier >( m_Pos ); }

    const Element & Value(void) const { return *m_Iter; }

private:
    size_type           m_Pos;
    VectorConstIterator m_Iter;
    friend class Iterator;
  };

  /* Declare the public interface routines. */

  Element & ElementAt(ElementIdentifier);

  const Element & ElementAt(ElementIdentifier) const;

  Element & CreateElementAt(ElementIdentifier);

  Element GetElement(ElementIdentifier) const;

  void SetElement(ElementIdentifier, Element);

  void InsertElement(ElementIdentifier, Element);

  bool IndexExists(ElementIdentifier) const;

  bool GetElementIfIndexExists(ElementIdentifier, Element *) const;

  void CreateIndex(ElementIdentifier);

  void DeleteIndex(ElementIdentifier);

  ConstIterator Begin() const;

  ConstIterator End() const;

  Iterator Begin();

  Iterator End();

  ElementIdentifier Size() const;

  void Reserve(ElementIdentifier);

  void Squeeze();

  void Initialize();
};
} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkVectorContainer.hxx"
#endif

#endif