@saehrimnir/druidjs / SMACOF

Class: SMACOF<T>

Defined in: dimred/SMACOF.js:21

Metric Multidimensional Scaling (MDS) via SMACOF.

SMACOF (Scaling by Majorizing a Complicated Function) is an iterative majorization algorithm for solving metric multidimensional scaling problems, which aims to minimize the stress function.

Template

See

MDS for the classical approach.

Extends

• DR

Type Parameters

Type Parameter	Description
T extends InputType

Constructors

Constructor

new SMACOF<T>(X: T, parameters?: Partial<ParametersSMACOF>): SMACOF<T>;

Defined in: dimred/SMACOF.js:28

SMACOF for MDS.

Parameters

Parameter	Type	Description
X	T	The high-dimensional data or precomputed distance matrix.
parameters?	Partial<ParametersSMACOF>	Object containing parameterization.

Returns

SMACOF<T>

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	ParametersSMACOF	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, ParametersSMACOF>;

Defined in: dimred/DR.js:202

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

Returns

DR<T, ParametersSMACOF>

Inherited from

DR.check_init

---

generator()

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

Defined in: dimred/SMACOF.js:35

Returns

Generator<T, T, void>

A generator yielding the intermediate steps of the projection.

Overrides

DR.generator

---

init()

abstract init(...args: unknown[]): void;

Defined in: dimred/DR.js:193

Parameters

Parameter	Type	Description
...args	unknown[]	-

Returns

void

Inherited from

DR.init

---

parameter()

Call Signature

parameter(): ParametersSMACOF;

Defined in: dimred/DR.js:74

Get all Parameters.

Returns

ParametersSMACOF

Inherited from

DR.parameter

Call Signature

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

Defined in: dimred/DR.js:80

Get value of given parameter.

Type Parameters

Type Parameter	Description
K extends keyof ParametersSMACOF

Parameters

Parameter	Type	Description
name	K	Name of the parameter.

Returns

ParametersSMACOF[K]

Inherited from

DR.parameter

Call Signature

parameter<K>(name: K, value: ParametersSMACOF[K]): SMACOF<T>;

Defined in: dimred/DR.js:87

Set value of given parameter.

Type Parameters

Type Parameter	Description
K extends keyof ParametersSMACOF

Parameters

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

Returns

SMACOF<T>

Inherited from

DR.parameter

---

transform()

transform(): T;

Defined in: dimred/SMACOF.js:122

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

Defined in: dimred/SMACOF.js:148

Type Parameters

Type Parameter	Description
T extends InputType

Parameters

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

Returns

Generator<T, T, void>

Overrides

DR.generator

---

transform()

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

Defined in: dimred/SMACOF.js:137

Type Parameters

Type Parameter	Description
T extends InputType

Parameters

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

Returns

T

Overrides

DR.transform

---

transform_async()

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

Defined in: dimred/SMACOF.js:160

Type Parameters

Type Parameter	Description
T extends InputType

Parameters

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

Returns

Promise<T>

Overrides

DR.transform_async