ClosedIntegerHalfPlane.h

#pragma once

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

#define ClosedIntegerHalfPlane_RECURSES

#if !defined ClosedIntegerHalfPlane_h

#define ClosedIntegerHalfPlane_h

// Inclusions
#include <iostream>
#include "DGtal/base/Common.h"
#include "DGtal/kernel/CSpace.h"

namespace DGtal
{

  // template class ClosedIntegerHalfPlane
  template <typename TSpace>
  struct ClosedIntegerHalfPlane
  {
    typedef ClosedIntegerHalfPlane<TSpace> Self;
    BOOST_CONCEPT_ASSERT(( CSpace< TSpace > ));
    
    typedef TSpace Space;
    typedef typename Space::Integer Integer;
    typedef typename Space::Point Point;
    typedef typename Space::Vector Vector;
    
    // ----------------------- public data ------------------------------
  public:

    Vector N; //<! The normal to the half-space.
    Integer c; //<! The uppermost value N.(x,y) that is in the half-space.

  protected:
    // mutable Integer _d; //<! used for computation (avoids reallocation when Integer is a BigInteger).
    // ----------------------- Standard services ------------------------------
  public:
    ~ClosedIntegerHalfPlane();

    ClosedIntegerHalfPlane( const Vector & aN, const Integer & aC );
    
    ClosedIntegerHalfPlane( const Point & A, const Point & B, 
                            const Point & inP, IntegerComputer<Integer> & ic );

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

    bool isOnBoundary( const Point & p ) const;

    Vector tangent() const;

    void negate();

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

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

    bool isValid() const;

    // ------------------------- Protected Datas ------------------------------
  private:
    // ------------------------- Private Datas --------------------------------
  private:


  }; // end of class ClosedIntegerHalfPlane


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

} // namespace DGtal


// Includes inline functions.
#include "DGtal/arithmetic/ClosedIntegerHalfPlane.ih"

//                                                                           //

#endif // !defined ClosedIntegerHalfPlane_h

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