@saehrimnir/druidjs / TopoMap

Class: TopoMap<T>

Defined in: dimred/TopoMap.js:21

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

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:29

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:38
_D	number	DR._D	dimred/DR.js:20
_disjoint_set	| DisjointSet<Float64Array<ArrayBufferLike>> | undefined	-	dimred/TopoMap.js:66
_distance_matrix	Matrix	-	dimred/TopoMap.js:32
_Emst	number[][] | undefined	-	dimred/TopoMap.js:94
_is_initialized	boolean	DR._is_initialized	dimred/DR.js:26
_N	number	DR._N	dimred/DR.js:22
_parameters	ParametersTopoMap	DR._parameters	dimred/DR.js:41
_randomizer	Randomizer	DR._randomizer	dimred/DR.js:24
_type	"array" | "matrix" | "typed"	DR._type	dimred/DR.js:46
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, ParametersTopoMap>;

Defined in: dimred/DR.js:202

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:322

Transforms the inputdata X to dimensionality 2.

Returns

Generator<T, T, void>

Overrides

DR.generator

---

init()

init(): TopoMap<T>;

Defined in: dimred/TopoMap.js:91

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:74

Get all Parameters.

Returns

ParametersTopoMap

Inherited from

DR.parameter

Call Signature

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

Defined in: dimred/DR.js:80

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:87

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

---

transform()

transform(): T;

Defined in: dimred/TopoMap.js:290

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

Defined in: dimred/TopoMap.js:366

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:355

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:378

Type Parameters

Type Parameter	Description
T extends InputType

Parameters

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

Returns

Promise<T>

Overrides

DR.transform_async