pulsatrix 1.1.0
Loading...
Searching...
No Matches
pulsatrix::Pca Struct Reference

A fitted PCA. More...

#include <pca.hpp>

Public Member Functions

int64_t num_components () const
 

Public Attributes

int64_t width = 0
 The width of the rows it was fitted on.
 
int64_t samples = 0
 How many rows it was fitted on.
 
std::vector< double > mean
 The rows' mean, subtracted before projecting. All zeros when fitted uncentered.
 
std::vector< double > components
 Row-major (components, width): unit directions, most variance first.
 
std::vector< double > explained_variance
 Each component's variance: the variance of the projections, dividing by n - 1.
 
std::vector< double > explained_variance_ratio
 Each component's share of the total variance.
 
double total_variance = 0
 The variance over every direction, the sum of the per-column variances.
 

Detailed Description

A fitted PCA.

Member Function Documentation

◆ num_components()

int64_t pulsatrix::Pca::num_components ( ) const
inline

Member Data Documentation

◆ components

std::vector<double> pulsatrix::Pca::components

Row-major (components, width): unit directions, most variance first.

◆ explained_variance

std::vector<double> pulsatrix::Pca::explained_variance

Each component's variance: the variance of the projections, dividing by n - 1.

◆ explained_variance_ratio

std::vector<double> pulsatrix::Pca::explained_variance_ratio

Each component's share of the total variance.

◆ mean

std::vector<double> pulsatrix::Pca::mean

The rows' mean, subtracted before projecting. All zeros when fitted uncentered.

◆ samples

int64_t pulsatrix::Pca::samples = 0

How many rows it was fitted on.

◆ total_variance

double pulsatrix::Pca::total_variance = 0

The variance over every direction, the sum of the per-column variances.

◆ width

int64_t pulsatrix::Pca::width = 0

The width of the rows it was fitted on.


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