@saehrimnir/druidjs / TriMap

Class: TriMap<T>

Defined in: dimred/TriMap.js:24

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

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

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:38
_D	number	DR._D	dimred/DR.js:20
_is_initialized	boolean	DR._is_initialized	dimred/DR.js:26
_N	number	DR._N	dimred/DR.js:22
_parameters	ParametersTriMap	DR._parameters	dimred/DR.js:41
_randomizer	Randomizer	DR._randomizer	dimred/DR.js:24
_type	"array" | "matrix" | "typed"	DR._type	dimred/DR.js:46
C	number | undefined	-	dimred/TriMap.js:68
gain	Matrix | undefined	-	dimred/TriMap.js:70
knn	| KNN<number[] | Float64Array<ArrayBufferLike>, any> | undefined	-	dimred/TriMap.js:63
lr	number | undefined	-	dimred/TriMap.js:67
n_inliers	number | undefined	-	dimred/TriMap.js:59
n_outliers	number | undefined	-	dimred/TriMap.js:60
n_random	number | undefined	-	dimred/TriMap.js:61
triplets	Matrix | undefined	-	dimred/TriMap.js:65
vel	Matrix | undefined	-	dimred/TriMap.js:69
weights	Float64Array<ArrayBuffer> | undefined	-	dimred/TriMap.js:66
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

_generate_triplets()

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

Defined in: dimred/TriMap.js:81

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:149
weights	Float64Array<ArrayBuffer>	weights	dimred/TriMap.js:150

---

_grad()

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

Defined in: dimred/TriMap.js:299

Computes the gradient for updating the embedding.

Parameters

Parameter	Type	Description
Y	Matrix	The embedding

Returns

{
  grad: Matrix;
  loss: number;
  n_viol: number;
}

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

---

check_init()

check_init(): DR<T, ParametersTriMap>;

Defined in: dimred/DR.js:202

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

Parameters

Parameter	Type	Default value	Description
max_iteration	number	800	-

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

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 BallTree gets used). Default is null

Returns

TriMap<T>

Overrides

DR.init

---

parameter()

Call Signature

parameter(): ParametersTriMap;

Defined in: dimred/DR.js:74

Get all Parameters.

Returns

ParametersTriMap

Inherited from

DR.parameter

Call Signature

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

Defined in: dimred/DR.js:80

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

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

---

transform()

transform(max_iteration?: number): T;

Defined in: dimred/TriMap.js:361

Parameters

Parameter	Type	Default value	Description
max_iteration	number	800	-

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

Defined in: dimred/TriMap.js:449

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

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

Type Parameters

Type Parameter	Description
T extends InputType

Parameters

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

Returns

Promise<T>

Overrides

DR.transform_async