algebraic_face.hh

// Copyright (C) 2008, 2009, 2010 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_TOPO_ALGEBRAIC_FACE_HH
# define MLN_TOPO_ALGEBRAIC_FACE_HH


#include <mln/topo/face.hh>
#include <mln/topo/algebraic_n_face.hh>


namespace mln
{

  namespace topo
  {

    // Forward declarations.
    template <unsigned D> class complex;
    template <unsigned N, unsigned D> class n_face;
    template <unsigned N, unsigned D> class face_data;


    /*-------.
    | Face.  |
    `-------*/

    template <unsigned D>
    class algebraic_face : public face<D>
    {
      typedef face<D> super_;

    public:
      // The type of the complex this handle points to.
      typedef complex<D> complex_type;

      algebraic_face();
      algebraic_face(complex<D>& complex, unsigned n, unsigned face_id,
                     bool sign);
      algebraic_face(const face<D>& f, bool sign);

      template <unsigned N>
      algebraic_face(const algebraic_n_face<N, D>& f);

      bool sign() const;
      void set_sign(bool sign);

    private:
      bool sign_;
    };


    template <unsigned D>
    algebraic_face<D>
    make_algebraic_face(const face<D>& f, bool sign);


    template <unsigned D>
    algebraic_face<D>
    operator-(const face<D>& f);

    template <unsigned D>
    algebraic_face<D>
    operator-(const algebraic_face<D>& f);



    template <unsigned D>
    bool operator==(const algebraic_face<D>& lhs,
                    const algebraic_face<D>& rhs);

    template <unsigned D>
    bool operator!=(const algebraic_face<D>& lhs,
                    const algebraic_face<D>& rhs);

    template <unsigned D>
    bool operator< (const algebraic_face<D>& lhs,
                    const algebraic_face<D>& rhs);



    template <unsigned D>
    std::ostream&
    operator<<(std::ostream& ostr, const algebraic_face<D>& f);



# ifndef MLN_INCLUDE_ONLY

    template <unsigned D>
    inline
    algebraic_face<D>::algebraic_face()
      : super_(), sign_(true)
    {
    }

    template <unsigned D>
    inline
    algebraic_face<D>::algebraic_face(complex<D>& c, unsigned n,
                                      unsigned face_id, bool sign)
      : super_(c, n, face_id), sign_(sign)
    {
      // Ensure N is compatible with D.
      mln_precondition(n <= D);
    }

    template <unsigned D>
    inline
    algebraic_face<D>::algebraic_face(const face<D>& f, bool sign)
      : super_(f), sign_(sign)
    {
      // Ensure N is compatible with D.
      mln_precondition(f.n() <= D);
    }

    template <unsigned D>
    template <unsigned N>
    inline
    algebraic_face<D>::algebraic_face(const algebraic_n_face<N, D>& f)
      : super_(f), sign_(f.sign())
    {
      // Ensure N is compatible with D.
      metal::bool_< N <= D >::check();
    }


    template <unsigned D>
    inline
    bool
    algebraic_face<D>::sign() const
    {
      return sign_;
    }

    template <unsigned D>
    inline
    void
    algebraic_face<D>::set_sign(bool sign)
    {
      sign_ = sign;
    }


    template <unsigned D>
    algebraic_face<D>
    make_algebraic_face(const face<D>& f, bool sign)
    {
      return algebraic_face<D>(f, sign);
    }


    template <unsigned D>
    algebraic_face<D>
    operator-(const face<D>& f)
    {
      return algebraic_face<D>(f, false);
    }

    template <unsigned D>
    algebraic_face<D>
    operator-(const algebraic_face<D>& f)
    {
      algebraic_face<D> f2(f);
      f2.set_sign(!f.sign());
      return f2;
    }


    template <unsigned D>
    inline
    bool
    operator==(const algebraic_face<D>& lhs, const algebraic_face<D>& rhs)
    {
      // Ensure LHS and RHS belong to the same complex.
      mln_precondition(lhs.cplx() == rhs.cplx());
      return
        lhs.n() == rhs.n() &&
        lhs.face_id() == rhs.face_id() &&
        lhs.sign() == rhs.sign();
    }

    template <unsigned D>
    inline
    bool
    operator!=(const algebraic_face<D>& lhs, const algebraic_face<D>& rhs)
    {
      // Ensure LHS and RHS belong to the same complex.
      mln_precondition(lhs.cplx() == rhs.cplx());
      return !(lhs == rhs);
    }

