@saehrimnir/druidjs / SQDMDS

Class: SQDMDS<T>

Defined in: dimred/SQDMDS.js:21

SQuadMDS (Stochastic Quartet MDS)

A lean Stochastic Quartet MDS improving global structure preservation in neighbor embedding like t-SNE and UMAP.

Template

Extends

• DR

Type Parameters

Type Parameter	Description
T extends InputType

Constructors

Constructor

new SQDMDS<T>(X: T, parameters?: Partial<ParametersSQDMDS>): SQDMDS<T>;

Defined in: dimred/SQDMDS.js:30

SQuadMDS: a lean Stochastic Quartet MDS improving global structure preservation in neighbor embedding like t-SNE and UMAP.

Parameters

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

Returns

SQDMDS<T>

See

https://arxiv.org/pdf/2202.12087.pdf

Overrides

DR.constructor

Properties

Property	Type	Inherited from	Defined in
__input	T	DR.__input	dimred/DR.js:38
_add	| (...summands: Float64Array<ArrayBufferLike>[]) => Float64Array<ArrayBufferLike> | undefined	-	dimred/SQDMDS.js:54
_D	number	DR._D	dimred/DR.js:20
_decay_start	number | undefined	-	dimred/SQDMDS.js:96
_distance_exaggeration	boolean | undefined	-	dimred/SQDMDS.js:137
_grads	Matrix | undefined	-	dimred/SQDMDS.js:63
_HD_metric	| (i: number, j: number, X: Matrix) => number | undefined	-	dimred/SQDMDS.js:73
_HD_metric_exaggeration	| (i: number, j: number, X: Matrix) => number | undefined	-	dimred/SQDMDS.js:75
_indices	number[] | undefined	-	dimred/SQDMDS.js:64
_is_initialized	boolean	DR._is_initialized	dimred/DR.js:26
_LR	number | undefined	-	dimred/SQDMDS.js:59
_LR_init	number | undefined	-	dimred/SQDMDS.js:58
_minus	| (a: Float64Array<ArrayBufferLike>, b: Float64Array<ArrayBufferLike>) => Float64Array<ArrayBufferLike> | undefined	-	dimred/SQDMDS.js:56
_momentums	Matrix | undefined	-	dimred/SQDMDS.js:62
_mult	| (a: Float64Array<ArrayBufferLike>, v: number) => Float64Array<ArrayBufferLike> | undefined	-	dimred/SQDMDS.js:57
_N	number	DR._N	dimred/DR.js:22
_offset	number | undefined	-	dimred/SQDMDS.js:61
_parameters	ParametersSQDMDS	DR._parameters	dimred/DR.js:41
_randomizer	Randomizer	DR._randomizer	dimred/DR.js:24
_sub_div	| (x: Float64Array<ArrayBufferLike>, y: Float64Array<ArrayBufferLike>, div: number) => Float64Array<ArrayBufferLike> | undefined	-	dimred/SQDMDS.js:55
_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

__add()

__add(d: number): (...summands: Float64Array<ArrayBufferLike>[]) => Float64Array<ArrayBufferLike>;

Defined in: dimred/SQDMDS.js:425

Inline!

Parameters

Parameter	Type	Description
d	number	-

Returns

(...summands: Float64Array<ArrayBufferLike>[]): Float64Array<ArrayBufferLike>;

Parameters

Parameter	Type
...summands	Float64Array<ArrayBufferLike>[]

Returns

Float64Array<ArrayBufferLike>

---

__minus()

__minus(d: number): (a: Float64Array<ArrayBufferLike>, b: Float64Array<ArrayBufferLike>) => Float64Array<ArrayBufferLike>;

Defined in: dimred/SQDMDS.js:411

Inline!

Parameters

Parameter	Type	Description
d	number	-

Returns

(a: Float64Array<ArrayBufferLike>, b: Float64Array<ArrayBufferLike>): Float64Array<ArrayBufferLike>;

Parameters

Parameter	Type
a	Float64Array<ArrayBufferLike>
b	Float64Array<ArrayBufferLike>

Returns

Float64Array<ArrayBufferLike>

---

__mult()

