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

#include <hdbscan.hpp>

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

Public Member Functions

 hdbscan_output (const raft::handle_t &handle_, int n_leaves_, value_idx *labels_, value_t *probabilities_, value_idx *children_, value_idx *sizes_, value_t *deltas_, value_idx *mst_src_, value_idx *mst_dst_, value_t *mst_weights_)
 
value_t * get_probabilities ()
 
value_t * get_stabilities ()
 
value_idx * get_inverse_label_map ()
 
rmm::device_uvector< value_idx > & _get_inverse_label_map ()
 
void set_n_clusters (int n_clusters_)
 
CondensedHierarchy< value_idx, value_t > & get_condensed_tree ()
 
- Public Member Functions inherited from 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_)
 
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_)
 

Additional Inherited Members

- Protected Member Functions inherited from ML::HDBSCAN::Common::robust_single_linkage_output< value_idx, value_t >
const raft::handle_t & get_handle ()
 
- Protected Attributes inherited from ML::HDBSCAN::Common::robust_single_linkage_output< value_idx, value_t >
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::hdbscan_output< value_idx, value_t >

Plain old container object to consolidate output arrays. This object is intentionally kept simple and straightforward in order to ease its use in the Python layer. For this reason, the MST arrays and renumbered dendrogram array, as well as its aggregated distances/cluster sizes, are kept separate. The condensed hierarchy is computed and populated in a separate object because its size is not known ahead of time. An RMM device vector is held privately and stabilities initialized explicitly since that size is also not known ahead of time.

Template Parameters
value_idx
value_t

Constructor & Destructor Documentation

◆ hdbscan_output()

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

Member Function Documentation

◆ _get_inverse_label_map()

template<typename value_idx , typename value_t >
rmm::device_uvector<value_idx>& ML::HDBSCAN::Common::hdbscan_output< value_idx, value_t >::_get_inverse_label_map ( )
inline

◆ get_condensed_tree()

template<typename value_idx , typename value_t >
CondensedHierarchy<value_idx, value_t>& ML::HDBSCAN::Common::hdbscan_output< value_idx, value_t >::get_condensed_tree ( )
inline

◆ get_inverse_label_map()

template<typename value_idx , typename value_t >
value_idx* ML::HDBSCAN::Common::hdbscan_output< value_idx, value_t >::get_inverse_label_map ( )
inline

◆ get_probabilities()

template<typename value_idx , typename value_t >
value_t* ML::HDBSCAN::Common::hdbscan_output< value_idx, value_t >::get_probabilities ( )
inline

◆ get_stabilities()

template<typename value_idx , typename value_t >
value_t* ML::HDBSCAN::Common::hdbscan_output< value_idx, value_t >::get_stabilities ( )
inline

◆ set_n_clusters()

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

Once n_clusters is known, the stabilities array can be initialized.

Parameters
n_clusters_

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