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< class T, unsigned int NVectorDimension = 3 >
class Vector:public FixedArray< T, NVectorDimension >
{
public:
  typedef Vector                            Self;
  typedef FixedArray< T, NVectorDimension > Superclass;

  typedef T                                             ValueType;
  typedef typename NumericTraits< ValueType >::RealType RealValueType;

  itkStaticConstMacro(Dimension, unsigned int, NVectorDimension);

  typedef Self VectorType;

  typedef T ComponentType;

  typedef FixedArray< T, NVectorDimension > BaseArray;

  static unsigned int GetVectorDimension() { return NVectorDimension; }

  void SetVnlVector(const vnl_vector< T > &);

  vnl_vector_ref< T > GetVnlVector(void);

  vnl_vector< T > GetVnlVector(void) const;

  itkLegacyMacro(void Set_vnl_vector(const vnl_vector< T > &));

  itkLegacyMacro(vnl_vector_ref< T > Get_vnl_vector(void));

  itkLegacyMacro(vnl_vector< T > Get_vnl_vector(void) const);

  Vector():BaseArray() {}
  Vector(const ValueType & r);

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

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

  Vector & operator=(const ValueType r[NVectorDimension]);

  template< class 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< class 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< class 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(void) const;

  RealValueType GetSquaredNorm(void) const;

  static unsigned int GetNumberOfComponents() { return NVectorDimension; }

  void Normalize(void);

  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< class T, unsigned int NVectorDimension >
inline
Vector< T, NVectorDimension >
operator*(const T & scalar, const Vector< T, NVectorDimension > & v)
{
  return v * scalar;
}

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

template< class 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 > &);
} // end namespace itk

// Define instantiation macro for this template.
#define ITK_TEMPLATE_Vector(_, EXPORT, TypeX, TypeY)                                  \
  namespace itk                                                                       \
  {                                                                                   \
  _( 2 ( class EXPORT Vector< ITK_TEMPLATE_2 TypeX > ) )                              \
  _( 1 ( EXPORT std::ostream & operator<<(std::ostream &,                             \
                                          const Vector< ITK_TEMPLATE_2 TypeX > &) ) ) \
  _( 1 ( EXPORT std::istream & operator>>(std::istream &,                             \
                                          Vector< ITK_TEMPLATE_2 TypeX > &) ) )       \
  namespace Templates                                                                 \
  {                                                                                   \
  typedef Vector< ITK_TEMPLATE_2 TypeX > Vector##TypeY;                             \
  }                                                                                   \
  }

#if ITK_TEMPLATE_EXPLICIT
#include "Templates/itkVector+-.h"
#endif

//
// 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 "itkNumericTraitsVectorPixel.h"

#if ITK_TEMPLATE_TXX
#include "itkVector.hxx"
#endif

#endif