itkVector.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 itkVector_h
#define itkVector_h
 
#include "itkFixedArray.h"
 
#include "vnl/vnl_vector_ref.h" // GetVnlVector method return
 
namespace itk
{
template <typename T, unsigned int VVectorDimension = 3>
class ITK_TEMPLATE_EXPORT Vector : public FixedArray<T, VVectorDimension>
{
public:
  using Self = Vector;
  using Superclass = FixedArray<T, VVectorDimension>;

  using ValueType = T;
  using RealValueType = typename NumericTraits<ValueType>::RealType;

  static constexpr unsigned int Dimension = VVectorDimension;

  using VectorType = Self;

  using ComponentType = T;

  using BaseArray = FixedArray<T, VVectorDimension>;

  static unsigned int
  GetVectorDimension()
  {
    return VVectorDimension;
  }

  void
  SetVnlVector(const vnl_vector<T> &);

  vnl_vector_ref<T>
  GetVnlVector();

  vnl_vector<T>
  GetVnlVector() const;

  Vector() = default;
 
#if !defined(ITK_LEGACY_REMOVE)
  Vector(const ValueType & r);
#else

  explicit Vector(const ValueType & r);

  Vector(std::nullptr_t) = delete;
#endif

  template <typename TVectorValueType>
  Vector(const Vector<TVectorValueType, VVectorDimension> & r)
    : BaseArray(r)
  {}
  Vector(const ValueType r[Dimension])
    : BaseArray(r)
  {}
  template <typename TVectorValueType>
  Vector(const TVectorValueType r[Dimension])
    : BaseArray(r)
  {}


  explicit Vector(const std::array<ValueType, VVectorDimension> & stdArray)
    : BaseArray(stdArray)
  {}

  template <typename TVectorValueType>
  Vector &
  operator=(const Vector<TVectorValueType, VVectorDimension> & r)
  {
    BaseArray::operator=(r);
    return *this;
  }
 
  Vector &
  operator=(const ValueType r[VVectorDimension]);

  template <typename Tt>
  inline const Self &
  operator*=(const Tt & value)
  {
    for (unsigned int i = 0; i < VVectorDimension; ++i)
    {
      (*this)[i] = static_cast<ValueType>((*this)[i] * value);
    }
    return *this;
  }

  template <typename Tt>
  inline const Self &
  operator/=(const Tt & value)
  {
    for (unsigned int i = 0; i < VVectorDimension; ++i)
    {
      (*this)[i] = static_cast<ValueType>((*this)[i] / value);
    }
    return *this;
  }

  const Self &
  operator+=(const Self & vec);

  const Self &
  operator-=(const Self & vec);

  Self
  operator-() const;

  Self
  operator+(const Self & vec) const;

  Self
  operator-(const Self & vec) const;

  ValueType
  operator*(const Self & other) const;

  inline Self
  operator*(const ValueType & value) const
  {
    Self result;
 
    for (unsigned int i = 0; i < VVectorDimension; ++i)
    {
      result[i] = static_cast<ValueType>((*this)[i] * value);
    }
    return result;
  }

  template <typename Tt>
  inline Self
  operator/(const Tt & value) const
  {
    Self result;
 
    for (unsigned int i = 0; i < VVectorDimension; ++i)
    {
      result[i] = static_cast<ValueType>((*this)[i] / value);
    }
    return result;
  }

  bool
  operator==(const Self & v) const
  {
    return Superclass::operator==(v);
  }
 
  ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION(Self);

  RealValueType
  GetNorm() const;

  RealValueType
  GetSquaredNorm() const;

  static unsigned int
  GetNumberOfComponents()
  {
    return VVectorDimension;
  }

  RealValueType
  Normalize();
 
  void
  SetNthComponent(int c, const ComponentType & v)
  {
    this->operator[](c) = v;
  }

  template <typename TCoordinateB>
  void
  CastFrom(const Vector<TCoordinateB, VVectorDimension> & pa)
  {
    for (unsigned int i = 0; i < VVectorDimension; ++i)
    {
      (*this)[i] = static_cast<T>(pa[i]);
    }
  }
 
  template <typename TCoordinateB>
  operator Vector<TCoordinateB, VVectorDimension>()
  {
    Vector<TCoordinateB, VVectorDimension> r;
    for (unsigned int i = 0; i < VVectorDimension; ++i)
    {
      r[i] = static_cast<TCoordinateB>((*this)[i]);
    }
    return r;
  }
};

template <typename T, unsigned int VVectorDimension>
inline Vector<T, VVectorDimension>
operator*(const T & scalar, const Vector<T, VVectorDimension> & v)
{
  return v.operator*(scalar);
}

template <typename T, unsigned int VVectorDimension>
std::ostream &
operator<<(std::ostream & os, const Vector<T, VVectorDimension> & vct);

template <typename T, unsigned int VVectorDimension>
std::istream &
operator>>(std::istream & is, Vector<T, VVectorDimension> & vct);
 
ITKCommon_EXPORT Vector<double, 3>
                 CrossProduct(const Vector<double, 3> &, const Vector<double, 3> &);
 
ITKCommon_EXPORT Vector<float, 3>
                 CrossProduct(const Vector<float, 3> &, const Vector<float, 3> &);
 
ITKCommon_EXPORT Vector<int, 3>
                 CrossProduct(const Vector<int, 3> &, const Vector<int, 3> &);
 
 
template <typename T, unsigned int VVectorDimension>
inline void
swap(Vector<T, VVectorDimension> & a, Vector<T, VVectorDimension> & b) noexcept
{
  a.swap(b);
}
 

template <typename TValue, typename... TVariadic>
auto
MakeVector(const TValue firstValue, const TVariadic... otherValues)
{
  static_assert(std::conjunction_v<std::is_same<TVariadic, TValue>...>,
                "The other values should have the same type as the first value.");
 
  constexpr unsigned int              dimension{ 1 + sizeof...(TVariadic) };
  const std::array<TValue, dimension> stdArray{ { firstValue, otherValues... } };
  return Vector<TValue, dimension>{ stdArray };
}
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkVector.hxx"
#endif
 
#endif