itkCovariantVector.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
 *
 *         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 itkCovariantVector_h
#define itkCovariantVector_h
 
#include "itkIndent.h"
#include "itkVector.h"
#include "vnl/vnl_vector_ref.h"
 
namespace itk
{
 
template <typename T, unsigned int NVectorDimension = 3>
class ITK_TEMPLATE_EXPORT CovariantVector : public FixedArray<T, NVectorDimension>
{
public:
  using Self = CovariantVector;
  using Superclass = FixedArray<T, NVectorDimension>;
 
  using ValueType = T;
  using RealValueType = typename NumericTraits<ValueType>::RealType;
 
  using ComponentType = T;
 
  static constexpr unsigned int Dimension = NVectorDimension;
 
  using CovariantVectorType = Self;
 
  using BaseArray = FixedArray<T, NVectorDimension>;
 
  static unsigned int
  GetCovariantVectorDimension()
  {
    return NVectorDimension;
  }
 
  void
  SetVnlVector(const vnl_vector<T> &);
 
  vnl_vector_ref<T>
  GetVnlVector();
 
  vnl_vector<T>
  GetVnlVector() const;
 
  CovariantVector() = default;
  CovariantVector(const CovariantVector &) = default;
  CovariantVector(CovariantVector &&) = default;
  CovariantVector &
  operator=(const CovariantVector &) = default;
  CovariantVector &
  operator=(CovariantVector &&) = default;
  ~CovariantVector() = default;
 
  explicit CovariantVector(const ValueType & r);
 
  template <typename TVectorValueType>
  CovariantVector(const CovariantVector<TVectorValueType, NVectorDimension> & r)
    : BaseArray(r)
  {}
  CovariantVector(const ValueType r[Dimension])
    : BaseArray(r)
  {}
 
  template <typename TCovariantVectorValueType>
  Self &
  operator=(const CovariantVector<TCovariantVectorValueType, NVectorDimension> & r)
  {
    BaseArray::operator=(r);
    return *this;
  }
 
  CovariantVector &
  operator=(const ValueType r[NVectorDimension]);
 
  template <typename Tt>
  inline const Self &
  operator*=(const Tt & value)
  {
    for (unsigned int i = 0; i < NVectorDimension; i++)
    {
      (*this)[i] = static_cast<ValueType>((*this)[i] * value);
    }
    return *this;
  }
 
  template <typename Tt>
  const Self &
  operator/=(const Tt & value)
  {
    for (unsigned int i = 0; i < NVectorDimension; 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;
 
  ValueType operator*(const Vector<T, NVectorDimension> & other) const;
 
  inline Self operator*(const ValueType & val) const
  {
    Self result;
 
    for (unsigned int i = 0; i < NVectorDimension; i++)
    {
      result[i] = static_cast<ValueType>((*this)[i] * val);
    }
    return result;
  }
 
  template <typename Tt>
  inline Self
  operator/(const Tt & val) const
  {
    Self result;
 
    for (unsigned int i = 0; i < NVectorDimension; i++)
    {
      result[i] = static_cast<ValueType>((*this)[i] / val);
    }
    return result;
  }
 
  RealValueType
  GetNorm() const;
 
  static unsigned int
  GetNumberOfComponents()
  {
    return NVectorDimension;
  }
 
  RealValueType
  Normalize();
 
  RealValueType
  GetSquaredNorm() const;
 
  template <typename TCoordRepB>
  void
  CastFrom(const CovariantVector<TCoordRepB, NVectorDimension> & pa)
  {
    for (unsigned int i = 0; i < NVectorDimension; i++)
    {
      (*this)[i] = static_cast<T>(pa[i]);
    }
  }
};
 
template <typename T, unsigned int NVectorDimension>
inline CovariantVector<T, NVectorDimension> operator*(const T & scalar, const CovariantVector<T, NVectorDimension> & v)
{
  return v.operator*(scalar);
}
 
template <typename T, unsigned int NVectorDimension>
inline T operator*(const Vector<T, NVectorDimension> &          contravariant,
                   const CovariantVector<T, NVectorDimension> & covariant)
{
  return covariant.operator*(contravariant);
}
 
ITKCommon_EXPORT void
CrossProduct(CovariantVector<double, 3> &, const Vector<double, 3> &, const Vector<double, 3> &);
 
ITKCommon_EXPORT void
CrossProduct(CovariantVector<float, 3> &, const Vector<float, 3> &, const Vector<float, 3> &);
 
ITKCommon_EXPORT void
CrossProduct(CovariantVector<int, 3>, const Vector<int, 3> &, const Vector<int, 3> &);
 
 
template <typename T, unsigned int NVectorDimension>
inline void
swap(CovariantVector<T, NVectorDimension> & a, CovariantVector<T, NVectorDimension> & b)
{
  a.swap(b);
}
 
} // end namespace itk
 
//
// Numeric traits must be included after (optionally) including the explicit
// instantiations control of this class, in case the implicit instantiation
// needs to be disabled.
//
// NumericTraits must be included before (optionally) including the .hxx file,
// in case the .hxx requires to use NumericTraits.
//
#include "itkNumericTraitsCovariantVectorPixel.h"
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkCovariantVector.hxx"
#endif
 
#endif