Add a queue of points.

	* tests/pqueue.cc: New.
	* TODO: Update.
	* mln/core/pvec.hh: Fix.
	* mln/core/pqueue.hh: New.


git-svn-id: https://svn.lrde.epita.fr/svn/oln/trunk@1043 4aad255d-cdde-0310-9447-f3009e2ae8c0

milena/ChangeLog

+2007-07-26  Thierry Geraud  <thierry.geraud@lrde.epita.fr>
+
+	Add a queue of points.
+
+	* tests/pqueue.cc: New.
+	* TODO: Update.
+	* mln/core/pvec.hh: Fix.
+	* mln/core/pqueue.hh: New.
+
 2007-07-26  Thierry Geraud  <thierry.geraud@lrde.epita.fr>
 
 	Add stack and transpose morphers.

milena/TODO

@@ -17,7 +17,6 @@ Weighted_Window
 
 value::proxy to dispatch read/write + the corresponding image type
 a mean_value object { sum; count } and operator+
-t_image to "transpose" the 0 and the i-th coordinates
 
 ** extensions
 
@@ -28,9 +27,6 @@ built-in op objects -> reverse lhs/rhs
 
 * renaming
 
-mlc into metal
-+ look for "same_grid" etc.
-rectangle2d, hlin2d, etc -> core/win/
 
 
 * clean-up

milena/mln/core/pqueue.hh

+// Copyright (C) 2007 EPITA Research and Development Laboratory
+//
+// This file is part of the Olena Library.  This library is free
+// software; you can redistribute it and/or modify it under the terms
+// of the GNU General Public License version 2 as published by the
+// Free Software Foundation.
+//
+// This library 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 this library; see the file COPYING.  If not, write to
+// the Free Software Foundation, 51 Franklin Street, Fifth Floor,
+// Boston, MA 02111-1307, USA.
+//
+// As a special exception, you may use this file as part of a free
+// software library 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_PQUEUE_HH
+# define MLN_CORE_PQUEUE_HH
+
+/*! \file mln/core/pqueue.hh
+ *
+ * \brief Definition of a point set class based on std::deque.
+ */
+
+# include <vector>
+# include <deque>
+# include <algorithm>
+# include <iterator>
+
+# include <mln/core/concept/point_set.hh>
+# include <mln/core/pvec_piter.hh>
+# include <mln/accu/bbox.hh>
+
+
+namespace mln
+{
+
+  // Fwd decls.
+  template <typename P> struct pvec_fwd_piter_;
+  template <typename P> struct pvec_bkd_piter_;
+
+
+  /*! \brief Point queue class (based on std::deque).
+   *
+   * This is a mathematical set of points (unique insertion).
+   *
+   * \todo Make it work with P being a Point_Site.
+   * \todo Add a parameter flag to choose another policy for "push"
+   * (i.e., no-op if multiple or allow multiple insertions).
+   *
+   * \warning We have some troubles with point set comparison based on
+   * a call to npoints() when this container is multiple.
+   */
+  template <typename P>
+  class pqueue : public Point_Set< pqueue<P> >
+  {
+  public:
+
+    /// Point associated type.
+    typedef P point;
+
+    /// Point_Site associated type.
+    typedef P psite;
+
+    /// Forward Point_Iterator associated type.
+    typedef pvec_fwd_piter_<P> fwd_piter;
+
+    /// Backward Point_Iterator associated type.
+    typedef pvec_bkd_piter_<P> bkd_piter;
+
+    /// Constructor.
+    pqueue();
+
+    /// Test is \p p belongs to this point set.
+    bool has(const P& p) const;
+
+    /// Give the number of points.
+    std::size_t npoints() const;
+
+    /// Give the exact bounding box.
+    const box_<P>& bbox() const;
+
+    /// Push a point \p p in the queue.
+    pqueue<P>& push(const P& p);
+
+    /// Pop (remove) the front point \p p from the queue; \p p is the
+    /// least recently inserted point.
+    void pop();
+
+    /// Give the front point \p p of the queue; \p p is the least
+    /// recently inserted point.
+    const P& front() const;
+
+    /// Clear the queue.
+    void clear();
+
+    /// Return the corresponding std::vector of points.
+    const std::vector<P>& vect() const;
+
+    /// Return the \p i-th point.
+    const P& operator[](unsigned i) const;
+
+  protected:
+
+    std::deque<P> q_;
+
+    mutable std::vector<P> vect_;
+    mutable bool vect_needs_update_;
+    void vect_update_() const;
+
+    mutable accu::bbox<P> bb_;
+    mutable bool bb_needs_update_;
+    void bb_update_() const;
+
+  };
+
+
+
+# ifndef MLN_INCLUDE_ONLY
+
+  template <typename P>
+  pqueue<P>::pqueue()
+  {
+    vect_needs_update_ = false;
+    bb_needs_update_ = false;
+  }
+
+  template <typename P>
+  void
+  pqueue<P>::vect_update_() const
+  {
+    vect_.clear();
+    vect_.reserve(q_.size());
+    std::copy(q_.begin(), q_.end(),
+	      std::back_inserter(vect_));
+    vect_needs_update_ = false;
+  }
+
+  template <typename P>
+  void
+  pqueue<P>::bb_update_() const
+  {
+    bb_.init();
+    for (unsigned i = 0; i < q_.size(); ++i)
+      bb_.take(q_[i]);
+    bb_needs_update_ = false;
+  }
+
+  template <typename P>
+  bool
+  pqueue<P>::has(const P& p) const
+  {
+    for (unsigned i = 0; i < q_.size(); ++i)
+      if (q_[i] == p)
+	return true;
+    return false;
+  }
+
+  template <typename P>
+  std::size_t
+  pqueue<P>::npoints() const
+  {
+    return q_.size();
+  }
+
+  template <typename P>
+  const box_<P>&
+  pqueue<P>::bbox() const
+  {
+    mln_precondition(npoints() != 0);
+    if (bb_needs_update_)
+      bb_update_();
+    return bb_.to_value();
+  }
+
+  template <typename P>
+  pqueue<P>&
+  pqueue<P>::push(const P& p)
+  {
+    mln_precondition(! has(p));
+    // FIXME: Our choice is "error if multiple insertions"
+    q_.push_back(p);
+    if (! vect_needs_update_)
+      {
+	vect_needs_update_ = true;
+	bb_needs_update_ = true;
+      }
+  }
+
+  template <typename P>
+  void
+  pqueue<P>::pop()
+  {
+    q_.pop_front();
+    if (! vect_needs_update_)
+      {
+	vect_needs_update_ = true;
+	bb_needs_update_ = true;
+      }
+  }
+
+  template <typename P>
+  const P&
+  pqueue<P>::front() const
+  {
+    mln_precondition(! q_.empty());
+    return q_.front();
+  }
+
+  template <typename P>
+  void
+  pqueue<P>::clear()
+  {
+    q_.clear();
+    vect_.clear();
+    vect_needs_update_ = false;
+    bb_needs_update_ = false;
+  }
+
+  template <typename P>
+  const std::vector<P>&
+  pqueue<P>::vect() const
+  {
+    if (vect_needs_update_)
+      vect_update_();
+    return vect_;
+  }
+
+  template <typename P>
+  const P&
+  pqueue<P>::operator[](unsigned i) const
+  {
+    mln_precondition(i < npoints());
+    return q_[i];
+  }
+
+# endif // ! MLN_INCLUDE_ONLY
+
+} // end of namespace mln
+
+
+#endif // ! MLN_CORE_PQUEUE_HH

