@saehrimnir/druidjs / SAMMON

Class: SAMMON<T>

Defined in: dimred/SAMMON.js:23

Sammon's Mapping

A nonlinear dimensionality reduction technique that minimizes a stress function based on the ratio of pairwise distances in high and low dimensional spaces.

Template

Extends

• DR

Type Parameters

Type Parameter	Description
T extends InputType

Constructors

Constructor

new SAMMON<T>(X: T, parameters?: Partial<ParametersSAMMON<AvailableInit>>): SAMMON<T>;

Defined in: dimred/SAMMON.js:35

SAMMON's Mapping

Parameters

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

Returns

SAMMON<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
_is_initialized	boolean	DR._is_initialized	dimred/DR.js:26
_N	number	DR._N	dimred/DR.js:22
_parameters	ParametersSAMMON<AvailableInit>	DR._parameters	dimred/DR.js:41
_randomizer	Randomizer	DR._randomizer	dimred/DR.js:24
_type	"array" | "matrix" | "typed"	DR._type	dimred/DR.js:46
distance_matrix	Matrix | undefined	-	dimred/SAMMON.js:25
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

_step()

_step(): Matrix;

Defined in: dimred/SAMMON.js:110

Returns

Matrix

---

check_init()

check_init(): DR<T, ParametersSAMMON<AvailableInit>>;

Defined in: dimred/DR.js:202

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

Returns

DR<T, ParametersSAMMON<AvailableInit>>

Inherited from

DR.check_init

---

generator()

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

Defined in: dimred/SAMMON.js:98

Transforms the inputdata X to dimenionality 2.

Parameters

Parameter	Type	Default value	Description
max_iter?	number	200	Maximum number of iteration steps. Default is 200

Returns

Generator<T, T, void>

A generator yielding the intermediate steps of the projection of X.

Overrides

DR.generator

---

init()

init(D: Matrix | undefined): asserts D is Matrix;

Defined in: dimred/SAMMON.js:56

Initializes the projection.

Parameters

Parameter	Type	Description
D	Matrix | undefined	-

Returns

asserts D is Matrix

Overrides

DR.init

---

parameter()

Call Signature

parameter(): ParametersSAMMON;

Defined in: dimred/DR.js:74

Get all Parameters.

Returns

ParametersSAMMON

Inherited from

DR.parameter

Call Signature

parameter<K>(name: K): ParametersSAMMON<AvailableInit>[K];

Defined in: dimred/DR.js:80

Get value of given parameter.

Type Parameters

Type Parameter	Description
K extends keyof ParametersSAMMON<AvailableInit>

Parameters

Parameter	Type	Description
name	K	Name of the parameter.

Returns

ParametersSAMMON<AvailableInit>[K]

Inherited from

DR.parameter

Call Signature

parameter<K>(name: K, value: ParametersSAMMON<AvailableInit>[K]): SAMMON<T>;

Defined in: dimred/DR.js:87

Set value of given parameter.

Type Parameters

Type Parameter	Description
K extends keyof ParametersSAMMON<AvailableInit>

Parameters

Parameter	Type	Description
name	K	Name of the parameter.
value	ParametersSAMMON<AvailableInit>[K]	Value of the parameter to set.

Returns

SAMMON<T>

Inherited from

DR.parameter

---

transform()

transform(max_iter?: number): T;

Defined in: dimred/SAMMON.js:82

Transforms the inputdata X to dimensionality 2.

Parameters

Parameter	Type	Default value	Description
max_iter?	number	200	Maximum number of iteration steps. Default is 200

Returns

T

The projection of X.

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

Defined in: dimred/SAMMON.js:178

Type Parameters

Type Parameter	Description
T extends InputType

Parameters

Parameter	Type	Description
X	T	-
parameters?	Partial<ParametersSAMMON<AvailableInit>>	-

Returns

Generator<T, T, void>

Overrides

DR.generator

---

transform()

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

Defined in: dimred/SAMMON.js:167

Type Parameters

Type Parameter	Description
T extends InputType

Parameters

Parameter	Type	Description
X	T	-
parameters?	Partial<ParametersSAMMON<AvailableInit>>	-

Returns

T

Overrides

DR.transform

---

transform_async()

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

Defined in: dimred/SAMMON.js:190

Type Parameters

Type Parameter	Description
T extends InputType

Parameters

Parameter	Type	Description
X	T	-
parameters?	Partial<ParametersSAMMON<AvailableInit>>	-

Returns

Promise<T>

Overrides

DR.transform_async