itkOffset.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 itkOffset_h
#define itkOffset_h

#include "itkSize.h"

#include <memory>

namespace itk
{
namespace Functor
{
template< unsigned int VOffsetDimension >
class OffsetLexicographicCompare;
}

template< unsigned int VOffsetDimension = 2 >
class Offset
{
public:
  typedef Offset Self;

  itkStaticConstMacro(Dimension, unsigned int, VOffsetDimension);

  static unsigned int GetOffsetDimension() { return VOffsetDimension; }

  typedef   Offset< VOffsetDimension > OffsetType;
  typedef   itk::OffsetValueType       OffsetValueType;

  typedef Functor::OffsetLexicographicCompare< VOffsetDimension > LexicographicCompare;

  const Self
  operator+(const Self & offset) const
  {
    Self result;

    for ( unsigned int i = 0; i < VOffsetDimension; i++ )
          { result[i] = m_Offset[i] + offset[i]; }
    return result;
  }

  const Self
  operator+(const Size< VOffsetDimension > & size) const
  {
    Self result;

    for ( unsigned int i = 0; i < VOffsetDimension; i++ )
          { result[i] = m_Offset[i] + size[i]; }
    return result;
  }

  const Self &
  operator+=(const Size< VOffsetDimension > & size)
  {
    for ( unsigned int i = 0; i < VOffsetDimension; i++ )
          { m_Offset[i] += size[i]; }
    return *this;
  }

  const Self &
  operator-=(const Size< VOffsetDimension > & size)
  {
    for ( unsigned int i = 0; i < VOffsetDimension; i++ )
          { m_Offset[i] -= size[i]; }
    return *this;
  }

  const Self
  operator-(const Self & vec)
  {
    Self result;

    for ( unsigned int i = 0; i < VOffsetDimension; i++ )
          { result[i] = m_Offset[i] - vec.m_Offset[i]; }
    return result;
  }

  const Self &
  operator+=(const Self & vec)
  {
    for ( unsigned int i = 0; i < VOffsetDimension; i++ )
          { m_Offset[i] += vec.m_Offset[i]; }
    return *this;
  }

  const Self &
  operator-=(const Self & vec)
  {
    for ( unsigned int i = 0; i < VOffsetDimension; i++ )
          { m_Offset[i] -= vec.m_Offset[i]; }
    return *this;
  }

  bool
  operator==(const Self & vec) const
  {
    bool same = 1;

    for ( unsigned int i = 0; i < VOffsetDimension && same; i++ )
          { same = ( m_Offset[i] == vec.m_Offset[i] ); }
    return same;
  }

  bool
  operator!=(const Self & vec) const
  {
    bool same = 1;

    for ( unsigned int i = 0; i < VOffsetDimension && same; i++ )
          { same = ( m_Offset[i] == vec.m_Offset[i] ); }
    return !same;
  }

  OffsetValueType & operator[](unsigned int dim)
  { return m_Offset[dim]; }

  OffsetValueType operator[](unsigned int dim) const
  { return m_Offset[dim]; }

  const OffsetValueType * GetOffset() const { return m_Offset; }

  void SetOffset(const OffsetValueType val[VOffsetDimension])
  {
    std::copy(val,
              val+VOffsetDimension,
              m_Offset);
  }

  static Self GetBasisOffset(unsigned int dim);

  void Fill(OffsetValueType value)
  { for ( unsigned int i = 0; i < VOffsetDimension; ++i ) { m_Offset[i] = value; } }

  OffsetValueType m_Offset[VOffsetDimension];

// force gccxml to find the constructors found before the internal upgrade to
// gcc 4.2
#if defined( CABLE_CONFIGURATION )
  Offset();                     //purposely not implemented
  Offset(const Self &);         //purposely not implemented
  void operator=(const Self &); //purposely not implemented

#endif
};

namespace Functor
{
template< unsigned int VOffsetDimension >
class OffsetLexicographicCompare
{
public:
  bool operator()(Offset< VOffsetDimension > const & l,
                  Offset< VOffsetDimension > const & r) const
  {
    for ( unsigned int i = 0; i < VOffsetDimension; ++i )
      {
      if ( l.m_Offset[i] < r.m_Offset[i] )
        {
        return true;
        }
      else if ( l.m_Offset[i] > r.m_Offset[i] )
        {
        return false;
        }
      }
    return false;
  }
};
}

template< unsigned int VOffsetDimension >
Offset< VOffsetDimension >
Offset< VOffsetDimension >
::GetBasisOffset(unsigned int dim)
{
  Self ind;

  memset(ind.m_Offset, 0, sizeof( OffsetValueType ) * VOffsetDimension);
  ind.m_Offset[dim] = 1;
  return ind;
}

template< unsigned int VOffsetDimension >
std::ostream & operator<<(std::ostream & os, const Offset< VOffsetDimension > & ind)
{
  os << "[";
  unsigned int dimlim = VOffsetDimension - 1;
  for ( unsigned int i = 0; i < dimlim; ++i )
    {
    os << ind[i] << ", ";
    }
  if ( VOffsetDimension >= 1 )
    {
    os << ind[VOffsetDimension - 1];
    }
  os << "]";
  return os;
}
} // end namespace itk

#endif