Array.hpp

Go to the documentation of this file.

/*
 * Copyright(c):
 * Signal Image and Communications (SIC) Department 
 * http://www.sic.sp2mi.univ-poitiers.fr/ 
 *  - University of Poitiers, France http://www.univ-poitiers.fr 
 *  - XLIM  Institute UMR CNRS 7252  http://www.xlim.fr/ 
 * 
 * and 
 * 
 * D2 Fluid, Thermic and Combustion 
 *  - University of Poitiers, France http://www.univ-poitiers.fr 
 *  - PPRIME Institute -  UPR CNRS 3346  http://www.pprime.fr
 *  - ISAE-ENSMA http://www.ensma.fr
 *
 * Contributor(s):
 * The SLIP team,
 * Benoit Tremblais <tremblais_AT_sic.univ-poitiers.fr>,
 * Laurent David <laurent.david_AT_lea.univ-poitiers.fr>, 
 * Ludovic Chatellier <ludovic.chatellier_AT_univ-poitiers.fr>, 
 * Lionel Thomas <lionel.thomas_AT_univ-poitiers.fr>, 
 * Denis Arrivault <arrivault_AT_sic.univ-poitiers.fr>, 
 * Julien Dombre <julien.dombre_AT_univ-poitiers.fr>.
 *
 * Description:
 * The Simple Library of Image Processing (SLIP) is a new image processing 
 * library. It is written in the C++ language following as much as possible 
 * the ISO/ANSI C++ standard. It is consequently compatible with any system  
 * satisfying the ANSI C++ complience. It works on different Unix , Linux ,  
 * Mircrosoft Windows and Mac OS X plateforms. SLIP is a research library that  
 * was created by the Signal, Image and Communications (SIC) departement of  
 * the XLIM, UMR 7252 CNRS Institute in collaboration with the Fluids, Thermic  
 * and Combustion departement of the P', UPR 3346 CNRS Institute of the  
 * University of Poitiers.
 * 
 * The SLIP Library source code has been registered to the APP (French Agency 
 * for the Protection of Programs) by the University of Poitiers and CNRS, 
 * under  registration number IDDN.FR.001.300034.000.S.P.2010.000.21000.

 * http://www.sic.sp2mi.univ-poitiers.fr/slip/
 *
 * This software is governed by the CeCILL-C license under French law and
 * abiding by the rules of distribution of free software.  You can  use, 
 * modify and/ or redistribute the software under the terms of the CeCILL-C 
 * license as circulated by CEA, CNRS and INRIA at the following URL 
 * http://www.cecill.info.
 * As a counterpart to the access to the source code and  rights to copy,
 * modify and redistribute granted by the license, users are provided only
 * with a limited warranty  and the software's author,  the holder of the
 * economic rights,  and the successive licensors  have only  limited
 * liability.
 * 
 * In this respect, the user's attention is drawn to the risks associated
 * with loading,  using,  modifying and/or developing or reproducing the
 * software by the user in light of its specific status of free software,
 * that may mean  that it is complicated to manipulate,  and  that  also
 * therefore means  that it is reserved for developers  and  experienced
 * professionals having in-depth computer knowledge. Users are therefore
 * encouraged to load and test the software's suitability as regards their
 * requirements in conditions enabling the security of their systems and/or
 * data to be ensured and,  more generally, to use and operate it in the 
 * same conditions as regards security. 
 *
 * The fact that you are presently reading this means that you have had
 * knowledge of the CeCILL-C license and that you accept its terms.
 */



#ifndef SLIP_ARRAY_HPP
#define SLIP_ARRAY_HPP
#include <iostream>
#include <iterator>
#include <cassert>
#include <cstddef>
#include "Range.hpp"
#include "Box1d.hpp"
#include "stride_iterator.hpp"

#include <boost/serialization/access.hpp>
#include <boost/serialization/split_member.hpp>
#include <boost/serialization/string.hpp>
#include <boost/serialization/complex.hpp>
#include <boost/serialization/version.hpp>
namespace slip
{

template <typename T>
class Array;

template <typename T>
std::ostream& operator<<(std::ostream & out, 
                                                 const Array<T>& a);

template<typename T>
bool operator==(const Array<T>& x, 
                                const Array<T>& y);

template<typename T>
bool operator!=(const Array<T>& x, 
                                const Array<T>& y);

template<typename T>
bool operator<(const Array<T>& x, 
                       const Array<T>& y);

template<typename T>
bool operator>(const Array<T>& x, 
                       const Array<T>& y);

template<typename T>
bool operator<=(const Array<T>& x, 
                                const Array<T>& y);

template<typename T>
bool operator>=(const Array<T>& x, 
                                const Array<T>& y);

template <typename T>
class Array
{
public:
  typedef T value_type;
  typedef Array<T> self;
  typedef const Array<T> const_self;

