@saehrimnir/druidjs / TriMap

Class: TriMap<T>

Defined in: dimred/TriMap.js:51

TriMap

A dimensionality reduction technique that preserves both local and global structure using triplets. It is designed to be a more robust alternative to t-SNE and UMAP.

Template

T

Extends

• DR

Type Parameters

Type Parameter	Description
T extends InputType

Constructors

Constructor

new TriMap<T>(X: T, parameters?: Partial<ParametersTriMap>): TriMap<T>;

Defined in: dimred/TriMap.js:63

Parameters

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

Returns

TriMap<T>

See

• https://arxiv.org/pdf/1910.00204v1.pdf
• https://github.com/eamid/trimap

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	ParametersTriMap	DR._parameters	dimred/DR.js:49
_randomizer	Randomizer	DR._randomizer	dimred/DR.js:32
_triplets_int32	Int32Array<ArrayBufferLike> | undefined	-	dimred/TriMap.js:102
_type	"array" | "matrix" | "typed"	DR._type	dimred/DR.js:54
C	number | undefined	-	dimred/TriMap.js:104
gain	Matrix | undefined	-	dimred/TriMap.js:106
knn	| KNN<number[] | Float64Array<ArrayBufferLike>, any> | undefined	-	dimred/TriMap.js:95
lr	number | undefined	-	dimred/TriMap.js:103
n_inliers	number | undefined	-	dimred/TriMap.js:91
n_outliers	number | undefined	-	dimred/TriMap.js:92
n_random	number | undefined	-	dimred/TriMap.js:93
triplets	Matrix | undefined	-	dimred/TriMap.js:97
vel	Matrix | undefined	-	dimred/TriMap.js:105
weights	Float64Array<ArrayBuffer> | undefined	-	dimred/TriMap.js:98
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

_generate_triplets()

_generate_triplets(
   n_inliers: number, 
   n_outliers: number, 
   n_random: number): {
  triplets: Matrix;
  weights: Float64Array<ArrayBuffer>;
};

Defined in: dimred/TriMap.js:117

Generates n_inliers x n_outliers x n_random triplets.

Parameters

Parameter	Type	Description
n_inliers	number	-
n_outliers	number	-
n_random	number	-

Returns

{
  triplets: Matrix;
  weights: Float64Array<ArrayBuffer>;
}

Name	Type	Default value	Defined in
triplets	Matrix	triplets	dimred/TriMap.js:176
weights	Float64Array<ArrayBuffer>	weights	dimred/TriMap.js:177

---

_grad()

_grad(Y: Matrix): {
  grad: Matrix;
  loss: number;
};

Defined in: dimred/TriMap.js:333

Computes the gradient for updating the embedding.

Parameters

Parameter	Type	Description
Y	Matrix	The embedding

Returns

{
  grad: Matrix;
  loss: number;
}

The gradient and the current loss.

Name	Type	Defined in
grad	Matrix	dimred/TriMap.js:331
loss	number	dimred/TriMap.js:331

---

[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, ParametersTriMap>;

Defined in: dimred/DR.js:210

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

Returns

DR<T, ParametersTriMap>

Inherited from

DR.check_init

---

generator()

generator(max_iteration?: number): Generator<T, T, void>;

Defined in: dimred/TriMap.js:423

Parameters

Parameter	Type	Default value	Description
max_iteration	number	400	-

Returns

Generator<T, T, void>

Overrides

DR.generator

---

init()

init(pca?: Matrix | null, knn?: 
  | KNN<number[] | Float64Array<ArrayBufferLike>, any>
| null): TriMap<T>;

Defined in: dimred/TriMap.js:84

Parameters

Parameter	Type	Default value	Description
pca?	Matrix | null	null	Initial Embedding (if null then PCA gets used). Default is null
knn?	| KNN<number[] | Float64Array<ArrayBufferLike>, any> | null	null	KNN Object (if null then a KDTree or BallTree gets used, depending on the metric). Default is null

Returns

TriMap<T>

Overrides

DR.init

---

parameter()

Call Signature

parameter(): ParametersTriMap;

Defined in: dimred/DR.js:82

Get all Parameters.

Returns

ParametersTriMap

Inherited from

DR.parameter

Call Signature

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

Defined in: dimred/DR.js:88

Get value of given parameter.

Type Parameters

Type Parameter	Description
K extends keyof ParametersTriMap

Parameters

Parameter	Type	Description
name	K	Name of the parameter.

Returns

ParametersTriMap[K]

Inherited from

DR.parameter

Call Signature

parameter<K>(name: K, value: ParametersTriMap[K]): TriMap<T>;

Defined in: dimred/DR.js:95

Set value of given parameter.

Type Parameters

Type Parameter	Description
K extends keyof ParametersTriMap

Parameters

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

Returns

TriMap<T>

Inherited from

DR.parameter

---

release()

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

TriMap<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(max_iteration?: number): T;

Defined in: dimred/TriMap.js:407

Parameters

Parameter	Type	Default value	Description
max_iteration	number	400	-

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

Defined in: dimred/TriMap.js:509

Type Parameters

Type Parameter	Description
T extends InputType

Parameters

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

Returns

Generator<T, T, void>

Overrides

DR.generator

---

transform()

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

Defined in: dimred/TriMap.js:498

Type Parameters

Type Parameter	Description
T extends InputType

Parameters

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

Returns

T

Overrides

DR.transform

---

transform_async()

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

Defined in: dimred/TriMap.js:521

Type Parameters

Type Parameter	Description
T extends InputType

Parameters

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

Returns

Promise<T>

Overrides

DR.transform_async