BinaryCache Class Reference

Cache for spatial model with binary covariates. More...

#include <binary_cache.hpp>

Inheritance diagram for BinaryCache:

Classes
struct	ClusterStats
	Structure to hold statistics for each cluster. More...

Public Member Functions
	BinaryCache (const Eigen::VectorXi &allocations_ref, const Eigen::VectorXi &binary_covariates)
void	set_allocation (int index, int cluster, int old_cluster) override
	Assigns a point to a cluster.
ClusterStats	get_cluster_stats (int cluster) const
	Get cluster statistics for a specific cluster.
const ClusterStats &	get_cluster_stats_ref (int cluster) const
	Get cluster statistics reference for a specific cluster.
void	recompute (const int K, const Eigen::VectorXi &allocations_in) override
	Recomputes all cluster information from current allocations.
void	move_cluster_info (int from_cluster, int to_cluster) override
	Moves cluster information from one cluster to another.
void	remove_info (int cluster) override
	Removes information related to a specific cluster.
Public Member Functions inherited from ClusterInfo
	ClusterInfo ()=default
virtual	~ClusterInfo ()=default

Public Attributes
const Eigen::VectorXi	binary_covariates

Private Attributes
std::vector< ClusterStats >	cluster_stats

Detailed Description

Cache for spatial model with binary covariates.

This class maintains cluster statistics for a spatial model that includes binary covariates.

Constructor & Destructor Documentation

BinaryCache()

BinaryCache::BinaryCache ( const Eigen::VectorXi & allocations_ref, const Eigen::VectorXi & binary_covariates )

inline

Member Function Documentation

get_cluster_stats()

ClusterStats BinaryCache::get_cluster_stats ( int cluster ) const

inline

Get cluster statistics for a specific cluster.

Parameters

cluster

Index of the cluster

Returns

ClusterStats struct

get_cluster_stats_ref()

const ClusterStats & BinaryCache::get_cluster_stats_ref ( int cluster ) const

inline

Get cluster statistics reference for a specific cluster.

Parameters

cluster

Index of the cluster

Returns

Const reference to ClusterStats struct

move_cluster_info()

void BinaryCache::move_cluster_info ( int from_cluster, int to_cluster )

inlineoverridevirtual

Moves cluster information from one cluster to another.

Parameters

from_cluster	Index of the source cluster
to_cluster	Index of the target cluster

Implements ClusterInfo.

recompute()

void BinaryCache::recompute ( const int K, const Eigen::VectorXi & allocations_in )

overridevirtual

Recomputes all cluster information from current allocations.

Parameters

K	Current number of clusters
allocations_in	Current allocations vector

Implements ClusterInfo.

remove_info()

void BinaryCache::remove_info ( int cluster )

inlineoverridevirtual

Removes information related to a specific cluster.

Parameters

cluster

Index of the cluster to remove

Implements ClusterInfo.

set_allocation()

void BinaryCache::set_allocation ( int index, int cluster, int old_cluster )

overridevirtual

Assigns a point to a cluster.

Parameters

index	Index of the point to reassign
cluster	Target cluster index (K for new cluster, -1 for unallocated)
old_cluster	Previous cluster index of the point

Exceptions

std::out_of_range

if index or cluster is invalid

Implements ClusterInfo.

Member Data Documentation

binary_covariates

const Eigen::VectorXi BinaryCache::binary_covariates

cluster_stats

std::vector<ClusterStats> BinaryCache::cluster_stats

private

---

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

• src/processes/caches/binary_cache.hpp
• src/processes/caches/binary_cache.cpp