    template <unsigned D>
    inline
    bool
    operator< (const algebraic_face<D>& lhs, const algebraic_face<D>& rhs)
    {
      // Ensure LHS and RHS belong to the same complex.
      mln_precondition(lhs.cplx() == rhs.cplx());
      // Ensure LHS and RHS have the same dimension.
      mln_precondition(lhs.n() == rhs.n());
      return lhs.face_id() < rhs.face_id();
    }


    template <unsigned D>
    inline
    std::ostream&
    operator<<(std::ostream& ostr, const algebraic_face<D>& f)
    {
      return
        ostr << "(cplx = " << f.cplx().addr() << ", dim = " << f.n()
             << ", id = " << f.face_id() << ", sign = " << f.sign()<< ')';
    }


    /*-----------------------------------------------.
    | Helpers for face<D>::lower_dim_adj_faces() and |
    | face<D>::higher_dim_adj_faces().               |
    `-----------------------------------------------*/

    /* FIXME: This is way too complicated; should disappear when the
       implementation of complexes is simplified (see
       https://trac.lrde.org/olena/ticket/168).  */

    namespace internal
    {

      template <unsigned N, unsigned D>
      std::vector< algebraic_face<D> > 
      lower_dim_adj_faces_if_dim_matches_<N, D>::operator()(const face<D>& face)
      {
        metal::bool_< (N <= D) >::check();
        metal::bool_< (N > 1) >::check();

        if (face.n() == N)
          {
            face_data<N, D>& data = face.template data<N>();
            std::vector< algebraic_n_face<N - 1, D> > lower_dim_faces =
              data.lower_dim_faces_;
            std::vector< topo::algebraic_face<D> > result;
            for (typename std::vector< algebraic_n_face<N - 1, D> >::const_iterator f =
                   lower_dim_faces.begin(); f != lower_dim_faces.end(); ++f)
              result.push_back(*f);
            return result;
          }
        else
          return internal::lower_dim_adj_faces_if_dim_matches_<N - 1, D>()(face);
      }

      template <unsigned D>
      std::vector< algebraic_face<D> > 
      lower_dim_adj_faces_if_dim_matches_<1, D>::operator()(const face<D>& face)
      {
        mln_precondition(face.n() == 1);
        face_data<1, D>& data = face.template data<1>();
        std::vector< algebraic_n_face<0, D> > lower_dim_faces =
          data.lower_dim_faces_;
        std::vector< topo::algebraic_face<D> > result;
        for (typename std::vector< algebraic_n_face<0, D> >::const_iterator f =
               lower_dim_faces.begin(); f != lower_dim_faces.end(); ++f)
          result.push_back(*f);
        return result;
      }

      template <unsigned N, unsigned D>
      std::vector< algebraic_face<D> > 
      higher_dim_adj_faces_if_dim_matches_<N, D>::operator()(const face<D>& face)
      {
        metal::bool_< (N < D) >::check();

        if (face.n() == N)
          {
            face_data<N, D>& data = face.template data<N>();
            std::vector< algebraic_n_face<N + 1, D> > higher_dim_faces =
              data.higher_dim_faces_;
            std::vector< topo::algebraic_face<D> > result;
            for (typename std::vector< algebraic_n_face<N + 1, D> >::const_iterator f =
                   higher_dim_faces.begin(); f != higher_dim_faces.end(); ++f)
              result.push_back(*f);
            return result;
          }
        else
          return
            internal::higher_dim_adj_faces_if_dim_matches_<N - 1, D>()(face);
      }

      template <unsigned D>
      std::vector< algebraic_face<D> > 
      higher_dim_adj_faces_if_dim_matches_<0, D>::operator()(const face<D>& face)
      {
        mln_precondition(face.n() == 0);
        face_data<0, D>& data = face.template data<0>();
        std::vector< algebraic_n_face<1, D> > higher_dim_faces =
          data.higher_dim_faces_;
        std::vector< topo::algebraic_face<D> > result;
        for (typename std::vector< algebraic_n_face<1, D> >::const_iterator f =
               higher_dim_faces.begin(); f != higher_dim_faces.end(); ++f)
          result.push_back(*f);
        return result;
      }

    } // end of namespace mln::topo::internal


# endif // ! MLN_INCLUDE_ONLY

  } // end of namespace mln::topo

} // end of namespace mln

#endif // ! MLN_TOPO_ALGEBRAIC_FACE_HH