CASM::PCA Class Reference

#include <PCA.hh>

Detailed Description

Principle component analysis.

Definition at line 9 of file PCA.hh.

Public Types
typedef Eigen::MatrixXd::Index	size_type

Public Member Functions
template<typename Derived >
	PCA (const Eigen::MatrixBase< Derived > &M, double singular_value_tol=1e-14)
	Constructor accepting a column vector matrix M containing points [input...]. More...
size_type	dim () const
	Initial dimension, equivalent to pca.reduce().cols() More...
size_type	rank () const
	Rank of the input, equivalent to pca.reduce().rows() More...
Eigen::MatrixXd	reduce () const
	Orthogonal transformation matrix from a point in full [input...] space to dimension-reduced [range(input...)] space. More...
Eigen::MatrixXd	expand () const
	Orthogonal transformation matrix from a point in dimension-reduced [range(input...)] space to full [input...] space. More...

Private Attributes
Eigen::MatrixXd	m_reduce

Member Typedef Documentation

size_type

typedef Eigen::MatrixXd::Index CASM::PCA::size_type

Definition at line 11 of file PCA.hh.

Constructor & Destructor Documentation

PCA()

template<typename Derived >

CASM::PCA::PCA ( const Eigen::MatrixBase< Derived > &  M, double  singular_value_tol = 1e-14  )

inline

Constructor accepting a column vector matrix M containing points [input...].

Definition at line 16 of file PCA.hh.

Member Function Documentation

dim()

size_type CASM::PCA::dim ( ) const

inline

Initial dimension, equivalent to pca.reduce().cols()

Definition at line 36 of file PCA.hh.

expand()

Eigen::MatrixXd CASM::PCA::expand ( ) const

inline

Orthogonal transformation matrix from a point in dimension-reduced [range(input...)] space to full [input...] space.

• Example use:

  Eigen::VectorXd full_point = pca.expand()*reduced_point;

Definition at line 59 of file PCA.hh.

rank()

size_type CASM::PCA::rank ( ) const

inline

Rank of the input, equivalent to pca.reduce().rows()

Definition at line 39 of file PCA.hh.

reduce()

Eigen::MatrixXd CASM::PCA::reduce ( ) const

inline

Orthogonal transformation matrix from a point in full [input...] space to dimension-reduced [range(input...)] space.

• Example use:

  Eigen::VectorXd reduced_point = pca.reduce()*full_point;

Definition at line 49 of file PCA.hh.

Member Data Documentation

m_reduce

Eigen::MatrixXd CASM::PCA::m_reduce

private

Definition at line 64 of file PCA.hh.

---

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

• /Users/bpuchala/Work/codes/CASMcode_v0.2.X_reference/include/casm/misc/PCA.hh