itkArray.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkArray.h,v $
  Language:  C++
  Date:      $Date: 2010-03-15 19:02:09 $
  Version:   $Revision: 1.48 $

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even 
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef __itkArray_h
#define __itkArray_h

#include "itkMacro.h"
#include "vnl/vnl_vector.h"

namespace itk
{

 
template <typename TValueType >
class Array : public vnl_vector< TValueType >
{
public:
 
  typedef TValueType             ValueType;
  typedef Array                  Self;
  typedef vnl_vector<TValueType> VnlVectorType;

public:

  Array(); 

  explicit Array(unsigned int dimension);

  Array( ValueType* data, unsigned int sz, bool LetArrayManageMemory = false);

  Array( const ValueType* data, unsigned int sz, 
         bool LetArrayManageMemory = false);


  void Fill (TValueType const& v) { this->fill(v); }

  const Self & operator=( const Self &rhs );
  const Self & operator=( const VnlVectorType & rhs );

  unsigned int Size (void ) const 
      { return static_cast<unsigned int>( this->size() ); }
  unsigned int GetNumberOfElements(void) const 
      { return static_cast<unsigned int>( this->size() ); }

  const TValueType & GetElement( unsigned int i ) const
    { return this->operator[]( i ); }

  void SetElement( unsigned int i, const TValueType & value )
    { this->operator[]( i ) = value; }

  void SetSize(unsigned int sz);
  unsigned int GetSize(void) const 
      { return static_cast<unsigned int>( this->size() ); }

  void SetData(TValueType* data,bool LetArrayManageMemory = false);

  void SetData(TValueType* data, unsigned int sz, 
               bool LetArrayManageMemory = false);

  
  ~Array();

private:

  bool m_LetArrayManageMemory;
  
};


template <typename TValueType >
std::ostream & operator<<(std::ostream &os, const Array<TValueType> &arr)
{
  const unsigned int length = arr.size();
  const signed int last   = (unsigned int) length - 1;

  os << "[";
  for (signed int i=0; i < last; ++i)
    {
    os << arr[i] << ", ";
    }
  if (length >= 1)
    {
    os << arr[last];
    }
  os << "]";
  return os;
}

} // namespace itk

// Define instantiation macro for this template.
#define ITK_TEMPLATE_Array(_, EXPORT, x, y) namespace itk { \
  _(1(class EXPORT Array< ITK_TEMPLATE_1 x >)) \
  _(1(EXPORT std::ostream& operator<<(std::ostream&, \
                                     const Array< ITK_TEMPLATE_1 x >&))) \
  namespace Templates { typedef Array< ITK_TEMPLATE_1 x > Array##y; } \
  }


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

#if ITK_TEMPLATE_TXX
# include "itkArray.txx"
#endif

#endif