point.hh

// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE)
//
// This file is part of Olena.
//
// Olena is free software: you can redistribute it and/or modify it under
// the terms of the GNU General Public License as published by the Free
// Software Foundation, version 2 of the License.
//
// Olena is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Olena.  If not, see <http://www.gnu.org/licenses/>.
//
// As a special exception, you may use this file as part of a free
// software project without restriction.  Specifically, if other files
// instantiate templates or use macros or inline functions from this
// file, or you compile this file and link it with other files to produce
// an executable, this file does not by itself cause the resulting
// executable to be covered by the GNU General Public License.  This
// exception does not however invalidate any other reasons why the
// executable file might be covered by the GNU General Public License.

#ifndef MLN_CORE_CONCEPT_POINT_HH
# define MLN_CORE_CONCEPT_POINT_HH

# include <mln/core/concept/point_site.hh>
# include <mln/core/concept/dpoint.hh>
# include <mln/value/concept/scalar.hh>


namespace mln
{

  // Fwd decl.
  template <typename E> struct Point;


  // Point category flag type.
  template <>
  struct Point<void>
  {
    typedef Point_Site<void> super;
  };


  template <typename P>
  struct Point : public Point_Site<P>
  {
    typedef P point;

    const P& to_point() const;

  protected:
    Point();
  };


  template <typename P, typename D>
  P& operator+=(Point<P>& p, const Dpoint<D>& dp);


  template <typename P, typename D>
  P& operator-=(Point<P>& p, const Dpoint<D>& dp);

  template <typename P, typename D>
  P& operator/(Point<P>& p, const value::Scalar<D>& dp);

  // FIXME : add operators and traits?

# ifndef MLN_INCLUDE_ONLY

  template <typename P>
  inline
  Point<P>::Point()
  {
  }

  template <typename P>
  inline
  const P&
  Point<P>::to_point() const
  {
    return exact(*this);
  }

  template <typename P, typename D>
  inline
  P& operator+=(Point<P>& p_, const Dpoint<D>& dp_)
  {
    P& p = exact(p_);
    const D& dp = exact(dp_);
    // FIXME: Use to_vec()!
    for (unsigned i = 0; i < P::dim; ++i)
      p[i] += dp[i];
    return p;
  }

  template <typename P, typename D>
  inline
  P& operator-=(Point<P>& p_, const Dpoint<D>& dp_)
  {
    P& p = exact(p_);
    const D& dp = exact(dp_);
    // FIXME: Use to_vec()!
    for (unsigned i = 0; i < P::dim; ++i)
      p[i] -= dp[i];
    return p;
  }


  template <typename P, typename D>
  inline
  P&
  operator/(Point<P>& p_, const value::Scalar<D>& s_)
  {
    P& p = exact(p_);
    const D& s = exact(s_);
    for (unsigned i = 0; i < P::dim; ++i)
      p[i] /= s;
    return p;
  }

# endif // ! MLN_INCLUDE_ONLY

} // end of namespace mln



#endif // ! MLN_CORE_CONCEPT_POINT_HH