mlpack_emst_EdgePair (3)

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.

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.

mlpack::emst::EdgePair::EdgePair (const size_tlesser, const size_tgreater, const doubledist)\fC [inline]\fP

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().

double mlpack::emst::EdgePair::Distance () const\fC [inline]\fP

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 ()\fC [inline]\fP

Modify the distance.

Definition at line 75 of file edge_pair.hpp.

References distance.

size_t mlpack::emst::EdgePair::Greater () const\fC [inline]\fP

Get the greater index.

Definition at line 68 of file edge_pair.hpp.

References greater.

size_t& mlpack::emst::EdgePair::Greater ()\fC [inline]\fP

Modify the greater index.

Definition at line 70 of file edge_pair.hpp.

References greater.

size_t mlpack::emst::EdgePair::Lesser () const\fC [inline]\fP

Get the lesser index.

Definition at line 63 of file edge_pair.hpp.

References lesser.

size_t& mlpack::emst::EdgePair::Lesser ()\fC [inline]\fP

Modify the lesser index.

Definition at line 65 of file edge_pair.hpp.

References lesser.

double mlpack::emst::EdgePair::distance\fC [private]\fP

Distance between two indices.

Definition at line 46 of file edge_pair.hpp.

Referenced by Distance().

size_t mlpack::emst::EdgePair::greater\fC [private]\fP

Greater index.

Definition at line 44 of file edge_pair.hpp.

Referenced by Greater().

size_t mlpack::emst::EdgePair::lesser\fC [private]\fP

Lesser index.

Definition at line 42 of file edge_pair.hpp.

Referenced by Lesser().

Generated automatically by Doxygen for MLPACK from the source code.