  typedef value_type* pointer;
  typedef const value_type* const_pointer;
  typedef value_type& reference;
  typedef const value_type& const_reference;

  typedef ptrdiff_t difference_type;
  typedef std::size_t size_type;

  typedef pointer iterator;
  typedef const_pointer const_iterator;

  typedef slip::stride_iterator<pointer> iterator_range;
  typedef slip::stride_iterator<const_pointer> const_iterator_range;

  typedef std::reverse_iterator<iterator> reverse_iterator;
  typedef std::reverse_iterator<const_iterator> const_reverse_iterator;

  typedef std::reverse_iterator<iterator_range> reverse_iterator_range;
  typedef std::reverse_iterator<const_iterator_range> const_reverse_iterator_range;

  //default iterator of the container
  typedef iterator default_iterator;
  typedef const_iterator const_default_iterator;

  static const std::size_t DIM = 1;

public:

  Array();
 
  Array(const size_type size);
  
  Array(const size_type size,
                const T& val);
 
  Array(const size_type size,
                const T* val);
 
  template<typename InputIterator>
  Array(const size_type n,
                InputIterator first,
                InputIterator last):
    size_(n)
  {
    this->allocate();
    std::fill_n(this->begin(),n,T());
    std::copy(first,last,this->begin());
  }
  
  Array(const self& rhs);

  ~Array();
  

  void resize(const size_type size,
                      const T& val = T());

 
  iterator begin();

  const_iterator begin() const;

  iterator end();
 
  const_iterator end() const;
  
  reverse_iterator rbegin();
  
  const_reverse_iterator rbegin() const;

  reverse_iterator rend();

  const_reverse_iterator rend() const;

  iterator_range begin(const slip::Range<int>& range);
 
  const_iterator_range begin(const slip::Range<int>& range) const;

  iterator_range end(const slip::Range<int>& range);
 
  const_iterator_range end(const slip::Range<int>& range) const;



  iterator begin(const slip::Box1d<int>& box);
 
  const_iterator begin(const slip::Box1d<int>& box) const;

  iterator end(const slip::Box1d<int>& box);
 
  const_iterator end(const slip::Box1d<int>& box) const;

  //
  reverse_iterator_range rbegin(const slip::Range<int>& range);
 
  const_reverse_iterator_range rbegin(const slip::Range<int>& range) const;

  reverse_iterator_range rend(const slip::Range<int>& range);
 
  const_reverse_iterator_range rend(const slip::Range<int>& range) const;



  reverse_iterator rbegin(const slip::Box1d<int>& box);
 
  const_reverse_iterator rbegin(const slip::Box1d<int>& box) const;

  reverse_iterator rend(const slip::Box1d<int>& box);
 
  const_reverse_iterator rend(const slip::Box1d<int>& box) const;
  
  friend std::ostream& operator<< <>(std::ostream & out, 
                                                                     const self& a);

  self& operator=(const self& rhs);
  
  self& operator=(const T& value)
  {
    this->fill(value);
    return *this;
  }

  void fill(const T& value)
  {
    std::fill_n(this->begin(),size_,value);
  } 
  
  void fill(const T* value)
  {
    std::copy(value,value + size_,this->begin());
  } 

  template<typename InputIterator>
  void fill(InputIterator first,
                    InputIterator last)
  {
    std::copy(first,last,this->begin());
  }
  friend bool operator== <>(const Array<T>& x, 
                                                    const Array<T>& y);

  friend bool operator!= <>(const Array<T>& x, 
                                                    const Array<T>& y);

  friend bool operator< <>(const Array<T>& x, 
                                                   const Array<T>& y);

  friend bool operator> <>(const Array<T>& x, 
                                                   const Array<T>& y);

  friend bool operator<= <>(const Array<T>& x, 
                                                    const Array<T>& y);

  friend bool operator>= <>(const Array<T>& x, 
                                                    const Array<T>& y);


  reference operator[](const size_type n);

 
  const_reference operator[](const size_type n) const;
  
  reference operator()(const size_type n);
  
  const_reference operator()(const size_type n) const;


  reference operator()(const slip::Point1d<size_type>& p);
  
