Principal Component Analysis - 5.2 English - 68552

AOCL API Guide (68552)

Document ID
68552
Release Date
2025-12-29
Version
5.2 English

The following options are supported.

Table 4.4 Table of Options for Principal Component Analysis.#

Option name

Type

Default

Description

Constraints

degrees of freedom

string

\(s=\) unbiased

Whether to use biased or unbiased estimators for standard deviations and variances.

\(s=\) biased, or unbiased.

pca method

string

\(s=\) covariance

Compute PCA based on the covariance or correlation matrix.

\(s=\) correlation, covariance, or svd.

whiten

integer

\(i=0\)

Whether or not we whiten when transforming the data.

\(0 \le i \le 1\)

store u

integer

\(i=0\)

Whether or not to store the matrix U from the SVD.

\(0 \le i \le 1\)

n_components

integer

\(i=1\)

Number of principal components to compute. If 0, then all components will be kept.

\(0 \le i\)

svd solver

string

\(s=\) auto

Which LAPACK routine to use for the underlying singular value decomposition.

\(s=\) auto, gesdd, gesvd, gesvdx, or syevd.

check data

string

\(s=\) no

Check input data for NaNs prior to performing computation.

\(s=\) no, or yes.

storage order

string

\(s=\) column-major

Whether data is supplied and returned in row- or column-major order.

\(s=\) c, column-major, f, fortran, or row-major.