itkArray.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 __itkArray_h
#define __itkArray_h

#include "itkMacro.h"

#include "vxl_version.h"
#if VXL_VERSION_DATE_FULL < 20110428
#error "System installed VXL version is too old. Please make sure the version date is later than 2011-04-28."
#endif

#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;
  typedef typename vnl_vector< TValueType>::size_type  SizeValueType;

public:

  Array();

  Array(const Array&);

  explicit Array(SizeValueType dimension);

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

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

  template< class TArrayValue >
  Array(const Array< TArrayValue > & r)
  {
    this->m_LetArrayManageMemory = true;
    this->SetSize( r.GetSize() );
    for( SizeValueType i=0; i<r.GetSize(); i++ )
      {
      this->operator[](i) = static_cast< TValueType >( r[i] );
      }
  }

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

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

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

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

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

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

  void SetSize(SizeValueType sz);

  SizeValueType GetSize(void) const
  { return static_cast< SizeValueType >( this->size() ); }

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

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


#ifdef __INTEL_COMPILER
#pragma warning disable 444 //destructor for base class "itk::Array<>" is not virtual
#endif

  ~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, TypeX, TypeY)                                  \
  namespace itk                                                                      \
  {                                                                                  \
  _( 1 ( class EXPORT Array< ITK_TEMPLATE_1 TypeX > ) )                              \
  _( 1 ( EXPORT std::ostream & operator<<(std::ostream &,                            \
                                          const Array< ITK_TEMPLATE_1 TypeX > &) ) ) \
  namespace Templates                                                                \
  {                                                                                  \
  typedef Array< ITK_TEMPLATE_1 TypeX > Array##TypeY;                              \
  }                                                                                  \
  }

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

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

#endif