Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ML::HDBSCAN::Common::robust_single_linkage_output< value_idx, value_t > Class Template Reference

#include <hdbscan.hpp>

Inheritance diagram for ML::HDBSCAN::Common::robust_single_linkage_output< value_idx, value_t >:
Inheritance graph
Collaboration diagram for ML::HDBSCAN::Common::robust_single_linkage_output< value_idx, value_t >:
Collaboration graph

Public Member Functions

 robust_single_linkage_output (const raft::handle_t &handle_, int n_leaves_, value_idx *labels_, value_idx *children_, value_idx *sizes_, value_t *deltas_, value_idx *mst_src_, value_idx *mst_dst_, value_t *mst_weights_)
 
int get_n_leaves () const
 
int get_n_clusters () const
 
value_idx * get_labels ()
 
value_idx * get_children ()
 
value_idx * get_sizes ()
 
value_t * get_deltas ()
 
value_idx * get_mst_src ()
 
value_idx * get_mst_dst ()
 
value_t * get_mst_weights ()
 
void set_n_clusters (int n_clusters_)
 

Protected Member Functions

const raft::handle_t & get_handle ()
 

Protected Attributes

const raft::handle_t & handle
 
int n_leaves
 
int n_clusters
 
value_idx * labels
 
value_idx * children
 
value_idx * sizes
 
value_t * deltas
 
value_idx * mst_src
 
value_idx * mst_dst
 
value_t * mst_weights
 

Detailed Description

template<typename value_idx, typename value_t>
class ML::HDBSCAN::Common::robust_single_linkage_output< value_idx, value_t >

Container object for output information common between robust single linkage variants.

Template Parameters
value_idx
value_t

Constructor & Destructor Documentation

◆ robust_single_linkage_output()

template<typename value_idx , typename value_t >
ML::HDBSCAN::Common::robust_single_linkage_output< value_idx, value_t >::robust_single_linkage_output ( const raft::handle_t &  handle_,
int  n_leaves_,
value_idx *  labels_,
value_idx *  children_,
value_idx *  sizes_,
value_t *  deltas_,
value_idx *  mst_src_,
value_idx *  mst_dst_,
value_t *  mst_weights_ 
)
inline

Construct output object with empty device arrays of known size.

Parameters
handle_raft handle for ordering cuda operations
n_leaves_number of data points
labels_labels array on device (size n_leaves)
children_dendrogram src/dst array (size n_leaves - 1, 2)
sizes_dendrogram cluster sizes array (size n_leaves - 1)
deltas_dendrogram distances array (size n_leaves - 1)
mst_src_min spanning tree source array (size n_leaves - 1)
mst_dst_min spanning tree destination array (size n_leaves - 1)
mst_weights_min spanninng tree distances array (size n_leaves - 1)

Member Function Documentation

◆ get_children()

template<typename value_idx , typename value_t >
value_idx* ML::HDBSCAN::Common::robust_single_linkage_output< value_idx, value_t >::get_children ( )
inline

◆ get_deltas()

template<typename value_idx , typename value_t >
value_t* ML::HDBSCAN::Common::robust_single_linkage_output< value_idx, value_t >::get_deltas ( )
inline

◆ get_handle()

template<typename value_idx , typename value_t >
const raft::handle_t& ML::HDBSCAN::Common::robust_single_linkage_output< value_idx, value_t >::get_handle ( )
inlineprotected

◆ get_labels()

template<typename value_idx , typename value_t >
value_idx* ML::HDBSCAN::Common::robust_single_linkage_output< value_idx, value_t >::get_labels ( )
inline

◆ get_mst_dst()

template<typename value_idx , typename value_t >
value_idx* ML::HDBSCAN::Common::robust_single_linkage_output< value_idx, value_t >::get_mst_dst ( )
inline

◆ get_mst_src()

template<typename value_idx , typename value_t >
value_idx* ML::HDBSCAN::Common::robust_single_linkage_output< value_idx, value_t >::get_mst_src ( )
inline

◆ get_mst_weights()

template<typename value_idx , typename value_t >
value_t* ML::HDBSCAN::Common::robust_single_linkage_output< value_idx, value_t >::get_mst_weights ( )
inline

◆ get_n_clusters()

template<typename value_idx , typename value_t >
int ML::HDBSCAN::Common::robust_single_linkage_output< value_idx, value_t >::get_n_clusters ( ) const
inline

◆ get_n_leaves()

template<typename value_idx , typename value_t >
int ML::HDBSCAN::Common::robust_single_linkage_output< value_idx, value_t >::get_n_leaves ( ) const
inline

◆ get_sizes()

template<typename value_idx , typename value_t >
value_idx* ML::HDBSCAN::Common::robust_single_linkage_output< value_idx, value_t >::get_sizes ( )
inline

◆ set_n_clusters()

template<typename value_idx , typename value_t >
void ML::HDBSCAN::Common::robust_single_linkage_output< value_idx, value_t >::set_n_clusters ( int  n_clusters_)
inline

The number of clusters is set by the algorithm once it is known.

Parameters
n_clusters_number of resulting clusters

Member Data Documentation

◆ children

template<typename value_idx , typename value_t >
value_idx* ML::HDBSCAN::Common::robust_single_linkage_output< value_idx, value_t >::children
protected

◆ deltas

template<typename value_idx , typename value_t >
value_t* ML::HDBSCAN::Common::robust_single_linkage_output< value_idx, value_t >::deltas
protected

◆ handle

template<typename value_idx , typename value_t >
const raft::handle_t& ML::HDBSCAN::Common::robust_single_linkage_output< value_idx, value_t >::handle
protected

◆ labels

template<typename value_idx , typename value_t >
value_idx* ML::HDBSCAN::Common::robust_single_linkage_output< value_idx, value_t >::labels
protected

◆ mst_dst

template<typename value_idx , typename value_t >
value_idx* ML::HDBSCAN::Common::robust_single_linkage_output< value_idx, value_t >::mst_dst
protected

◆ mst_src

template<typename value_idx , typename value_t >
value_idx* ML::HDBSCAN::Common::robust_single_linkage_output< value_idx, value_t >::mst_src
protected

◆ mst_weights

template<typename value_idx , typename value_t >
value_t* ML::HDBSCAN::Common::robust_single_linkage_output< value_idx, value_t >::mst_weights
protected

◆ n_clusters

template<typename value_idx , typename value_t >
int ML::HDBSCAN::Common::robust_single_linkage_output< value_idx, value_t >::n_clusters
protected

◆ n_leaves

template<typename value_idx , typename value_t >
int ML::HDBSCAN::Common::robust_single_linkage_output< value_idx, value_t >::n_leaves
protected

◆ sizes

template<typename value_idx , typename value_t >
value_idx* ML::HDBSCAN::Common::robust_single_linkage_output< value_idx, value_t >::sizes
protected

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