itkVector.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 itkVector_h
#define itkVector_h

#include "itkFixedArray.h"

#include "vnl/vnl_vector_ref.h" // GetVnlVector method return

namespace itk
{
template< typename T, unsigned int NVectorDimension = 3 >
class ITK_TEMPLATE_EXPORT Vector:public FixedArray< T, NVectorDimension >
{
public:
  using Self = Vector;
  using Superclass = FixedArray< T, NVectorDimension >;

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

  static constexpr unsigned int Dimension = NVectorDimension;

  using VectorType = Self;

  using ComponentType = T;

  using BaseArray = FixedArray< T, NVectorDimension >;

  static unsigned int GetVectorDimension() { return NVectorDimension; }

  void SetVnlVector(const vnl_vector< T > &);

  vnl_vector_ref< T > GetVnlVector();

  vnl_vector< T > GetVnlVector() const;

  Vector() = default;
  Vector(const Vector&) = default;
  Vector(Vector&&) = default;
  Vector & operator=(const Vector &) = default;
  Vector & operator=(Vector &&) = default;
  ~Vector() = default;

#if !defined( ITK_LEGACY_FUTURE_REMOVE )

  Vector(const ValueType & r);
#else

  explicit Vector(const ValueType & r);
#endif

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

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

  Vector & 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 >
  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;
  }

  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 & vec) const;

  inline Self operator*(const ValueType & value) const
  {
    Self result;

    for ( unsigned int i = 0; i < NVectorDimension; 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 < NVectorDimension; i++ )
      {
      result[i] = static_cast< ValueType >( ( *this )[i] / value );
      }
    return result;
  }

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

  RealValueType GetNorm() const;

  RealValueType GetSquaredNorm() const;

  static unsigned int GetNumberOfComponents() { return NVectorDimension; }

  RealValueType Normalize();

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

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

  template<typename TCoordRepB>
  operator Vector< TCoordRepB, NVectorDimension >()
  {
    Vector<TCoordRepB, NVectorDimension> r;
    for (unsigned int i = 0; i < NVectorDimension; i++)
    {
      r[i] = static_cast<TCoordRepB> ((*this)[i]);
    }
    return r;
  }

};

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

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

template< typename T, unsigned int NVectorDimension >
std::istream & operator>>(std::istream & is,
                          Vector< T, NVectorDimension > & v);

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 NVectorDimension >
inline void swap( Vector<T, NVectorDimension> &a, Vector<T, NVectorDimension> &b )
{
  a.swap(b);
}

} // end namespace itk

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

#endif