COBANaivePlane.h

#pragma once

#if defined(COBANaivePlane_RECURSES)
#error Recursive header files inclusion detected in COBANaivePlane.h
#else // defined(COBANaivePlane_RECURSES)

#define COBANaivePlane_RECURSES

#if !defined COBANaivePlane_h

#define COBANaivePlane_h

// Inclusions
#include <iostream>
#include <set>
#include "DGtal/base/Common.h"
#include "DGtal/kernel/CInteger.h"
#include "DGtal/kernel/CSpace.h"
#include "DGtal/kernel/SpaceND.h"
#include "DGtal/kernel/PointVector.h"
#include "DGtal/arithmetic/IntegerComputer.h"
#include "DGtal/arithmetic/LatticePolytope2D.h"

namespace DGtal
{

  // template class COBANaivePlane
  template < typename TSpace, 
             typename TInternalInteger >
  class COBANaivePlane
  {

    BOOST_CONCEPT_ASSERT(( CSpace< TSpace > ));
    BOOST_CONCEPT_ASSERT(( CInteger< TInternalInteger > ));
    BOOST_STATIC_ASSERT(( TSpace::dimension == 3 ));

    // ----------------------- public types ------------------------------
  public:
    typedef TSpace Space;
    typedef typename Space::Point Point;
    typedef std::set< Point > PointSet;
    typedef typename PointSet::size_type Size;
    typedef typename PointSet::const_iterator ConstIterator;
    typedef typename PointSet::iterator Iterator;
    typedef TInternalInteger InternalInteger;
    typedef IntegerComputer< InternalInteger > MyIntegerComputer;

    // ----------------------- std public types ------------------------------
  public:
    typedef typename PointSet::const_iterator const_iterator;
    typedef typename PointSet::const_pointer const_pointer;
    typedef typename PointSet::const_reference const_reference;
    typedef typename PointSet::value_type value_type;
    typedef typename PointSet::difference_type difference_type;
    typedef typename PointSet::size_type size_type;

    // ----------------------- internal types ------------------------------
  private:
    typedef PointVector< 3, InternalInteger > InternalPoint3;
    typedef SpaceND< 2, InternalInteger > InternalSpace2;
    typedef typename InternalSpace2::Point InternalPoint2;
    typedef LatticePolytope2D< InternalSpace2 > ConvexPolygonZ2;
    typedef typename ConvexPolygonZ2::HalfSpace HalfSpace;

    struct State {
      InternalInteger max;     
      InternalInteger min;     
      Point ptMax;             
      Point ptMin;             
      ConvexPolygonZ2 cip;     
      InternalPoint3 centroid; 
      InternalPoint3 N;        
    };

    // ----------------------- Standard services ------------------------------
  public:

    ~COBANaivePlane();

    COBANaivePlane();

    COBANaivePlane ( const COBANaivePlane & other );

    COBANaivePlane & operator= ( const COBANaivePlane & other );

    MyIntegerComputer & ic() const;

    void clear();

    void init( Dimension axis, InternalInteger diameter, 
               InternalInteger widthNumerator = NumberTraits< InternalInteger >::ONE, 
               InternalInteger widthDenominator = NumberTraits< InternalInteger >::ONE );

    Size complexity() const;

    //-------------------- model of ForwardContainer -----------------------------
  public:

    Size size() const;

    bool empty() const;

    ConstIterator begin() const;

    ConstIterator end() const;

    Size max_size() const;

    Size maxSize() const;


    //-------------------- model of CPointPredicate -----------------------------
  public:

    bool operator()( const Point & p ) const;

    //-------------------- model of CIncrementalPrimitiveComputer -----------------------------
  public:

    bool extendAsIs( const Point & p );

    bool extend( const Point & p );

    bool isExtendable( const Point & p ) const;

    //-------------------- model of CAdditivePrimitiveComputer -----------------------------
  public:

    template <typename TInputIterator>
    bool extend( TInputIterator it, TInputIterator itE );

    template <typename TInputIterator>
    bool isExtendable( TInputIterator it, TInputIterator itE ) const;

    //-------------------- Parameters services -----------------------------
  public:

    template <typename Vector3D>
    void getNormal( Vector3D & normal ) const;

    template <typename Vector3D>
    void getUnitNormal( Vector3D & normal ) const;

    void getBounds( double & min, double & max ) const;

    const Point & minimalPoint() const;

    const Point & maximalPoint() const;

    // ----------------------- Interface --------------------------------------
  public:

    void selfDisplay ( std::ostream & out ) const;

    bool isValid() const;

    // ------------------------- Private Datas --------------------------------
  private:
    Dimension myAxis;          
    InternalInteger myG;       
    InternalPoint2 myWidth;    
    PointSet myPointSet;       
    State myState;             
    InternalInteger myCst1;    
    InternalInteger myCst2;    
    mutable InternalInteger _v;
    mutable State _state;      
    mutable InternalPoint2 _grad; 
    // ------------------------- Hidden services ------------------------------
  protected:


    // ------------------------- Internals ------------------------------------
  private:

    void computeCentroidAndNormal( State & state ) const;

    void doubleCut( InternalPoint2 & grad, State & state ) const;

    template <typename TInputIterator>
    void computeMinMax( State & state, TInputIterator itB, TInputIterator itE ) const;

    template <typename TInputIterator>
    bool updateMinMax( State & state, TInputIterator itB, TInputIterator itE ) const;

    bool checkPlaneWidth( const State & state ) const;

    void computeGradient( InternalPoint2 & grad, const State & state ) const;

  }; // end of class COBANaivePlane


  template <typename TSpace, typename TInternalInteger>
  std::ostream&
  operator<< ( std::ostream & out, const COBANaivePlane<TSpace, TInternalInteger> & object );

} // namespace DGtal


// Includes inline functions.
#include "DGtal/geometry/surfaces/COBANaivePlane.ih"

//                                                                           //

#endif // !defined COBANaivePlane_h

#undef COBANaivePlane_RECURSES
#endif // else defined(COBANaivePlane_RECURSES)