@saehrimnir/druidjs / LSP

Class: LSP<T>

Defined in: dimred/LSP.js:23

Least Square Projection (LSP)

A dimensionality reduction technique that uses a small set of control points (projected with MDS) to define the projection for the rest of the data using a Laplacian-based optimization.

Template

T

Extends

• DR

Type Parameters

Type Parameter	Description
T extends InputType

Constructors

Constructor

new LSP<T>(X: T, parameters?: Partial<ParametersLSP>): LSP<T>;

Defined in: dimred/LSP.js:31

Least Squares Projection.

Parameters

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

Returns

LSP<T>

See

https://ieeexplore.ieee.org/document/4378370

Overrides

DR.constructor

Properties

Property	Type	Inherited from	Defined in
__input	T	DR.__input	dimred/DR.js:46
_A	Matrix | undefined	-	dimred/LSP.js:91
_b	Matrix | undefined	-	dimred/LSP.js:92
_D	number	DR._D	dimred/DR.js:28
_is_initialized	boolean	DR._is_initialized	dimred/LSP.js:49
_N	number	DR._N	dimred/DR.js:30
_parameters	ParametersLSP	DR._parameters	dimred/DR.js:49
_randomizer	Randomizer	DR._randomizer	dimred/DR.js:32
_type	"array" | "matrix" | "typed"	DR._type	dimred/DR.js:54
X	Matrix	DR.X	dimred/DR.js:56
Y	Matrix	DR.Y	dimred/DR.js:58

Accessors

projection

Get Signature

get projection(): T;

Defined in: dimred/DR.js:219

Returns

T

The projection in the type of input X.

Inherited from

DR.projection

Methods

[dispose]()

dispose: void;

Defined in: dimred/DR.js:320

Alias of release for the using declaration, so a hand-driven run frees its buffers when the block exits. Note that transform and a completed or break-ed generator() already release on their own — this only matters for a generator abandoned part way.

using tsne = new TSNE(X, { d: 2 });
const steps = tsne.generator(500);
steps.next(); // buffers released when the enclosing block exits

Returns

void

Inherited from

DR.[dispose]

---

check_init()

check_init(): DR<T, ParametersLSP>;

Defined in: dimred/DR.js:210

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

Returns

DR<T, ParametersLSP>

Inherited from

DR.check_init

---

generator()

abstract generator(...args: unknown[]): Generator<T, T, void>;

Defined in: dimred/DR.js:169

Computes the projection.

Parameters

Parameter	Type	Description
...args	unknown[]	-

Returns

Generator<T, T, void>

The intermediate steps of the projection.

Inherited from

DR.generator

---

init()

init(): LSP<T>;

Defined in: dimred/LSP.js:56

Returns

LSP<T>

Overrides

DR.init

---

parameter()

Call Signature

parameter(): ParametersLSP;

Defined in: dimred/DR.js:82

Get all Parameters.

Returns

ParametersLSP

Inherited from

DR.parameter

Call Signature

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

Defined in: dimred/DR.js:88

Get value of given parameter.

Type Parameters

Type Parameter	Description
K extends keyof ParametersLSP

Parameters

Parameter	Type	Description
name	K	Name of the parameter.

Returns

ParametersLSP[K]

Inherited from

DR.parameter

Call Signature

parameter<K>(name: K, value: ParametersLSP[K]): LSP<T>;

Defined in: dimred/DR.js:95

Set value of given parameter.

Type Parameters

Type Parameter	Description
K extends keyof ParametersLSP

Parameters

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

Returns

LSP<T>

Inherited from

DR.parameter

---

release()

release(): LSP<T>;

Defined in: dimred/DR.js:302

Hands back the WASM buffers this instance is holding.

Only needed after driving generator() by hand and stopping early — a plain transform(), or a for…of over generator() (including one you break), already releases when it ends. It frees only this method's buffers, never another running instance's, and the next run simply reallocates, so it is safe to call at any time, more than once, and while other instances are mid-run.

Returns

LSP<T>

Example

const tsne = new TSNE(X, { d: 2 });
const steps = tsne.generator(500);
steps.next();
tsne.release(); // stop early and give the buffers back

Inherited from

DR.release

---

transform()

transform(): T;

Defined in: dimred/LSP.js:102

Computes the projection.

Returns

T

Returns the projection.

Overrides

DR.transform

---

transform_async()

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

Defined in: dimred/DR.js:241

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<ParametersLSP>): Generator<T, T, void>;

Defined in: dimred/LSP.js:131

Type Parameters

Type Parameter	Description
T extends InputType

Parameters

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

Returns

Generator<T, T, void>

Overrides

DR.generator

---

transform()

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

Defined in: dimred/LSP.js:120

Type Parameters

Type Parameter	Description
T extends InputType

Parameters

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

Returns

T

Overrides

DR.transform

---

transform_async()

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

Defined in: dimred/LSP.js:143

Type Parameters

Type Parameter	Description
T extends InputType

Parameters

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

Returns

Promise<T>

Overrides

DR.transform_async