NAME¶

mlpack::emst::EdgePair - An edge pair is simply two indices and a distance.

SYNOPSIS¶

Public Member Functions¶

EdgePair (const size_t lesser, const size_t greater, const double dist) Initialize an EdgePair with two indices and a distance. double Distance () const Get the distance. double & Distance () Modify the distance. size_t Greater () const Get the greater index. size_t & Greater () Modify the greater index. size_t Lesser () const Get the lesser index. size_t & Lesser () Modify the lesser index.

Private Attributes¶

double distance Distance between two indices. size_t greater Greater index. size_t lesser Lesser index.

Detailed Description¶

An edge pair is simply two indices and a distance. It is used as the basic element of an edge list when computing a minimum spanning tree. Definition at line 38 of file edge_pair.hpp.

Constructor & Destructor Documentation¶

mlpack::emst::EdgePair::EdgePair (const size_tlesser, const size_tgreater, const doubledist) [inline]¶

Initialize an EdgePair with two indices and a distance. The indices are called lesser and greater, implying that they be sorted before calling Init. However, this is not necessary for functionality; it is just a way to keep the edge list organized in other code. Definition at line 55 of file edge_pair.hpp. References mlpack::Log::Assert().

Member Function Documentation¶

double mlpack::emst::EdgePair::Distance () const [inline]¶

Get the distance. Definition at line 73 of file edge_pair.hpp. References distance. Referenced by mlpack::emst::DualTreeBoruvka< MetricType, TreeType >::SortEdgesHelper::operator()().

double& mlpack::emst::EdgePair::Distance () [inline]¶

Modify the distance. Definition at line 75 of file edge_pair.hpp. References distance.

size_t mlpack::emst::EdgePair::Greater () const [inline]¶

Get the greater index. Definition at line 68 of file edge_pair.hpp. References greater.

size_t& mlpack::emst::EdgePair::Greater () [inline]¶

Modify the greater index. Definition at line 70 of file edge_pair.hpp. References greater.

size_t mlpack::emst::EdgePair::Lesser () const [inline]¶

Get the lesser index. Definition at line 63 of file edge_pair.hpp. References lesser.

size_t& mlpack::emst::EdgePair::Lesser () [inline]¶

Modify the lesser index. Definition at line 65 of file edge_pair.hpp. References lesser.

Member Data Documentation¶

double mlpack::emst::EdgePair::distance [private]¶

Distance between two indices. Definition at line 46 of file edge_pair.hpp. Referenced by Distance().

size_t mlpack::emst::EdgePair::greater [private]¶

Greater index. Definition at line 44 of file edge_pair.hpp. Referenced by Greater().

size_t mlpack::emst::EdgePair::lesser [private]¶

Lesser index. Definition at line 42 of file edge_pair.hpp. Referenced by Lesser().

Author¶

Generated automatically by Doxygen for MLPACK from the source code.