  const_reference operator()(const slip::Point1d<size_type>& p) const;

  self operator()(const slip::Range<int>& range);

  std::string name() const;

  size_type size() const;
  size_type max_size() const;

  bool empty()const;

  void swap(self& rhs);
 
private:
  size_type size_;
  T* data_;

  void allocate();
  void desallocate();
  void copy_attributes(const self& rhs);
    
  friend class boost::serialization::access;
    template<class Archive>
    void save(Archive & ar, const unsigned int version) const
    {
      ar & this->size_ ;
      for(std::size_t i = 0; i < this->size_; ++i)
                {
                  ar & *(data_ + i);
                }
    }
    template<class Archive>
    void load(Archive & ar, const unsigned int version)
    {
      ar & this->size_;
      this->desallocate();
      this->allocate();
       for(std::size_t i = 0; i < this->size_; ++i)
                {
                  ar & *(data_+ i);
                }
    }
    BOOST_SERIALIZATION_SPLIT_MEMBER();

}; // end of Containers1d group

  typedef slip::Array<double> Array_d;
  typedef slip::Array<float> Array_f;
  typedef slip::Array<long> Array_l;
  typedef slip::Array<unsigned long> Array_ul;
  typedef slip::Array<short> Array_s;
  typedef slip::Array<unsigned short> Array_us;
  typedef slip::Array<int> Array_i;
  typedef slip::Array<unsigned int> Array_ui;
  typedef slip::Array<char> Array_c;
  typedef slip::Array<unsigned char> Array_uc;

}//slip::

namespace slip
{

  template<typename T>
  inline
  Array<T>::Array():
    size_(0),data_(0)
  {}


  template<typename T>
  inline
  Array<T>::Array(const typename Array<T>::size_type n):
    size_(n)
  {
    this->allocate();
    std::fill_n(this->data_,this->size_,T());
  }

  template<typename T>
  inline
  Array<T>::Array(typename Array<T>::size_type n,
                                  const T& val):
    size_(n)
  {
    this->allocate();
    std::fill_n(this->data_,this->size_,val);
  }
  
  template<typename T>
  inline
  Array<T>::Array(typename Array<T>::size_type n,
                                  const T* val):
    size_(n)
  {
    this->allocate();
    std::copy(val,val + this->size_, this->data_); 
  }

  template<typename T>
  inline
  Array<T>::Array(const Array<T>& rhs):
    size_(rhs.size_)
  {
    this->allocate();
    std::copy(rhs.data_,rhs.data_ + this->size_,this->data_);
  }

  template<typename T>
  inline
  Array<T>::~Array()
  {
    this->desallocate();
  }

  template<typename T>
  inline
  Array<T>& Array<T>::operator=(const self& rhs)
  {
    if(this != &rhs)
      {
                if(this->size_ != rhs.size_)
                  {
                    this->desallocate();
                    this->copy_attributes(rhs);
                    this->allocate();
                  }
                if(rhs.size_ != 0)
                  {
                    std::copy(rhs.data_,rhs.data_ + this->size_,this->data_);
                  }
      }
    return *this;
  } 
  
  
  template<typename T>
  inline
  void Array<T>::resize(typename Array<T>::size_type size,
                                                const T& val)
  {
    if( this->size_ != size)
      {
                this->desallocate();
                this->size_ = size;
                this->allocate();
      }
    if(size != 0)
      {
      std::fill_n(this->data_,this->size_,val);
      }
    
  }

  template<typename T>
  inline
  typename Array<T>::iterator Array<T>::begin()
  {
    return this->data_;
  }

  template<typename T>
  inline
  typename Array<T>::iterator Array<T>::end()
  {
    return this->data_ + this->size_;
  }
  
  template<typename T>
  inline
  typename Array<T>::const_iterator Array<T>::begin() const
  {
    return this->data_;
  }

  template<typename T>
  inline
  typename Array<T>::const_iterator Array<T>::end() const
  {
    return this->data_ + this->size_;
  }
  

  //
  template<typename T>
  inline
  typename Array<T>::iterator_range 
  Array<T>::begin(const slip::Range<int>& range)
  {
    assert(range.is_valid());
    assert(range.start() >= 0);
    assert(range.stop()  >= 0);
    assert(range.start() < int(this->size()));
    assert(range.stop()  < int(this->size()));
    return typename slip::Array<T>::iterator_range(this->data_+range.start(),range.stride());
  }

