DGtal::QuickHull< TKernel >::Facet Struct Reference

#include <DGtal/geometry/tools/QuickHull.h>

Public Member Functions
	Facet ()=default
	Facet (const Facet &)=default
	Facet (Facet &&)=default
Facet &	operator= (Facet &&)=default
Facet &	operator= (const Facet &)=default
	Facet (const HalfSpace &aH, Index b)
void	clear ()
void	addPointOn (Index p)
void	display (std::ostream &out) const
void	addNeighbor (Index n)
void	subNeighbor (Index n)
void	swap (Facet &other)
Size	variableMemory () const

Data Fields
HalfSpace	H
	the facet geometry More...
IndexRange	neighbors
	neighbor facets More...
IndexRange	outside_set
	outside set, i.e. points above this facet More...
IndexRange	on_set
	on set, i.e. points on this facet, sorted More...
Index	below
	index of point that is below this facet More...

Detailed Description

template<typename TKernel>
struct DGtal::QuickHull< TKernel >::Facet

A facet is d-1 dimensional convex cell lying on the boundary of a full dimensional convex set. Its supporting hyperplane defines an half-space touching and enclosing the convex set.

Definition at line 160 of file QuickHull.h.

Constructor & Destructor Documentation

Facet() [1/4]

template<typename TKernel >

DGtal::QuickHull< TKernel >::Facet::Facet ( )

default

Facet() [2/4]

template<typename TKernel >

DGtal::QuickHull< TKernel >::Facet::Facet ( const Facet &  )

default

Facet() [3/4]

template<typename TKernel >

DGtal::QuickHull< TKernel >::Facet::Facet ( Facet &&  )

default

Facet() [4/4]

template<typename TKernel >

DGtal::QuickHull< TKernel >::Facet::Facet ( const HalfSpace &  aH, Index  b  )

inline

Definition at line 172 of file QuickHull.h.

        : H( aH ), below( b ) {}

Member Function Documentation

addNeighbor()

template<typename TKernel >

void DGtal::QuickHull< TKernel >::Facet::addNeighbor ( Index  n )

inline

Definition at line 201 of file QuickHull.h.

      {
        const auto it = std::find( neighbors.cbegin(), neighbors.cend(), n );
        if ( it == neighbors.cend() ) neighbors.push_back( n );
      }

References DGtal::QuickHull< TKernel >::Facet::neighbors.

addPointOn()

template<typename TKernel >

void DGtal::QuickHull< TKernel >::Facet::addPointOn ( Index  p )

inline

Definition at line 183 of file QuickHull.h.

      {
        const auto it = std::find( on_set.cbegin(), on_set.cend(), p );
        if ( it == on_set.cend() ) on_set.push_back( p );
      }

References DGtal::QuickHull< TKernel >::Facet::on_set.

clear()

template<typename TKernel >

void DGtal::QuickHull< TKernel >::Facet::clear ( )

inline

Definition at line 175 of file QuickHull.h.

      {
        H = HalfSpace();
        neighbors.clear();
        outside_set.clear();
        on_set.clear();
        below = UNASSIGNED;
      }

References DGtal::QuickHull< TKernel >::Facet::below, DGtal::QuickHull< TKernel >::Facet::H, DGtal::QuickHull< TKernel >::Facet::neighbors, DGtal::QuickHull< TKernel >::Facet::on_set, DGtal::QuickHull< TKernel >::Facet::outside_set, and DGtal::QuickHull< TKernel >::UNASSIGNED.

display()

template<typename TKernel >

void DGtal::QuickHull< TKernel >::Facet::display ( std::ostream &  out ) const

inline

Definition at line 188 of file QuickHull.h.

      {
        const auto N = H.internalNormal(); 
        out << "[Facet iN=(" << N[0];
        for ( Dimension i = 1; i < N.dimension; i++ ) out << "," << N[ i ];
        out << ") c=" << H.internalIntercept() << " b=" << below << " n={";
        for ( auto&& n : neighbors ) out << " " << n;
        out << " } #out=" << outside_set.size();
        out << " on={";
        for ( auto&& n : on_set ) out << " " << n;
        out << " }]" << std::endl;
      }

References DGtal::QuickHull< TKernel >::Facet::below, DGtal::QuickHull< TKernel >::Facet::H, DGtal::QuickHull< TKernel >::Facet::neighbors, DGtal::QuickHull< TKernel >::Facet::on_set, and DGtal::QuickHull< TKernel >::Facet::outside_set.

Referenced by DGtal::QuickHull< TKernel >::processFacet().

operator=() [1/2]

template<typename TKernel >

Facet& DGtal::QuickHull< TKernel >::Facet::operator= ( const Facet &  )

default

operator=() [2/2]

template<typename TKernel >

Facet& DGtal::QuickHull< TKernel >::Facet::operator= ( Facet &&  )

default

subNeighbor()

template<typename TKernel >

void DGtal::QuickHull< TKernel >::Facet::subNeighbor ( Index  n )

inline

