@saehrimnir/druidjs / FASTMAP

Class: FASTMAP<T>

Defined in: dimred/FASTMAP.js:20

FastMap algorithm for dimensionality reduction.

A very fast algorithm for projecting high-dimensional data into a lower-dimensional space while preserving pairwise distances. It works similarly to PCA but uses only a subset of the data to find projection axes.

Template

T

Extends

• DR

Type Parameters

Type Parameter	Description
T extends InputType

Constructors

Constructor

new FASTMAP<T>(X: T, parameters: Partial<ParametersFASTMAP>): FASTMAP<T>;

Defined in: dimred/FASTMAP.js:27

FastMap: a fast algorithm for indexing, data-mining and visualization of traditional and multimedia datasets.

Parameters

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

Returns

FASTMAP<T>

See

https://doi.org/10.1145/223784.223812

Overrides

DR.constructor

Properties

Property	Type	Inherited from	Defined in
__input	T	DR.__input	dimred/DR.js:46
_D	number	DR._D	dimred/DR.js:28
_is_initialized	boolean	DR._is_initialized	dimred/DR.js:34
_N	number	DR._N	dimred/DR.js:30
_parameters	ParametersFASTMAP	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, ParametersFASTMAP>;

Defined in: dimred/DR.js:210

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

Returns

DR<T, ParametersFASTMAP>

Inherited from

DR.check_init

---

generator()

abstract generator(): Generator<T, T, unknown>;

Defined in: dimred/FASTMAP.js:103

Computes the projection.

Returns

Generator<T, T, unknown>

The intermediate steps of the projection.

Overrides

DR.generator

---

init()

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

Defined in: dimred/DR.js:201

Parameters

Parameter	Type	Description
...args	unknown[]	-

Returns

void

Inherited from

DR.init

---

parameter()

Call Signature

parameter(): ParametersFASTMAP;

Defined in: dimred/DR.js:82

Get all Parameters.

Returns

ParametersFASTMAP

Inherited from

DR.parameter

Call Signature

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

Defined in: dimred/DR.js:88

Get value of given parameter.

Type Parameters

Type Parameter	Description
K extends keyof ParametersFASTMAP

Parameters

Parameter	Type	Description
name	K	Name of the parameter.

Returns

ParametersFASTMAP[K]

Inherited from

DR.parameter

Call Signature

parameter<K>(name: K, value: ParametersFASTMAP[K]): FASTMAP<T>;

Defined in: dimred/DR.js:95

Set value of given parameter.

Type Parameters

Type Parameter	Description
K extends keyof ParametersFASTMAP

Parameters

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

Returns

FASTMAP<T>

Inherited from

DR.parameter

---

release()

release(): FASTMAP<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

FASTMAP<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/FASTMAP.js:70

Computes the projection.

Returns

T

The d-dimensional projection of the data matrix X.

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

Defined in: dimred/FASTMAP.js:125

Type Parameters

Type Parameter	Description
T extends InputType

Parameters

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

Returns

Generator<T, T, void>

Overrides

DR.generator

---

transform()

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

Defined in: dimred/FASTMAP.js:114

Type Parameters

Type Parameter	Description
T extends InputType

Parameters

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

Returns

T

Overrides

DR.transform

---

transform_async()

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

Defined in: dimred/FASTMAP.js:137

Type Parameters

Type Parameter	Description
T extends InputType

Parameters

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

Returns

Promise<T>

Overrides

DR.transform_async