Point.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_POINT_HPP
#define SLIP_POINT_HPP

#include <iostream>
#include <cassert>
#include <algorithm>
#include "Block.hpp"

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

template <typename CoordType, std::size_t DIM>
class DPoint;

template <typename CoordType, std::size_t DIM>
class Point;

template <typename CoordType, std::size_t DIM>
std::ostream& operator<<(std::ostream & out, const Point<CoordType,DIM>& p);

template <typename CoordType, std::size_t DIM>
class Point
{
public :
  typedef CoordType value_type;
  typedef value_type* pointer;
  typedef const value_type* const_pointer;
  typedef value_type& reference;
  typedef const value_type& const_reference;


  typedef DPoint<CoordType,DIM> dpoint_type;
  typedef Point<CoordType,DIM> self;

  //default iterator_category of the container
  typedef std::random_access_iterator_tag iterator_category;
  
  static const std::size_t SIZE = DIM;
  Point();
  
  Point(const self& other);


  Point(const CoordType* array);

  friend std::ostream& operator<< <>(std::ostream & out,  const self& p);

  self& operator=(const self & other);


  reference operator[](const std::size_t i);

  const_reference operator[](const std::size_t i) const;

  bool operator==(const self& other) const;

  bool operator!=(const self& other) const;
  self operator-() const;
  

  self& operator+=(const dpoint_type & dp);

  self operator+(const dpoint_type & dp) const;

  
  self& operator-=(const dpoint_type & dp);

  
  self operator-(const dpoint_type & dp) const;

  dpoint_type operator-(const self & other) const;

  std::size_t dim() const;
  
  std::size_t size() const;

  std::size_t max_size() const;

  bool empty()const;


  
  const block<value_type,DIM>& coord() const;
 
  block<value_type,DIM>& coord();
 


  void swap(self& other);

protected:

 
 
  block<value_type,DIM> coord_;

protected:
friend class boost::serialization::access;
  template<class Archive>
    void save(Archive & ar, const unsigned int version) const
    {
      ar & coord_;
    }
   template<class Archive>
    void load(Archive & ar, const unsigned int version)
    {
      ar & coord_;
    }
  BOOST_SERIALIZATION_SPLIT_MEMBER()

 };
}//slip::

namespace slip
{

  template<typename CoordType,std::size_t DIM>
  inline
  Point<CoordType,DIM>::Point()
  {
    std::fill_n((this->coord_).begin(),DIM,CoordType());
  }

  template<typename CoordType,std::size_t DIM>
  inline
  Point<CoordType,DIM>::Point(const Point<CoordType,DIM>& other):
    coord_(other.coord_)
  {}

  template<typename CoordType,std::size_t DIM>
  inline
  Point<CoordType,DIM>::Point(const CoordType* array)
  {
    std::copy(array,array+DIM,coord_.begin());
  }

  template<typename CoordType,std::size_t DIM>
  inline
  std::ostream& operator<<(std::ostream & out, 
                                                                  const Point<CoordType,DIM>& p)
  {
    out<<p.coord_;
    return out;
  }

  
  template<typename CoordType,std::size_t DIM>
  inline
  Point<CoordType,DIM>& Point<CoordType,DIM>::operator=(const Point<CoordType,DIM> & other)
  {
    if(this != &other)
      {
                this->coord_ = other.coord_;
      }
    return *this;
  }
  
 
  template<typename CoordType,std::size_t DIM>
  inline
  CoordType& Point<CoordType,DIM>::operator[](const std::size_t i)
  {
    assert(i < DIM);
    return this->coord_[i];
  }
  
  template<typename CoordType,std::size_t DIM>
  inline
  const CoordType& Point<CoordType,DIM>::operator[](const std::size_t i) const 
  {
    assert(i < DIM);
    return this->coord_[i];
  }
  
  template<typename CoordType,std::size_t DIM>
  inline
  std::size_t Point<CoordType,DIM>::dim() const {return DIM;} 
  
  template<typename CoordType,std::size_t DIM>
  inline
  std::size_t Point<CoordType,DIM>::size() const {return DIM;}

  template<typename CoordType,std::size_t DIM>
  inline
  std::size_t Point<CoordType,DIM>::max_size() const {return DIM;}

  template<typename CoordType,std::size_t DIM>
  inline
  bool Point<CoordType,DIM>::empty()const {return coord_.empty();}


  template<typename CoordType,std::size_t DIM>
  inline
  const block<CoordType,DIM>& Point<CoordType,DIM>::coord() const
  {
    return coord_;
  }

  template<typename CoordType,std::size_t DIM>
  inline
  block<CoordType,DIM>& Point<CoordType,DIM>::coord()
  {
    return coord_;
  }
  
  template<typename CoordType,std::size_t DIM>
  inline
  void Point<CoordType,DIM>::swap(Point<CoordType,DIM>& other)
  {
    (this->coord_).swap(other.coord_);
  }
  

  template<typename CoordType,std::size_t DIM>
  inline
  bool Point<CoordType,DIM>::operator==(const Point<CoordType,DIM>& other) const
  {
    return this->coord_ == other.coord_;
  }
  
  template<typename CoordType,std::size_t DIM>
  inline
  bool Point<CoordType,DIM>::operator!=(const Point<CoordType,DIM>& other) const
  {
    return this->coord_ != other.coord_;
  }

 
  template<typename CoordType,std::size_t DIM>
  inline
  Point<CoordType,DIM> Point<CoordType,DIM>::operator-() const
  {
    Point<CoordType,DIM> tmp;
    std::transform(coord_.begin(),coord_.end(),(tmp.coord_).begin(),std::negate<CoordType>());
    return tmp; 
  }

  template<typename CoordType,std::size_t DIM>
  inline
  Point<CoordType,DIM>& Point<CoordType,DIM>::operator+=(const DPoint<CoordType,DIM>& dp)
  {
   
    for(std::size_t i = 0; i < DIM; ++i)
      {
                this->coord_[i] += dp[i];
      }
    return *this; 
  }


  template<typename CoordType,std::size_t DIM>
  inline
  Point<CoordType,DIM> Point<CoordType,DIM>::operator+(const DPoint<CoordType,DIM>& dp) const
  {
    Point<CoordType,DIM> tmp(*this);
    tmp+=dp;
    return tmp; 
  }

  template<typename CoordType,std::size_t DIM>
  inline
  Point<CoordType,DIM>& Point<CoordType,DIM>::operator-=(const DPoint<CoordType,DIM>& dp)
  {
   
    for(std::size_t i = 0; i < DIM; ++i)
      {
                this->coord_[i] -= dp[i];
      }
    return *this; 
  }

    template<typename CoordType,std::size_t DIM>
  inline
  Point<CoordType,DIM> Point<CoordType,DIM>::operator-(const DPoint<CoordType,DIM>& dp) const
  {
    Point<CoordType,DIM> tmp(*this);
    tmp-=dp;
    return tmp; 
  }

  template<typename CoordType,std::size_t DIM>
  inline
  DPoint<CoordType,DIM> Point<CoordType,DIM>::operator-(const Point<CoordType,DIM>& p) const
  {
    block<CoordType,DIM> tmp;
    std::transform(coord_.begin(),coord_.end(),(p.coord_).begin(),tmp.begin(),std::minus<CoordType>());
    return DPoint<CoordType,DIM>(tmp.begin()); 
  }

}//slip::

#endif //SLIP_POINT_HPP