@saehrimnir/druidjs / TopoMap

Class: TopoMap<T>

Defined in: dimred/TopoMap.js:23

TopoMap

A 0-dimensional Homology Preserving Projection of High-Dimensional Data. It aims to preserve the topological structure of the data by maintaining the connectivity of a minimum spanning tree.

Template

T

Extends

• DR

Type Parameters

Type Parameter	Description
T extends InputType

Constructors

Constructor

new TopoMap<T>(X: T, parameters: Partial<ParametersTopoMap>): TopoMap<T>;

Defined in: dimred/TopoMap.js:31

TopoMap: A 0-dimensional Homology Preserving Projection of High-Dimensional Data.

Parameters

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

Returns

TopoMap<T>

See

https://arxiv.org/pdf/2009.01512.pdf

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
_Emst	WeightedEdge[] | undefined	-	dimred/TopoMap.js:67
_is_initialized	boolean	DR._is_initialized	dimred/DR.js:34
_N	number	DR._N	dimred/DR.js:30
_parameters	ParametersTopoMap	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, ParametersTopoMap>;

Defined in: dimred/DR.js:210

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

Returns

DR<T, ParametersTopoMap>

Inherited from

DR.check_init

---

generator()

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

Defined in: dimred/TopoMap.js:295

Transforms the inputdata X to dimensionality 2.

Returns

Generator<T, T, void>

Overrides

DR.generator

---

init()

init(): TopoMap<T>;

Defined in: dimred/TopoMap.js:64

Initializes TopoMap. Sets all projcted points to zero, and computes a minimum spanning tree.

Returns

TopoMap<T>

Overrides

DR.init

---

parameter()

Call Signature

parameter(): ParametersTopoMap;

Defined in: dimred/DR.js:82

Get all Parameters.

Returns

ParametersTopoMap

Inherited from

DR.parameter

Call Signature

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

Defined in: dimred/DR.js:88

Get value of given parameter.

Type Parameters

Type Parameter	Description
K extends keyof ParametersTopoMap

Parameters

Parameter	Type	Description
name	K	Name of the parameter.

Returns

ParametersTopoMap[K]

Inherited from

DR.parameter

Call Signature

parameter<K>(name: K, value: ParametersTopoMap[K]): TopoMap<T>;

Defined in: dimred/DR.js:95

Set value of given parameter.

Type Parameters

Type Parameter	Description
K extends keyof ParametersTopoMap

Parameters

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

Returns

TopoMap<T>

Inherited from

DR.parameter

---

release()

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

TopoMap<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/TopoMap.js:263

Transforms the inputdata X to dimensionality 2.

Returns

T

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

Defined in: dimred/TopoMap.js:339

Type Parameters

Type Parameter	Description
T extends InputType

Parameters

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

Returns

Generator<T, T, void>

Overrides

DR.generator

---

transform()

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

Defined in: dimred/TopoMap.js:328

Type Parameters

Type Parameter	Description
T extends InputType

Parameters

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

Returns

T

Overrides

DR.transform

---

transform_async()

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

Defined in: dimred/TopoMap.js:351

Type Parameters

Type Parameter	Description
T extends InputType

Parameters

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

Returns

Promise<T>

Overrides

DR.transform_async