Predictor.h

Go to the documentation of this file.

// Copyright (c) 2012-2022 University of Lyon and CNRS (France).
// All rights reserved.
//
// This file is part of MEPP2; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 3 of
// the License, or (at your option) any later version.
//
// This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
// WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 
#pragma once
 
#include <boost/graph/graph_traits.hpp>
#include <boost/graph/properties.hpp>
#include <CGAL/boost/graph/iterator.h>
 
#include "FEVV/Wrappings/Geometry_traits.h"
 
#include "FEVV/Filters/CGAL/Progressive_Compression/Operators/Kept_position.h"
#include "FEVV/Filters/CGAL/Progressive_Compression/Compression/Collapse_info.h"
 
#include <vector>
#include <utility>
 
namespace FEVV {
namespace Filters {
 
template<
    typename HalfedgeGraph,
    typename PointMap>
class Predictor
{
public:
    using vertex_descriptor =
      typename boost::graph_traits< HalfedgeGraph >::vertex_descriptor;
    using halfedge_descriptor =
            typename boost::graph_traits< HalfedgeGraph >::halfedge_descriptor;
    using face_descriptor =
            typename boost::graph_traits< HalfedgeGraph >::face_descriptor;
    using Vector = typename FEVV::Geometry_traits< HalfedgeGraph >::Vector;
    using Point = typename FEVV::Geometry_traits< HalfedgeGraph >::Point;
    using Geometry = typename FEVV::Geometry_traits< HalfedgeGraph >;
  Predictor(
      HalfedgeGraph &g,
      Kept_position< HalfedgeGraph, PointMap >
          *kp,
      PointMap &pm)
      : _g(g), _gt(Geometry(_g)), _pm(pm)
  {
    _kp = kp;
    _kept_position = Point(0, 0, 0);
  }
  virtual ~Predictor(){}
 
  virtual std::vector< Vector >
  compute_residuals(Collapse_info< HalfedgeGraph, PointMap > &mem) = 0;
  
  virtual std::pair< Point, Point >
  place_points(const std::vector< Vector > &residuals,
              vertex_descriptor vkept, 
              halfedge_descriptor h1, 
              halfedge_descriptor h2 
              ) = 0;
 
  virtual FEVV::Filters::PREDICTION_TYPE get_type() const { return _type; }
  
  virtual void set_rev(bool /*b*/) = 0;
  
  virtual const Point& get_kept_position() const { return _kept_position; }
 
  virtual FEVV::Filters::VKEPT_POSITION get_type_KP() const { return _kp->get_type(); }
 
 
  virtual std::string get_as_string() const = 0;
 
  int get_nb_residuals() const { return _nbResiduals; }
protected:
  Kept_position< HalfedgeGraph, PointMap >
      *_kp;
  HalfedgeGraph &_g;
  const Geometry _gt;
  PointMap &_pm;
  int _nbResiduals;
  Point _kept_position;
  FEVV::Filters::PREDICTION_TYPE _type;
};
} // namespace Filters
} // namespace FEVV