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

#include <hdbscan.hpp>

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

Public Member Functions

 PredictionData (const raft::handle_t &handle_, value_idx m, value_idx n, value_t *core_dists_)
 
value_idx get_n_exemplars ()
 
value_idx get_n_selected_clusters ()
 
value_idx * get_exemplar_idx ()
 
value_idx * get_exemplar_label_offsets ()
 
value_idx * get_selected_clusters ()
 
value_t * get_deaths ()
 
value_t * get_core_dists ()
 
value_idx * get_index_into_children ()
 
void allocate (const raft::handle_t &handle, value_idx n_exemplars_, value_idx n_selected_clusters_, value_idx n_edges_)
 
void set_n_clusters (const raft::handle_t &handle, value_idx n_clusters_)
 

Public Attributes

size_t n_rows
 
size_t n_cols
 

Detailed Description

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

Container object for computing and storing intermediate information needed later for computing membership vectors and approximate predict. Users are only expected to create an instance of this object, the hdbscan method will do the rest.

Template Parameters
value_idx
value_t

Constructor & Destructor Documentation

◆ PredictionData()

template<typename value_idx , typename value_t >
ML::HDBSCAN::Common::PredictionData< value_idx, value_t >::PredictionData ( const raft::handle_t &  handle_,
value_idx  m,
value_idx  n,
value_t *  core_dists_ 
)
inline

Member Function Documentation

◆ allocate()

template<typename value_idx , typename value_t >
void ML::HDBSCAN::Common::PredictionData< value_idx, value_t >::allocate ( const raft::handle_t &  handle,
value_idx  n_exemplars_,
value_idx  n_selected_clusters_,
value_idx  n_edges_ 
)

Resizes the buffers in the PredictionData object.

Parameters
[in]handleraft handle for resource reuse
[in]n_exemplars_number of exemplar points
[in]n_selected_clusters_number of selected clusters in the final clustering
[in]n_edges_number of edges in the condensed hierarchy

◆ get_core_dists()

template<typename value_idx , typename value_t >
value_t* ML::HDBSCAN::Common::PredictionData< value_idx, value_t >::get_core_dists ( )
inline

◆ get_deaths()

template<typename value_idx , typename value_t >
value_t* ML::HDBSCAN::Common::PredictionData< value_idx, value_t >::get_deaths ( )
inline

◆ get_exemplar_idx()

template<typename value_idx , typename value_t >
value_idx* ML::HDBSCAN::Common::PredictionData< value_idx, value_t >::get_exemplar_idx ( )
inline

◆ get_exemplar_label_offsets()

template<typename value_idx , typename value_t >
value_idx* ML::HDBSCAN::Common::PredictionData< value_idx, value_t >::get_exemplar_label_offsets ( )
inline

◆ get_index_into_children()

template<typename value_idx , typename value_t >
value_idx* ML::HDBSCAN::Common::PredictionData< value_idx, value_t >::get_index_into_children ( )
inline

◆ get_n_exemplars()

template<typename value_idx , typename value_t >
value_idx ML::HDBSCAN::Common::PredictionData< value_idx, value_t >::get_n_exemplars ( )
inline

◆ get_n_selected_clusters()

template<typename value_idx , typename value_t >
value_idx ML::HDBSCAN::Common::PredictionData< value_idx, value_t >::get_n_selected_clusters ( )
inline

◆ get_selected_clusters()

template<typename value_idx , typename value_t >
value_idx* ML::HDBSCAN::Common::PredictionData< value_idx, value_t >::get_selected_clusters ( )
inline

◆ set_n_clusters()

template<typename value_idx , typename value_t >
void ML::HDBSCAN::Common::PredictionData< value_idx, value_t >::set_n_clusters ( const raft::handle_t &  handle,
value_idx  n_clusters_ 
)
inline

Resize buffers for cluster deaths to n_clusters

Parameters
handleraft handle for ordering cuda operations
n_clusters_number of clusters

Member Data Documentation

◆ n_cols

template<typename value_idx , typename value_t >
size_t ML::HDBSCAN::Common::PredictionData< value_idx, value_t >::n_cols

◆ n_rows

template<typename value_idx , typename value_t >
size_t ML::HDBSCAN::Common::PredictionData< value_idx, value_t >::n_rows

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