propagate_node.hh

// Copyright (C) 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_MORPHO_TREE_PROPAGATE_NODE_HH
# define MLN_MORPHO_TREE_PROPAGATE_NODE_HH

# include <mln/core/concept/image.hh>
# include <mln/core/macros.hh>
# include <mln/morpho/tree/data.hh>



namespace mln
{

  namespace morpho
  {

    namespace tree
    {

      template <typename T, typename A>
      void
      propagate_node_to_descendants(mln_psite(A) n,
                                    const T& t,
                                    Image<A>& a_,
                                    const mln_value(A)& v,
                                    unsigned* nb_leaves = 0);

      template <typename T, typename A>
      inline
      void
      propagate_node_to_descendants(mln_psite(A)& n,
                                    const T& t,
                                    Image<A>& a_,
                                    unsigned* nb_leaves = 0);


      template <typename T, typename A>
      void
      propagate_node_to_ancestors(mln_psite(A) n,
                                  const T& t,
                                  Image<A>& a_,
                                  const mln_value(A)& v);

      template <typename T, typename A>
      inline
      void
      propagate_node_to_ancestors(mln_psite(A) n,
                                  const T& t,
                                  Image<A>& a_);


# ifndef MLN_INCLUDE_ONLY

      /* Descendants propagation */

      template <typename T, typename A>
      inline
      void
      propagate_node_to_descendants(mln_psite(A) n,
                                    const T& t,
                                    Image<A>& a_,
                                    const mln_value(A)& v,
                                    unsigned* nb_leaves = 0)
      {
        A& a = exact(a_);
        mln_precondition(a.is_valid());
        mln_precondition(a.domain() == t.f().domain());
        mln_precondition(a.domain().has(n));


        if (!t.is_a_node(n)) // Get the representant.
          n = t.parent(n);
        mln_assertion(t.is_a_node(n));

        typename T::depth1st_piter pp(t, n);

        pp.start(); // We don't set n to v.

        if (nb_leaves)
          *nb_leaves += t.is_a_leaf(pp);

        for (pp.next(); pp.is_valid(); pp.next())
          {
            a(pp) = v;
            if (nb_leaves && t.is_a_leaf(pp))
              ++(*nb_leaves);
          }
      }


      template <typename T, typename A>
      inline
      void
      propagate_node_to_descendants(mln_psite(A) n,
                                    const T& t,
                                    Image<A>& a_,
                                    unsigned* nb_leaves = 0)

      {
        A& a = exact(a_);
        propagate_node_to_descendants(n, t, a, a(n), nb_leaves);
      }


      /* Ancestors propagation */

      template <typename T, typename A>
      void
      propagate_node_to_ancestors(mln_psite(A) n,
                                  const T& t,
                                  Image<A>& a_,
                                  const mln_value(A)& v)
      {
        A& a = exact(a_);
        mln_precondition(a.is_valid());
        mln_precondition(a.domain() == t.f().domain());
        mln_precondition(a.domain().has(n));

        if (!t.is_a_node(n)) // Get the representant.
          n = t.parent(n);
        mln_assertion(t.is_a_node(n));

        if (t.is_root(n))
          return;

        do {
          n = t.parent(n);
          a(n) = v;
        } while (!t.is_root(n));

      }

      template <typename T, typename A>
      inline
      void
      propagate_node_to_ancestors(mln_psite(A) n,
                                  const T& t,
                                  Image<A>& a_)
      {
        A& a = exact(a_);
        propagate_node_to_ancestors(n, t, a, a(n));
      }

# endif // ! MLN_INCLUDE_ONLY

    } // end of namespace mln::morpho::tree

  } // end of namespace mln::morpho

} // end of namespace mln

#endif // ! MLN_MORPHO_TREE_PROPAGATE_NODE_HH