  template<typename T>
  inline
  typename Array<T>::iterator_range 
  Array<T>::end(const slip::Range<int>& range)
  {
    
    return this->begin(range) + (range.iterations() + 1);
  }
  
  template<typename T>
  inline
  typename Array<T>::const_iterator_range 
  Array<T>::begin(const slip::Range<int>& range) const
  {
    assert(range.is_valid());
    assert(range.start() >= 0);
    assert(range.stop()  >= 0);
    assert(range.start() < int(this->size()));
    assert(range.stop()  < int(this->size()));
    return typename slip::Array<T>::const_iterator_range(this->data_+range.start(),range.stride());
  }

  template<typename T>
  inline
  typename Array<T>::const_iterator_range 
  Array<T>::end(const slip::Range<int>& range) const
  {
    return this->begin(range) + (range.iterations() + 1);
  }


  //
  template<typename T>
  inline
  typename Array<T>::iterator
  Array<T>::begin(const slip::Box1d<int>& box)
  {
    assert(box.is_consistent());
    return this->data_ + (box.upper_left())[0];
  }

  template<typename T>
  inline
  typename Array<T>::iterator 
  Array<T>::end(const slip::Box1d<int>& box)
  {
    assert(box.is_consistent());
    return this->begin(box) + box.length();
  }
  
  template<typename T>
  inline
  typename Array<T>::const_iterator 
  Array<T>::begin(const slip::Box1d<int>& box) const
  {
    assert(box.is_consistent());
    return this->data_ + (box.upper_left())[0];
  }

  template<typename T>
  inline
  typename Array<T>::const_iterator 
  Array<T>::end(const slip::Box1d<int>& box) const
  {
    assert(box.is_consistent());
    return this->begin(box) + box.length();
  }
  //
  template<typename T>
  inline
  typename Array<T>::reverse_iterator Array<T>::rbegin()
  {
    return typename Array<T>::reverse_iterator(this->end());
  }

  template<typename T>
  inline
  typename Array<T>::reverse_iterator Array<T>::rend()
  {
    return  typename Array<T>::reverse_iterator(this->begin());
  }

  template<typename T>
  inline
  typename Array<T>::const_reverse_iterator Array<T>::rbegin() const
  {
    return typename Array<T>::const_reverse_iterator(this->end());
  }

  template<typename T>
  inline
  typename Array<T>::const_reverse_iterator Array<T>::rend() const
  {
    return typename Array<T>::const_reverse_iterator(this->begin());
  }

  //
  template<typename T>
  inline
  typename Array<T>::reverse_iterator Array<T>::rbegin(const slip::Box1d<int>& box)
  {
    return typename Array<T>::reverse_iterator(this->end(box));
  }

  template<typename T>
  inline
  typename Array<T>::reverse_iterator 
  Array<T>::rend(const slip::Box1d<int>& box)
  {
    return  typename Array<T>::reverse_iterator(this->begin(box));
  }

  template<typename T>
  inline
  typename Array<T>::const_reverse_iterator 
  Array<T>::rbegin(const slip::Box1d<int>& box) const
  {
    return typename Array<T>::const_reverse_iterator(this->end(box));
  }

  template<typename T>
  inline
  typename Array<T>::const_reverse_iterator 
  Array<T>::rend(const slip::Box1d<int>& box) const
  {
    return typename Array<T>::const_reverse_iterator(this->begin(box));
  }
  //
  template<typename T>
  inline
  typename Array<T>::reverse_iterator_range Array<T>::rbegin(const slip::Range<int>& range)
  {
    return typename Array<T>::reverse_iterator_range(this->end(range));
  }

  template<typename T>
  inline
  typename Array<T>::reverse_iterator_range 
  Array<T>::rend(const slip::Range<int>& range)
  {
    return  typename Array<T>::reverse_iterator_range(this->begin(range));
  }

  template<typename T>
  inline
  typename Array<T>::const_reverse_iterator_range 
  Array<T>::rbegin(const slip::Range<int>& range) const
  {
    return typename Array<T>::const_reverse_iterator_range(this->end(range));
  }

  template<typename T>
  inline
  typename Array<T>::const_reverse_iterator_range 
  Array<T>::rend(const slip::Range<int>& range) const
  {
    return typename Array<T>::const_reverse_iterator_range(this->begin(range));
  }


