itkSize.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 itkSize_h
#define itkSize_h

#include "itkMacro.h"
#include "itkIntTypes.h"

namespace itk
{
template< unsigned int VDimension = 2 >
class Size
{
public:
  typedef Size Self;

  typedef   Size< VDimension > SizeType;
  typedef   itk::SizeValueType SizeValueType;

  itkStaticConstMacro(Dimension, unsigned int, VDimension);

  static unsigned int GetSizeDimension(void) { return VDimension; }

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

    for ( unsigned int i = 0; i < VDimension; i++ )
          { result[i] = m_Size[i] + vec.m_Size[i]; }
    return result;
  }

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

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

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

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

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

    for ( unsigned int i = 0; i < VDimension; i++ )
          { result[i] = m_Size[i] * vec.m_Size[i]; }
    return result;
  }

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

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

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

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

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

  SizeValueType & operator[](unsigned int dim)
  { return m_Size[dim]; }

  SizeValueType operator[](unsigned int dim) const
  { return m_Size[dim]; }

  const SizeValueType * GetSize() const { return m_Size; }

  void SetSize(const SizeValueType val[VDimension])
  {
    std::copy(val,
              val+VDimension,
              m_Size);
  }

  void SetElement(unsigned long element, SizeValueType val)
  { m_Size[element] = val;  }

  SizeValueType GetElement(unsigned long element) const
  { return m_Size[element]; }

  void Fill(SizeValueType value)
  { for ( unsigned int i = 0; i < VDimension; ++i ) { m_Size[i] = value; } }

  SizeValueType m_Size[VDimension];

#if defined( ITK_WRAPPING_PARSER )
  // Do not use c++11 'delete' keyword here.  This code block is here to
  // explicitly provide the wrapping facilities with handles to the default and
  // copy constructors, and the assignment operator that are otherwise declared
  // implicitly.
  Size();
  Size(const Self&);
  void operator=(const Self&);
#endif
};

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

#endif