__mult(d: number): (a: Float64Array<ArrayBufferLike>, v: number) => Float64Array<ArrayBufferLike>;

Defined in: dimred/SQDMDS.js:444

Inline!

Parameters

Parameter	Type	Description
d	number	-

Returns

(a: Float64Array<ArrayBufferLike>, v: number): Float64Array<ArrayBufferLike>;

Parameters

Parameter	Type
a	Float64Array<ArrayBufferLike>
v	number

Returns

Float64Array<ArrayBufferLike>

---

__sub_div()

__sub_div(d: number): (x: Float64Array<ArrayBufferLike>, y: Float64Array<ArrayBufferLike>, div: number) => Float64Array<ArrayBufferLike>;

Defined in: dimred/SQDMDS.js:458

Creates a new array (x - y) / div.

Parameters

Parameter	Type	Description
d	number	-

Returns

(
   x: Float64Array<ArrayBufferLike>, 
   y: Float64Array<ArrayBufferLike>, 
div: number): Float64Array<ArrayBufferLike>;

Parameters

Parameter	Type
x	Float64Array<ArrayBufferLike>
y	Float64Array<ArrayBufferLike>
div	number

Returns

Float64Array<ArrayBufferLike>

---

_fill_MDS_grads()

_fill_MDS_grads(
   Y: Matrix, 
   grads: Matrix, 
   exaggeration?: boolean, 
   zero_grad?: boolean): Matrix;

Defined in: dimred/SQDMDS.js:205

Computes the gradients.

Parameters

Parameter	Type	Default value	Description
Y	Matrix	undefined	The Projection.
grads	Matrix	undefined	The gradients.
exaggeration?	boolean	false	Whether or not to use early exaggeration. Default is false
zero_grad?	boolean	true	Whether or not to reset the gradient in the beginning. Default is true

Returns

Matrix

The gradients.

---

check_init()

check_init(): DR<T, ParametersSQDMDS>;

Defined in: dimred/DR.js:202

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

Returns

DR<T, ParametersSQDMDS>

Inherited from

DR.check_init

---

generator()

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

Defined in: dimred/SQDMDS.js:109

Computes the projection.

Parameters

Parameter	Type	Default value	Description
iterations?	number	500	Number of iterations. Default is 500

Returns

Generator<T, T, void>

The intermediate steps of the projection.

Overrides

DR.generator

---

init()

abstract init(): void;

Defined in: dimred/SQDMDS.js:49

Returns

void

Overrides

DR.init

---

parameter()

Call Signature

parameter(): ParametersSQDMDS;

Defined in: dimred/DR.js:74

Get all Parameters.

Returns

ParametersSQDMDS

Inherited from

DR.parameter

Call Signature

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

Defined in: dimred/DR.js:80

Get value of given parameter.

Type Parameters

Type Parameter	Description
K extends keyof ParametersSQDMDS

Parameters

Parameter	Type	Description
name	K	Name of the parameter.

Returns

ParametersSQDMDS[K]

Inherited from

DR.parameter

Call Signature

parameter<K>(name: K, value: ParametersSQDMDS[K]): SQDMDS<T>;

Defined in: dimred/DR.js:87

Set value of given parameter.

Type Parameters

Type Parameter	Description
K extends keyof ParametersSQDMDS

Parameters

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

Returns

SQDMDS<T>

Inherited from

DR.parameter

---

transform()

transform(iterations?: number): T;

Defined in: dimred/SQDMDS.js:93

Computes the projection.

Parameters

Parameter	Type	Default value	Description
iterations?	number	500	Number of iterations. Default is 500

Returns

T

The projection.

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

Defined in: dimred/SQDMDS.js:481

Type Parameters

Type Parameter	Description
T extends InputType

Parameters

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

Returns

Generator<T, T, void>

Overrides

DR.generator

---

transform()

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

Defined in: dimred/SQDMDS.js:470

Type Parameters

Type Parameter	Description
T extends InputType

Parameters

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

Returns

T

Overrides

DR.transform

---

transform_async()

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

Defined in: dimred/SQDMDS.js:493

Type Parameters

Type Parameter	Description
T extends InputType

Parameters

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

Returns

Promise<T>

Overrides

DR.transform_async