itkVectorContainer.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  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
 *
 *         https://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 <type_traits> // For is_void_v.
#include <utility>
#include <vector>
 
namespace itk
{
namespace detail
{
template <typename TElementIdentifier, typename TElement>
class ITK_TEMPLATE_EXPORT VectorContainer
  : public Object
  , private std::vector<TElement>
{
public:
  using Self = VectorContainer;
  using Superclass = Object;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  using ElementIdentifier = TElementIdentifier;
  using Element = TElement;
 
private:
  using VectorType = std::vector<Element>;
  using VectorIterator = typename VectorType::iterator;
  using VectorConstIterator = typename VectorType::const_iterator;
 
public:
  using STLContainerType = VectorType;
 
  itkNewMacro(Self);
 
  itkOverrideGetNameOfClassMacro(VectorContainer);
 
  class Iterator;
  class ConstIterator;
 
  STLContainerType &
  CastToSTLContainer() noexcept
  {
    return *this;
  }
 
  const STLContainerType &
  CastToSTLConstContainer() const noexcept
  {
    return *this;
  }
 
  using STLContainerType::begin;
  using STLContainerType::end;
  using STLContainerType::rbegin;
  using STLContainerType::rend;
  using STLContainerType::cbegin;
  using STLContainerType::cend;
  using STLContainerType::crbegin;
  using STLContainerType::crend;
 
  using STLContainerType::size;
  using STLContainerType::max_size;
  using STLContainerType::resize;
  using STLContainerType::capacity;
  using STLContainerType::empty;
  using STLContainerType::reserve;
  using STLContainerType::shrink_to_fit;
 
  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;
  using typename 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:
    using iterator_category = typename VectorIterator::iterator_category;
    using value_type = typename VectorIterator::value_type;
    using difference_type = typename VectorIterator::difference_type;
    using pointer = typename VectorIterator::pointer;
    using reference = typename VectorIterator::reference;
 
    Iterator() = default;
    Iterator(size_type d, const VectorIterator & i)
      : m_Pos(d)
      , m_Iter(i)
    {}
    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;
    }
 
    ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION(Iterator);
 
    bool
    operator==(const ConstIterator & r) const
    {
      return m_Iter == r.m_Iter;
    }
 
    ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION(ConstIterator);
 
    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() const
    {
      return static_cast<ElementIdentifier>(m_Pos);
    }
 
    reference
    Value() const
    {
      return *m_Iter;
    }
 
  private:
    size_type      m_Pos{};
    VectorIterator m_Iter{};
    friend class ConstIterator;
  };
 
  class ConstIterator
  {
  public:
    using iterator_category = typename VectorConstIterator::iterator_category;
    using value_type = typename VectorConstIterator::value_type;
    using difference_type = typename VectorConstIterator::difference_type;
    using pointer = typename VectorConstIterator::pointer;
    using reference = typename VectorConstIterator::reference;
 
    ConstIterator() = default;
    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;
    }
 
    ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION(Iterator);
 
    bool
    operator==(const ConstIterator & r) const
    {
      return m_Iter == r.m_Iter;
    }
 
    ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION(ConstIterator);
 
    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() const
    {
      return static_cast<ElementIdentifier>(m_Pos);
    }
 
    const_reference
    Value() const
    {
      return *m_Iter;
    }
 
  private:
    size_type           m_Pos{};
    VectorConstIterator m_Iter{};
    friend class Iterator;
  };
 
  /* Declare the public interface routines. */
 
  reference ElementAt(ElementIdentifier);
 
  const_reference ElementAt(ElementIdentifier) const;
 
  reference 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();
 
protected:
  VectorContainer() = default;
  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.CastToSTLConstContainer())
  {}
  template <typename TInputIterator>
  VectorContainer(TInputIterator first, TInputIterator last)
    : Object()
    , VectorType(first, last)
  {}
};
} // namespace detail
template <typename T1, typename T2 = void>
using VectorContainer = detail::VectorContainer<std::conditional_t<std::is_void_v<T2>, SizeValueType, T1>,
                                                std::conditional_t<std::is_void_v<T2>, T1, T2>>;
 
 
template <typename TElement>
auto
MakeVectorContainer(std::vector<TElement> stdVector)
{
  auto vectorContainer = VectorContainer<TElement>::New();
  vectorContainer->CastToSTLContainer() = std::move(stdVector);
  return vectorContainer;
}
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkVectorContainer.hxx"
#endif
 
#endif