Skip to content

@saehrimnir/druidjs / LDA

Class: LDA<T>

Defined in: dimred/LDA.js:20

Linear Discriminant Analysis (LDA)

A supervised dimensionality reduction technique that finds the axes that maximize the separation between multiple classes.

Template

Extends

  • DR

Type Parameters

Type ParameterDescription
T extends InputType

Constructors

Constructor

ts
new LDA<T>(X: T, parameters: Partial<ParametersLDA> & {
  labels: any[] | Float64Array<ArrayBufferLike>;
}): LDA<T>;

Defined in: dimred/LDA.js:28

Linear Discriminant Analysis.

Parameters

ParameterTypeDescription
XTThe high-dimensional data.
parametersPartial<ParametersLDA> & { labels: any[] | Float64Array<ArrayBufferLike>; }Object containing parameterization of the DR method.

Returns

LDA<T>

See

https://onlinelibrary.wiley.com/doi/10.1111/j.1469-1809.1936.tb02137.x

Overrides

ts
DR.constructor

Properties

PropertyTypeInherited fromDefined in
__inputTDR.__inputdimred/DR.js:38
_DnumberDR._Ddimred/DR.js:20
_is_initializedbooleanDR._is_initializeddimred/DR.js:26
_NnumberDR._Ndimred/DR.js:22
_parametersParametersLDADR._parametersdimred/DR.js:41
_randomizerRandomizerDR._randomizerdimred/DR.js:24
_type"array" | "matrix" | "typed"DR._typedimred/DR.js:46
XMatrixDR.Xdimred/DR.js:48
YMatrixDR.Ydimred/DR.js:50

Accessors

projection

Get Signature

ts
get projection(): T;

Defined in: dimred/DR.js:211

Returns

T

The projection in the type of input X.

Inherited from

ts
DR.projection

Methods

check_init()

ts
check_init(): DR<T, ParametersLDA>;

Defined in: dimred/DR.js:202

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

Returns

DR<T, ParametersLDA>

Inherited from

ts
DR.check_init

generator()

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

Defined in: dimred/LDA.js:41

Transforms the inputdata X to dimensionality d.

Returns

Generator<T, T, void>

A generator yielding the intermediate steps of the projection.

Overrides

ts
DR.generator

init()

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

Defined in: dimred/DR.js:193

Parameters

ParameterTypeDescription
...argsunknown[]-

Returns

void

Inherited from

ts
DR.init

parameter()

Call Signature

ts
parameter(): ParametersLDA;

Defined in: dimred/DR.js:74

Get all Parameters.

Returns

ParametersLDA

Inherited from
ts
DR.parameter

Call Signature

ts
parameter<K>(name: K): ParametersLDA[K];

Defined in: dimred/DR.js:80

Get value of given parameter.

Type Parameters
Type ParameterDescription
K extends keyof ParametersLDA
Parameters
ParameterTypeDescription
nameKName of the parameter.
Returns

ParametersLDA[K]

Inherited from
ts
DR.parameter

Call Signature

ts
parameter<K>(name: K, value: ParametersLDA[K]): LDA<T>;

Defined in: dimred/DR.js:87

Set value of given parameter.

Type Parameters
Type ParameterDescription
K extends keyof ParametersLDA
Parameters
ParameterTypeDescription
nameKName of the parameter.
valueParametersLDA[K]Value of the parameter to set.
Returns

LDA<T>

Inherited from
ts
DR.parameter

transform()

ts
transform(): T;

Defined in: dimred/LDA.js:51

Transforms the inputdata X to dimensionality d.

Returns

T

  • The projected data.

Overrides

ts
DR.transform

transform_async()

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

Defined in: dimred/DR.js:233

Computes the projection.

Parameters

ParameterTypeDescription
...argsunknown[]Arguments the transform method of the respective DR method takes.

Returns

Promise<T>

The dimensionality reduced dataset.

Inherited from

ts
DR.transform_async

generator()

ts
static generator<T, Para>(X: T, parameters: Para): Generator<T, T, void>;

Defined in: dimred/LDA.js:137

Type Parameters

Type ParameterDescription
T extends InputType
Para extends { seed?: number; }

Parameters

ParameterTypeDescription
XT-
parametersPara-

Returns

Generator<T, T, void>

Overrides

ts
DR.generator

transform()

ts
static transform<T, Para>(X: T, parameters: Para): T;

Defined in: dimred/LDA.js:124

Type Parameters

Type ParameterDescription
T extends InputType
Para extends { seed?: number; }

Parameters

ParameterTypeDescription
XT-
parametersPara-

Returns

T

Overrides

ts
DR.transform

transform_async()

ts
static transform_async<T, Para>(X: T, parameters: Para): Promise<T>;

Defined in: dimred/LDA.js:151

Type Parameters

Type ParameterDescription
T extends InputType
Para extends { seed?: number; }

Parameters

ParameterTypeDescription
XT-
parametersPara-

Returns

Promise<T>

Overrides

ts
DR.transform_async