STORMM Source Documentation
Loading...
Searching...
No Matches
stormm::stmath::ClusterManagerKit< Tcalc > Struct Template Reference

An abstract of the cluster manager suitable for rapid access and modification in the C++ layer, or submission as an argument to an HPC kernel. As with any collection of C-style pointers, the abstract is only valid so long as the object it references does not get resized. More...

#include <cluster_manager.h>

Public Member Functions

 ClusterManagerKit (size_t data_points_in, int clusters_in, int *cls_homes_in, size_t *cls_membership_in, size_t *cls_bounds_in, size_t *cls_primes_in, Tcalc *cls_rmsd_in, Tcalc *centroid_dist_in)
 The constructor takes arguments for every member variable.
 
 ClusterManagerKit (const ClusterManagerKit &original)=default
 The const sizing elements mean that the default copy and move assignment operators will be implicitly deleted.
 
 ClusterManagerKit (ClusterManagerKit &&original)=default
 

Public Attributes

const size_t data_points
 The number of data points in the entire set.
 
const int clusters
 The number of clusters into which data points are grouped.
 
int * cls_homes
 
size_t * cls_membership
 Concatenated lists of the data points each cluster comprises.
 
size_t * cls_bounds
 Bounds array on cls_membership.
 
size_t * cls_primes
 Members of each cluster nearest the cluster's centroid.
 
Tcalc * cls_rmsd
 
Tcalc * centroid_dist
 Distance of each data point to its cluster's centroid.
 

Detailed Description

template<typename Tcalc>
struct stormm::stmath::ClusterManagerKit< Tcalc >

An abstract of the cluster manager suitable for rapid access and modification in the C++ layer, or submission as an argument to an HPC kernel. As with any collection of C-style pointers, the abstract is only valid so long as the object it references does not get resized.

Member Data Documentation

◆ cls_homes

template<typename Tcalc>
int* stormm::stmath::ClusterManagerKit< Tcalc >::cls_homes

The clusters to which each data point belongs (in the current clustering arrangement)

◆ cls_rmsd

template<typename Tcalc>
Tcalc* stormm::stmath::ClusterManagerKit< Tcalc >::cls_rmsd

Root mean squared deviation in the spread of points in each cluster


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