itkArray.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 itkArray_h
#define itkArray_h
 
#include "itkMacro.h"
 
#include "vxl_version.h"
#include "vnl/vnl_vector.h"
 
namespace itk
{
template <typename TValue>
class ITK_TEMPLATE_EXPORT Array : public vnl_vector<TValue>
{
public:
  using ValueType = TValue;
  using Self = Array;
  using VnlVectorType = vnl_vector<TValue>;
  using SizeValueType = typename vnl_vector<TValue>::size_type;
 
public:
  Array() = default;

  Array(const Array &);

  explicit Array(const VnlVectorType &);

  explicit Array(SizeValueType dimension);

  explicit Array(SizeValueType dimension, const ValueType & value);

  Array(TValue * datain, SizeValueType sz, bool LetArrayManageMemory = false);
 
#if defined(ITK_LEGACY_REMOVE)
  Array(const TValue * datain, SizeValueType sz);
 
#else // defined ( ITK_LEGACY_REMOVE )
  Array(const TValue * datain, SizeValueType sz, bool LetArrayManageMemory = false);
#endif

  template <typename TArrayValue>
  Array(const Array<TArrayValue> & r)
  {
    this->SetSize(r.GetSize());
    for (SizeValueType i = 0; i < r.GetSize(); ++i)
    {
      this->operator[](i) = static_cast<TValue>(r[i]);
    }
  }

  void
  Fill(const TValue & v)
  {
    this->fill(v);
  }

  Self &
  operator=(const Self & rhs);
 
  Self &
  operator=(const VnlVectorType & rhs);

  [[nodiscard]] SizeValueType
  Size() const
  {
    return static_cast<SizeValueType>(this->size());
  }
  [[nodiscard]] unsigned int
  GetNumberOfElements() const
  {
    return static_cast<SizeValueType>(this->size());
  }

  [[nodiscard]] const TValue &
  GetElement(SizeValueType i) const
  {
    return this->operator[](i);
  }

  void
  SetElement(SizeValueType i, const TValue & value)
  {
    this->operator[](i) = value;
  }

  void
  SetSize(SizeValueType sz);
 
  [[nodiscard]] SizeValueType
  GetSize() const
  {
    return static_cast<SizeValueType>(this->size());
  }

  void
  SetDataSameSize(TValue * datain, bool LetArrayManageMemory = false);

  void
  SetData(TValue * datain, SizeValueType sz, bool LetArrayManageMemory = false);

  ~Array() override;
 
#if !defined(ITK_LEGACY_REMOVE)
  void
  swap(Array & other)
  {
    this->Swap(other);
  }
#endif
 
  void
  Swap(Array & other) noexcept
  {
    using std::swap;
    this->VnlVectorType::swap(other);
    swap(this->m_LetArrayManageMemory, other.m_LetArrayManageMemory);
  }
 
private:
  bool m_LetArrayManageMemory{ true };
};
 
// Deduction guide to avoid compiler warnings (-wctad-maybe-unsupported) when using class template argument deduction.
template <typename TValue>
Array(TValue *, typename vnl_vector<TValue>::size_type, bool) -> Array<TValue>;
 
template <typename TValue>
std::ostream &
operator<<(std::ostream & os, const Array<TValue> & arr)
{
  os << '[';
  const unsigned int length = arr.size();
  if (length >= 1)
  {
    const unsigned int last = length - 1;
    for (unsigned int i = 0; i < last; ++i)
    {
      os << arr[i] << ", ";
    }
    os << arr[last];
  }
  os << ']';
  return os;
}
 
// declaration of specialization
template <>
ITKCommon_EXPORT std::ostream & operator<< <double>(std::ostream & os, const Array<double> & arr);
template <>
ITKCommon_EXPORT std::ostream & operator<< <float>(std::ostream & os, const Array<float> & arr);
 
 
template <typename T>
inline void
swap(Array<T> & a, Array<T> & b) noexcept
{
  a.Swap(b);
}
 
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkArray.hxx"
#endif
 
#endif