GEOGen::FacetSeedMarking Class Reference

Stores associations between (facet,seed) pairs and the index of a connected component. More...

#include <geogram/voronoi/generic_RVD_utils.h>

Public Member Functions
	FacetSeedMarking (index_t, index_t nb_seeds)
	Creates a new FacetSeedMarking.
bool	is_marked (index_t facet, index_t seed) const
	Tests whether a given facet,seed couple is marked.
bool	is_marked (const FacetSeed &fs) const
	Tests whether a fiven FacetSeed is marked.
index_t	get_connected_component (const FacetSeed &fs) const
	Gets the index of the connected component associated with a given FacetSeed.
void	mark (const FacetSeed &fs, index_t conn_comp)
	Marks a FacetSeed and sets the associated connected component index.
	~FacetSeedMarking ()
	FacetSeedMarking destructor.

Protected Member Functions
index_t	nb_arrays () const
	Gets the number of arrays used internally.
void	set_size (index_t nb_arrays)
	Sets the number of arrays to be used.
index_t	array_size (index_t array) const
	Gets the size of one of the arrays.
index_t	array_capacity (index_t array) const
	Gets the capacity of one of the arrays.
index_t	find_index (index_t array, index_t key) const
	Finds the index of one of the keys in one of the arrays.
index_t	find_value (index_t array, index_t key) const
	Finds the value associated with a key in one of the arrays.
void	insert (index_t array, index_t key, index_t value)
	Inserts a (key,value) pair into one of the arrays.

Detailed Description

Stores associations between (facet,seed) pairs and the index of a connected component.

Used by GEOGen::RestrictedVoronoiDiagram. The implementation uses an array of (key,value) vectors, with dynamic reallocation and linear search. Experimentally, this significantly reduces the memory footprint and execution time as compared to std::table<FacetSeed,index_t>.

Definition at line 219 of file generic_RVD_utils.h.

Constructor & Destructor Documentation

FacetSeedMarking()

GEOGen::FacetSeedMarking::FacetSeedMarking ( index_t  , index_t  nb_seeds  )

inline

Creates a new FacetSeedMarking.

Parameters

[in]

nb_seeds

total number of seeds

Definition at line 225 of file generic_RVD_utils.h.

~FacetSeedMarking()

GEOGen::FacetSeedMarking::~FacetSeedMarking ( )

inline

FacetSeedMarking destructor.

Definition at line 262 of file generic_RVD_utils.h.

Member Function Documentation

array_capacity()

index_t GEOGen::FacetSeedMarking::array_capacity ( index_t  array ) const

inlineprotected

Gets the capacity of one of the arrays.

It corresponds with the power of two immediately greater than size. Unlike in std::vector, capacity is implicitly retrieved from size (this saves one integer per seed).

Parameters

[in]

array

index of the array

Precondition

array < nb_arrays()

Definition at line 307 of file generic_RVD_utils.h.

array_size()

index_t GEOGen::FacetSeedMarking::array_size ( index_t  array ) const

inlineprotected

Gets the size of one of the arrays.

Parameters

[in]

array

index of the array

Precondition

array < nb_arrays()

Definition at line 294 of file generic_RVD_utils.h.

find_index()

index_t GEOGen::FacetSeedMarking::find_index ( index_t  array, index_t  key  ) const

inlineprotected

Finds the index of one of the keys in one of the arrays.

Parameters

[in]	array	index of the array
[in]	key	the query key

Returns

the index of key in array or NO_INDEX if not found

Definition at line 333 of file generic_RVD_utils.h.

find_value()

index_t GEOGen::FacetSeedMarking::find_value ( index_t  array, index_t  key  ) const

inlineprotected

Finds the value associated with a key in one of the arrays.

Parameters

[in]	array	index of the array
[in]	key	the query key

Returns

the value associated with key in array or NO_INDEX if not found.

Definition at line 351 of file generic_RVD_utils.h.

get_connected_component()

index_t GEOGen::FacetSeedMarking::get_connected_component ( const FacetSeed &  fs ) const

inline

Gets the index of the connected component associated with a given FacetSeed.

Definition at line 247 of file generic_RVD_utils.h.

insert()

void GEOGen::FacetSeedMarking::insert ( index_t  array, index_t  key, index_t  value  )

inlineprotected

Inserts a (key,value) pair into one of the arrays.

Parameters

[in]	array	index of the array
[in]	key	the key
[in]	value	the value to be associated with key

Definition at line 365 of file generic_RVD_utils.h.

is_marked() [1/2]

bool GEOGen::FacetSeedMarking::is_marked ( const FacetSeed &  fs ) const

inline

Tests whether a fiven FacetSeed is marked.

Definition at line 239 of file generic_RVD_utils.h.

is_marked() [2/2]

bool GEOGen::FacetSeedMarking::is_marked ( index_t  facet, index_t  seed  ) const

inline

Tests whether a given facet,seed couple is marked.

Definition at line 232 of file generic_RVD_utils.h.

mark()

void GEOGen::FacetSeedMarking::mark ( const FacetSeed &  fs, index_t  conn_comp  )

inline

Marks a FacetSeed and sets the associated connected component index.

Definition at line 255 of file generic_RVD_utils.h.

nb_arrays()

index_t GEOGen::FacetSeedMarking::nb_arrays ( ) const

inlineprotected

Gets the number of arrays used internally.

Definition at line 275 of file generic_RVD_utils.h.

set_size()

void GEOGen::FacetSeedMarking::set_size ( index_t  nb_arrays )

inlineprotected

Sets the number of arrays to be used.

Parameters

[in]

nb_arrays

number of arrays

Definition at line 283 of file generic_RVD_utils.h.

---

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

• geogram/voronoi/generic_RVD_utils.h