carta
mlpack_emst_UnionFind(3)

mlpack_emst_UnionFind3

A union-find data structure.

Usage

Public Member Functions

UnionFind (const size_t size)

Destroy the object (nothing to do). size_t Find (const size_t x)

Union the components containing x and y.

Private Attributes

arma::ivec rank

Detailed Description

A Union-Find data structure.

See Cormen, Rivest, & Stein for details. The structure tracks the components of a graph. Each point in the graph is initially in its own component. Calling Union(x, y) unites the components indexed by x and y. Find(x) returns the index of the component containing point x.

Definition at line 40 of file union_find.hpp.

Constructor & Destructor Documentation

mlpack::emst::UnionFind::UnionFind (const size_tsize) [inline]

Construct the object with the given size.

Definition at line 48 of file union_find.hpp.

References parent, and rank.

mlpack::emst::UnionFind::~UnionFind () [inline]

Destroy the object (nothing to do).

Definition at line 58 of file union_find.hpp.

Member Function Documentation

size_t mlpack::emst::UnionFind::Find (const size_tx) [inline]

Returns the component containing an element.

Parameters:

x the component to be found

Returns:

The index of the component containing x

Definition at line 66 of file union_find.hpp.

References parent.

Referenced by Union().

void mlpack::emst::UnionFind::Union (const size_tx, const size_ty) [inline]

Union the components containing x and y.

Parameters:

x one component
y the other component

Definition at line 86 of file union_find.hpp.

References Find(), parent, and rank.

Member Data Documentation

arma::Col<size_t> mlpack::emst::UnionFind::parent [private]

Definition at line 43 of file union_find.hpp.

Referenced by Find(), Union(), and UnionFind().

arma::ivec mlpack::emst::UnionFind::rank [private]

Definition at line 44 of file union_find.hpp.

Referenced by Union(), and UnionFind().

Author

Generated automatically by Doxygen for MLPACK from the source code.

From mlpack-doc 1.0.10-1 in Debian 8 (Jessie). Parsed by carta from the page's man source.