  /* @{ */
  template <typename T>
  inline
  std::ostream& operator<<(std::ostream & out, 
                                                   const Array<T>& a)
  {
    if(a.data_ != 0)
      {
                out<<"(";
                for(std::size_t n = 0; n < a.size_ - 1; ++n)
                  {
                    out<<a.data_[n]<<",";
                  }
                out<<a.data_[a.size_-1];
                out<<")";
      }
    else
      {
                out<<"()";
      }
    return out;
  }
   /* @} */

  template <typename T>
  inline
  typename Array<T>::reference Array<T>::operator[](typename Array<T>::size_type i)
  {
    assert(this->data_ != 0);
    assert(i < this->size_);
    return *(this->data_ + i);
  }

  template <typename T>
  inline
  typename Array<T>::const_reference Array<T>::operator[](typename Array<T>::size_type i) const
  {
    assert(this->data_ != 0);
    assert(i < this->size_);
    return *(this->data_ + i);
  }

  template <typename T>
  inline
  typename Array<T>::reference Array<T>::operator()(typename Array<T>::size_type i)
  {
    assert(this->data_ != 0);
    assert(i < this->size_);
    return *(this->data_ + i);
  }

  template <typename T>
  inline
  typename Array<T>::const_reference Array<T>::operator()(typename Array<T>::size_type i) const
  {
    assert(this->data_ != 0);
    assert(i < this->size_);
    return *(this->data_ + i);
  }
 
  template <typename T>
  inline
  typename Array<T>::reference 
  Array<T>::operator()(const slip::Point1d<typename Array<T>::size_type>& p)
  {
    assert(this->data_ != 0);
    assert(p[0] < this->size_);
    return *(this->data_ + p[0]);
  }

  template <typename T>
  inline
  typename Array<T>::const_reference 
  Array<T>::operator()(const slip::Point1d<typename Array<T>::size_type>& p) const
  {
    assert(this->data_ != 0);
    assert(p[0] < this->size_);
    return *(this->data_ + p[0]);
  }

  template<typename T>
  inline
  Array<T> Array<T>::operator()(const slip::Range<int>& range)
  {
     assert(this->data_ != 0);
     assert(range.is_valid());
     assert(range.start() < (int)this->size_);
     assert(range.stop()  < (int)this->size_);

     std::size_t dim = range.iterations() + 1;

     return Array<T>(dim,this->begin(range),this->end(range));
  }

  template<typename T>
  inline
  std::string 
  Array<T>::name() const {return "Array";} 


  template <typename T>
  inline
  typename Array<T>::size_type Array<T>::size() const {return this->size_;}
  
  template <typename T>
  inline
  typename Array<T>::size_type Array<T>::max_size() const 
  {
    return typename Array<T>::size_type(-1)/sizeof(T);
  }
  
  template<typename T>
  inline
  bool Array<T>::empty()const {return this->size_ == 0;}

  template<typename T>
  inline
  void Array<T>::swap(Array<T>& M)
  {
    assert(this->size_ == M.size_);
    std::swap_ranges(this->begin(),this->end(),M.begin());
  }

 
  

template<typename T>
  inline
  void Array<T>::allocate()
  {
    if(this->size_ != 0)
      {
                this->data_ = new T[this->size_];
      }
    else
      {
                this->data_ = 0;
      }
  }

  template<typename T>
  inline
  void Array<T>::desallocate()
  {
    if (this->data_ != 0)
      delete[] (this->data_);
  }

  template<typename T>
  inline
  void Array<T>::copy_attributes(const Array<T>& rhs)
  {
    this->size_ = rhs.size_;
  }

  /* @{ */

template<typename T>
inline
bool operator==(const Array<T>& x, 
                                const Array<T>& y)
{
  return ( x.size() == y.size()
                   && std::equal(x.begin(),x.end(),y.begin())); 
}

template<typename T>
inline
bool operator!=(const Array<T>& x, 
                                const Array<T>& y)
{
  return !(x == y);
}

/* @} */

  /* @{ */
template<typename T>
inline
bool operator<(const Array<T>& x, 
                       const Array<T>& y)
{
  return std::lexicographical_compare(x.begin(), x.end(),
                                                                      y.begin(), y.end());
}

template<typename T>
inline
bool operator>(const Array<T>& x, 
                       const Array<T>& y)
{
  return (y < x);
}

template<typename T>
inline
bool operator<=(const Array<T>& x, 
                                const Array<T>& y)
{
  return !(y < x);
}

template<typename T>
inline
bool operator>=(const Array<T>& x, 
                                const Array<T>& y)
{
  return !(x < y);
} 

/* @} */

}//slip::
#endif //SLIP_ARRAY_HPP