Definition at line 206 of file QuickHull.h.

      {
        auto it = std::find( neighbors.begin(), neighbors.end(), n );
        if ( it != neighbors.end() ) {
          std::swap( *it, neighbors.back() );
          neighbors.pop_back();
        }
      }

References DGtal::QuickHull< TKernel >::Facet::neighbors.

swap()

template<typename TKernel >

void DGtal::QuickHull< TKernel >::Facet::swap ( Facet &  other )

inline

Definition at line 214 of file QuickHull.h.

      {
        if ( this != &other ) {
          std::swap( H, other.H );
          neighbors.swap  ( other.neighbors );
          outside_set.swap( other.outside_set );
          on_set.swap     ( other.on_set );
          std::swap( below, other.below );
        }
      }

References DGtal::QuickHull< TKernel >::Facet::below, DGtal::QuickHull< TKernel >::Facet::H, DGtal::QuickHull< TKernel >::Facet::neighbors, DGtal::QuickHull< TKernel >::Facet::on_set, and DGtal::QuickHull< TKernel >::Facet::outside_set.

variableMemory()

template<typename TKernel >

Size DGtal::QuickHull< TKernel >::Facet::variableMemory ( ) const

inline

Definition at line 224 of file QuickHull.h.

      {
        Size M;
        M += neighbors.capacity()   * sizeof( Index );
        M += outside_set.capacity() * sizeof( Index );
        M += on_set.capacity()      * sizeof( Index );
        return M;
      }

References DGtal::QuickHull< TKernel >::Facet::neighbors, DGtal::QuickHull< TKernel >::Facet::on_set, and DGtal::QuickHull< TKernel >::Facet::outside_set.

Field Documentation

below

template<typename TKernel >

Index DGtal::QuickHull< TKernel >::Facet::below

index of point that is below this facet

Definition at line 165 of file QuickHull.h.

Referenced by DGtal::QuickHull< TKernel >::checkFacet(), DGtal::QuickHull< TKernel >::Facet::clear(), DGtal::QuickHull< TKernel >::Facet::display(), and DGtal::QuickHull< TKernel >::Facet::swap().

H

template<typename TKernel >

HalfSpace DGtal::QuickHull< TKernel >::Facet::H

the facet geometry

Definition at line 161 of file QuickHull.h.

Referenced by DGtal::QuickHull< TKernel >::above(), DGtal::QuickHull< TKernel >::aboveOrOn(), DGtal::QuickHull< TKernel >::areFacetsParallel(), DGtal::QuickHull< TKernel >::Facet::clear(), DGtal::QuickHull< TKernel >::Facet::display(), DGtal::QuickHull< TKernel >::height(), DGtal::QuickHull< TKernel >::on(), and DGtal::QuickHull< TKernel >::Facet::swap().

neighbors

template<typename TKernel >

IndexRange DGtal::QuickHull< TKernel >::Facet::neighbors

neighbor facets

Definition at line 162 of file QuickHull.h.

Referenced by DGtal::QuickHull< TKernel >::Facet::addNeighbor(), DGtal::QuickHull< TKernel >::checkFacet(), DGtal::QuickHull< TKernel >::Facet::clear(), DGtal::QuickHull< TKernel >::Facet::display(), DGtal::QuickHull< TKernel >::mergeParallelFacets(), DGtal::QuickHull< TKernel >::Facet::subNeighbor(), DGtal::QuickHull< TKernel >::Facet::swap(), and DGtal::QuickHull< TKernel >::Facet::variableMemory().

on_set

template<typename TKernel >

IndexRange DGtal::QuickHull< TKernel >::Facet::on_set

on set, i.e. points on this facet, sorted

Definition at line 164 of file QuickHull.h.

Referenced by DGtal::QuickHull< TKernel >::Facet::addPointOn(), DGtal::QuickHull< TKernel >::areFacetsNeighbor(), DGtal::QuickHull< TKernel >::areFacetsParallel(), DGtal::QuickHull< TKernel >::checkFacet(), DGtal::QuickHull< TKernel >::Facet::clear(), DGtal::QuickHull< TKernel >::Facet::display(), DGtal::QuickHull< TKernel >::mergeParallelFacets(), DGtal::QuickHull< TKernel >::orientedFacetPoints(), DGtal::QuickHull< TKernel >::pointsOnRidge(), DGtal::QuickHull< TKernel >::Facet::swap(), and DGtal::QuickHull< TKernel >::Facet::variableMemory().

outside_set

template<typename TKernel >

IndexRange DGtal::QuickHull< TKernel >::Facet::outside_set

outside set, i.e. points above this facet

Definition at line 163 of file QuickHull.h.

Referenced by DGtal::QuickHull< TKernel >::checkFacet(), DGtal::QuickHull< TKernel >::Facet::clear(), DGtal::QuickHull< TKernel >::Facet::display(), DGtal::QuickHull< TKernel >::mergeParallelFacets(), DGtal::QuickHull< TKernel >::processFacet(), DGtal::QuickHull< TKernel >::Facet::swap(), and DGtal::QuickHull< TKernel >::Facet::variableMemory().

---

The documentation for this struct was generated from the following file:

• QuickHull.h