\( \newcommand{\E}{\mathrm{E}} \) \( \newcommand{\A}{\mathrm{A}} \) \( \newcommand{\R}{\mathrm{R}} \) \( \newcommand{\N}{\mathrm{N}} \) \( \newcommand{\Q}{\mathrm{Q}} \) \( \newcommand{\Z}{\mathrm{Z}} \) \( \def\ccSum #1#2#3{ \sum_{#1}^{#2}{#3} } \def\ccProd #1#2#3{ \sum_{#1}^{#2}{#3} }\)
CGAL 5.0.2 - Classification
List of all members | Public Types
CGAL::Classification::Cluster< ItemRange, ItemMap > Class Template Reference
Classification Reference » Cluster Classification

#include <CGAL/Classification/Cluster.h>

Definition

Class that represent a cluster of items to be classified as a single atomic object.

A cluster is a set of indices of items inside an input range with random access.

Template Parameters
ItemRangemodel of ConstRange. Its iterator type is RandomAccessIterator. Its value type depends on the data that is classified (for example, CGAL::Point_3 or CGAL::Triangle_3).
ItemMapmodel of ReadablePropertyMap whose key type is the value type of the iterator of ItemRange and value type is the type of item to classify (for example, CGAL::Point_3).

Public Types

typedef ItemMap::value_type Item
 

Constructor

 Cluster (const ItemRange &range, ItemMap item_map)
 Constructs an empty cluster of items. More...
 

Modifications

void clear ()
 Clears the cluster.
 
void insert (std::size_t idx)
 Inserts element of index idx in the cluster.
 

Access

std::size_t size () const
 Returns the number of items in the cluster.
 
std::size_t index (std::size_t i) const
 Returns the index (in the input range) of the i^{th} element of the cluster.
 
const Item & operator[] (std::size_t i) const
 Returns the i^{th} item of the cluster.
 
const CGAL::Bbox_3 & bbox () const
 Returns the bounding box of the cluster.
 

Classification

int training () const
 Returns the input classification value used for training.
 
int & training ()
 Returns a reference to the input classification value used for training.
 
int label () const
 Returns the output classification value.
 
int & label ()
 Returns a reference to the output classification value.
 

Constructor & Destructor Documentation

◆ Cluster()

template<typename ItemRange , typename ItemMap >
CGAL::Classification::Cluster< ItemRange, ItemMap >::Cluster ( const ItemRange &  range,
ItemMap  item_map 
)

Constructs an empty cluster of items.

Items in the clusters will be subsets of range.

Parameters
rangeinput range.
item_mapproperty map to access the input items.