Representation of the clusters in SLOPE. More...

#include <clusters.h>

Public Member Functions
	Clusters ()=default
	Constructs an Clusters object.

	Clusters (const Eigen::VectorXd &beta)
	Constructs a Clusters object with the given beta vector.

std::size_t	size ()
	Returns the number of clusters.

std::vector< int >::iterator	begin (const int i)
	Returns an iterator pointing to the beginning of the cluster with the given index.

std::vector< int >::iterator	end (const int i)
	Returns an iterator pointing to the end of the cluster with the given index.

std::vector< int >::const_iterator	cbegin (const int i) const
	Returns a constant iterator pointing to the beginning of the cluster with the given index.

std::vector< int >::const_iterator	cend (const int i) const
	Returns a constant iterator pointing to the end of the cluster with the given index.

int	cluster_size (const int i) const
	Returns the size of the cluster with the given index.

int	pointer (const int i) const
	Returns the pointer of the cluster with the given index.

int	n_clusters () const
	Returns the number of clusters.

double	coeff (const int i) const
	Returns the coefficient of the cluster with the given index.

void	setCoeff (const int i, const double x)
	Sets the coefficient of the cluster with the given index.

std::vector< double >	coeffs () const
	Returns a vector containing the coefficients of all clusters.

std::vector< int >	indices () const
	Returns a vector containing the indices of all clusters.

std::vector< int >	pointers () const
	Returns a vector containing the pointers of all clusters.

void	update (const int old_index, const int new_index, const double c_new)
	Updates the cluster structure when an index is changed.

void	update (const Eigen::VectorXd &beta)
	Updates the cluster structure with the given beta vector.

std::vector< std::vector< int > >	getClusters () const
	Returns the clusters as a vector of vectors.

Eigen::SparseMatrix< int >	patternMatrix () const
	Returns the cluster pattern as a sparse matrix.

Detailed Description

Representation of the clusters in SLOPE.

Definition at line 17 of file clusters.h.

Constructor & Destructor Documentation

◆ Clusters()

slope::Clusters::Clusters ( const Eigen::VectorXd & beta )

Constructs a Clusters object with the given beta vector.

Parameters

beta	The beta vector.

Definition at line 7 of file clusters.cpp.

Member Function Documentation

◆ begin()

std::vector< int >::iterator slope::Clusters::begin ( const int i )

Returns an iterator pointing to the beginning of the cluster with the given index.

Parameters

i	The index of the cluster.

Returns: An iterator pointing to the beginning of the cluster.

Definition at line 58 of file clusters.cpp.

◆ cbegin()

std::vector< int >::const_iterator slope::Clusters::cbegin ( const int i ) const

Returns a constant iterator pointing to the beginning of the cluster with the given index.

Parameters

i	The index of the cluster.

Returns: A constant iterator pointing to the beginning of the cluster.

Definition at line 38 of file clusters.cpp.

◆ cend()

std::vector< int >::const_iterator slope::Clusters::cend ( const int i ) const

Returns a constant iterator pointing to the end of the cluster with the given index.

Parameters

i	The index of the cluster.

Returns: A constant iterator pointing to the end of the cluster.

Definition at line 48 of file clusters.cpp.

◆ cluster_size()

int slope::Clusters::cluster_size ( const int i ) const

Returns the size of the cluster with the given index.

Parameters

i	The index of the cluster.

Returns: The size of the cluster.

Definition at line 78 of file clusters.cpp.

◆ coeff()

double slope::Clusters::coeff ( const int i ) const

Returns the coefficient of the cluster with the given index.

Parameters

i	The index of the cluster.

Returns: The coefficient of the cluster.

Definition at line 117 of file clusters.cpp.

◆ coeffs()

std::vector< double > slope::Clusters::coeffs ( ) const

Returns a vector containing the coefficients of all clusters.

Returns: A vector containing the coefficients.

Definition at line 133 of file clusters.cpp.

◆ end()

std::vector< int >::iterator slope::Clusters::end ( const int i )

Returns an iterator pointing to the end of the cluster with the given index.

Parameters

i	The index of the cluster.

Returns: An iterator pointing to the end of the cluster.

Definition at line 68 of file clusters.cpp.

◆ getClusters()

std::vector< std::vector< int > > slope::Clusters::getClusters ( ) const

Returns the clusters as a vector of vectors.

Returns: The clusters as a vector of vectors.

Definition at line 313 of file clusters.cpp.

◆ indices()

std::vector< int > slope::Clusters::indices ( ) const

Returns a vector containing the indices of all clusters.

Returns: A vector containing the indices.

Definition at line 152 of file clusters.cpp.

◆ n_clusters()

int slope::Clusters::n_clusters ( ) const

Returns the number of clusters.

Returns: The number of clusters.

Definition at line 103 of file clusters.cpp.

◆ patternMatrix()

Eigen::SparseMatrix< int > slope::Clusters::patternMatrix ( ) const

Returns the cluster pattern as a sparse matrix.

Returns: A sparse matrix, where the indices of column j are the indices of the features in cluster j. The matrix is of size \(p \times (m - 1)\), where \(p\) is the number of features and \(m\) is the number of clusters. The features of the zero cluster are not included.

Definition at line 336 of file clusters.cpp.

◆ pointer()

int slope::Clusters::pointer ( const int i ) const

Returns the pointer of the cluster with the given index.

Parameters

i	The index of the cluster.

Returns: The pointer of the cluster.

Definition at line 93 of file clusters.cpp.

◆ pointers()

std::vector< int > slope::Clusters::pointers ( ) const

Returns a vector containing the pointers of all clusters.

Returns: A vector containing the pointers.

Definition at line 158 of file clusters.cpp.

◆ setCoeff()

void slope::Clusters::setCoeff	(	const int	i,
		const double	x
	)

Sets the coefficient of the cluster with the given index.

Parameters

i	The index of the cluster.
x	The new coefficient value.

Definition at line 127 of file clusters.cpp.

◆ size()

std::size_t slope::Clusters::size ( )

inline

Returns the number of clusters.

Returns: The size of the cluster.

Definition at line 35 of file clusters.h.

◆ update() [1/2]

void slope::Clusters::update ( const Eigen::VectorXd & beta )

Updates the cluster structure with the given beta vector.

Parameters

beta	The beta vector.

Definition at line 184 of file clusters.cpp.

◆ update() [2/2]

void slope::Clusters::update	(	const int	old_index,
		const int	new_index,
		const double	c_new
	)

Updates the cluster structure when an index is changed.

Parameters

old_index	The old index.
new_index	The new index.
c_new	The new coefficient value.

Definition at line 164 of file clusters.cpp.

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

src/slope/clusters.h
src/slope/clusters.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Clusters()

Member Function Documentation

◆ begin()

◆ cbegin()

◆ cend()

◆ cluster_size()

◆ coeff()

◆ coeffs()

◆ end()

◆ getClusters()

◆ indices()

◆ n_clusters()

◆ patternMatrix()

◆ pointer()

◆ pointers()

◆ setCoeff()

◆ size()

◆ update() [1/2]

◆ update() [2/2]