@saehrimnir/druidjs / PCA

Class: PCA<T>

Defined in: dimred/PCA.js:29

Principal Component Analysis (PCA)

A linear dimensionality reduction technique that identifies the axes (principal components) along which the variance of the data is maximized.

Template

See

MDS for another linear alternative

Example

import * as druid from "@saehrimnir/druidjs";

const X = [[1, 2], [3, 4], [5, 6]];
const pca = new druid.PCA(X, { d: 2 });
const Y = pca.transform();
// [[x1, y1], [x2, y2], [x3, y3]]

Extends

• DR

Type Parameters

Type Parameter	Description
T extends InputType

Constructors

Constructor

new PCA<T>(X: T, parameters?: Partial<ParametersPCA>): PCA<T>;

Defined in: dimred/PCA.js:34

Parameters

Parameter	Type	Description
X	T	The high-dimensional data.
parameters?	Partial<ParametersPCA>	Object containing parameterization of the DR method.

Returns

PCA<T>

Overrides

DR.constructor

Properties

Property	Type	Inherited from	Defined in
__input	T	DR.__input	dimred/DR.js:38
_D	number	DR._D	dimred/DR.js:20
_is_initialized	boolean	DR._is_initialized	dimred/DR.js:26
_N	number	DR._N	dimred/DR.js:22
_parameters	ParametersPCA	DR._parameters	dimred/DR.js:41
_randomizer	Randomizer	DR._randomizer	dimred/DR.js:24
_type	"array" | "matrix" | "typed"	DR._type	dimred/DR.js:46
V	Matrix | undefined	-	dimred/PCA.js:90
X	Matrix	DR.X	dimred/DR.js:48
Y	Matrix	DR.Y	dimred/DR.js:50

Accessors

projection

Get Signature

get projection(): T;

Defined in: dimred/DR.js:211

Returns

T

The projection in the type of input X.

Inherited from

DR.projection

Methods

check_init()

check_init(): DR<T, ParametersPCA>;

Defined in: dimred/DR.js:202

If the respective DR method has an init function, call it before transform.

Returns

DR<T, ParametersPCA>

Inherited from

DR.check_init

---

generator()

generator(): Generator<T, T, void>;

Defined in: dimred/PCA.js:47

Transforms the inputdata X to dimensionality d.

Returns

Generator<T, T, void>

A generator yielding the intermediate steps of the projection.

Overrides

DR.generator

---

init()

abstract init(...args: unknown[]): void;

Defined in: dimred/DR.js:193

Parameters

Parameter	Type	Description
...args	unknown[]	-

Returns

void

Inherited from

DR.init

---

parameter()

Call Signature

parameter(): ParametersPCA;

Defined in: dimred/DR.js:74

Get all Parameters.

Returns

ParametersPCA

Inherited from

DR.parameter

Call Signature

parameter<K>(name: K): ParametersPCA[K];

Defined in: dimred/DR.js:80

Get value of given parameter.

Type Parameters

Type Parameter	Description
K extends keyof ParametersPCA

Parameters

Parameter	Type	Description
name	K	Name of the parameter.

Returns

ParametersPCA[K]

Inherited from

DR.parameter

Call Signature

parameter<K>(name: K, value: ParametersPCA[K]): PCA<T>;

Defined in: dimred/DR.js:87

Set value of given parameter.

Type Parameters

Type Parameter	Description
K extends keyof ParametersPCA

Parameters

Parameter	Type	Description
name	K	Name of the parameter.
value	ParametersPCA[K]	Value of the parameter to set.

Returns

PCA<T>

Inherited from

DR.parameter

---

principal_components()

principal_components(): Matrix;

Defined in: dimred/PCA.js:80

Computes the d principal components of Matrix X.

Returns

Matrix

---

transform()

transform(): T;

Defined in: dimred/PCA.js:57

Transforms the inputdata X to dimensionality d.

Returns

T

• The projected data.

Overrides

DR.transform

---

transform_async()

transform_async(...args: unknown[]): Promise<T>;

Defined in: dimred/DR.js:233

Computes the projection.

Parameters

Parameter	Type	Description
...args	unknown[]	Arguments the transform method of the respective DR method takes.

Returns

Promise<T>

The dimensionality reduced dataset.

Inherited from

DR.transform_async

---

generator()

static generator<T>(X: T, parameters?: Partial<ParametersPCA>): Generator<T, T, void>;

Defined in: dimred/PCA.js:111

Type Parameters

Type Parameter	Description
T extends InputType

Parameters

Parameter	Type	Description
X	T	-
parameters?	Partial<ParametersPCA>	-

Returns

Generator<T, T, void>

Overrides

DR.generator

---

principal_components()

static principal_components<T>(X: T, parameters: Partial<ParametersPCA>): Matrix;

Defined in: dimred/PCA.js:100

Type Parameters

Type Parameter	Description
T extends InputType

Parameters

Parameter	Type	Description
X	T	-
parameters	Partial<ParametersPCA>	-

Returns

Matrix

---

transform()

static transform<T>(X: T, parameters: Partial<ParametersPCA>): T;

Defined in: dimred/PCA.js:70

Type Parameters

Type Parameter	Description
T extends InputType

Parameters

Parameter	Type	Description
X	T	-
parameters	Partial<ParametersPCA>	-

Returns

T

Overrides

DR.transform

---

transform_async()

static transform_async<T>(X: T, parameters?: Partial<ParametersPCA>): Promise<T>;

Defined in: dimred/PCA.js:123

Type Parameters

Type Parameter	Description
T extends InputType

Parameters

Parameter	Type	Description
X	T	-
parameters?	Partial<ParametersPCA>	-

Returns

Promise<T>

Overrides

DR.transform_async