milena/mln/core/pvec.hh

@@ -106,7 +106,7 @@ namespace mln
     mutable accu::bbox<P> bb_;
     mutable bool bb_needs_update_;
 
-    void update_bb_();
+    void update_bb_() const;
     // FIXME: Add invariant  bb_.is_valid() <=> npoints() != 0
   };
 
@@ -129,9 +129,9 @@ namespace mln
 
   template <typename P>
   void
-  pvec<P>::update_bb_()
+  pvec<P>::update_bb_() const
   {
-    bb_.clear();
+    bb_.init();
     for (unsigned i = 0; i < vect_.size(); ++i)
       bb_.take(vect_[i]);
     bb_needs_update_ = false;
@@ -169,6 +169,8 @@ namespace mln
   pvec<P>::append(const P& p)
   {
     vect_.push_back(p);
+    if (! bb_needs_update_)
+      bb_needs_update_ = true;
     return *this;
   }
 

milena/tests/pqueue.cc

+// Copyright (C) 2007 EPITA Research and Development Laboratory
+//
+// This file is part of the Olena Library.  This library is free
+// software; you can redistribute it and/or modify it under the terms
+// of the GNU General Public License version 2 as published by the
+// Free Software Foundation.
+//
+// This library 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 this library; see the file COPYING.  If not, write to
+// the Free Software Foundation, 51 Franklin Street, Fifth Floor,
+// Boston, MA 02111-1307, USA.
+//
+// As a special exception, you may use this file as part of a free
+// software library 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.
+
+/*! \file tests/pqueue.cc
+ *
+ * \brief Tests on mln::pqueue.
+ */
+
+#include <mln/core/point2d.hh>
+#include <mln/core/pqueue.hh>
+
+
+
+int main()
+{
+  using namespace mln;
+
+  pqueue<point2d> q;
+  q
+    .push(make::point2d(6, 9))
+    .push(make::point2d(5, 1))
+    .push(make::point2d(4, 2));
+  mln_assertion(q.npoints() == 3);
+
+  std::cout << q.bbox() << std::endl;
+  std::cout << q << std::endl;
+
+  q.pop();
+  mln_assertion(q.npoints() == 2);
+  point2d p = q.front();
+  mln_assertion(q.npoints() == 2);
+  mln_assertion(p == make::point2d(5, 1));
+}