Class: SAMMON

new SAMMON(X, parameters) → {SAMMON}

SAMMON's Mapping

Parameters:

Name Type Description

X

Matrix

the high-dimensional data.

parameters

object

Object containing parameterization of the DR method.

Properties

Name	Type	Attributes	Default	Description
`d`	number	<optional>	2	the dimensionality of the projection.
`metric`	function \| "precomputed"	<optional>	euclidean	the metric which defines the distance between two points.
`init`	"PCA" \| "MDS" \| "random"	<optional>	"random"	Either "PCA" or "MDS", with which SAMMON initialiates the projection. With "random" a random matrix gets used as starting point.
`init_parameters`	object	<optional>		Parameters for the `init`-DR method.
`magic`	number	<optional>	0.1	learning rate for gradient descent.
`seed`	number	<optional>	1212	the seed for the random number generator.

Source: dimred/SAMMON.js, line 12
See: https://arxiv.org/pdf/2009.01512.pdf

Returns:

Type:: SAMMON

Extends

Members

projection

Overrides: DR#projection
Source: dimred/DR.js, line 112

Methods

check_init() → {DR}

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

Overrides: DR#check_init
Source: dimred/DR.js, line 101

Returns:

Type:: DR

(generator) generator(max_iteropt) → {Generator}

Transforms the inputdata X to dimenionality 2.

Parameters:

Name	Type	Attributes	Default	Description
`max_iter`	number	<optional>	200	Maximum number of iteration steps.

Overrides: DR#generator
Source: dimred/SAMMON.js, line 71

Returns:

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

Type:: Generator

parameter(nameopt, valueopt) → {DR|any|object}

Set and get parameters

Parameters:

Name	Type	Attributes	Default	Description
`name`	string	<optional>	null	Name of the parameter. If not given then returns all parameters as an Object.
`value`	any	<optional>	null	Value of the parameter to set. If `name` is set and `value` is not given, returns the value of the respective parameter.

Overrides: DR#parameter
Source: dimred/DR.js, line 56

Returns:

On setting a parameter, this function returns the DR object. If name is set and value == null then return actual parameter value. If name is not given, then returns all parameters as an Object.

Type:: DR | any | object

Example

'''
const DR = new druid.TSNE(X, {d: 3}); // creates a new DR object, with parameter for <code>d</code> = 3.
DR.parameter("d"); // returns 3,
DR.parameter("d", 2); // sets parameter <code>d</code> to 2 and returns <code>DR</code>.
'''

transform(max_iteropt) → {Matrix|Array}

Transforms the inputdata X to dimenionality 2.

Parameters:

Name	Type	Attributes	Default	Description
`max_iter`	number	<optional>	200	Maximum number of iteration steps.

Overrides: DR#transform
Source: dimred/SAMMON.js, line 58

Returns:

The projection of X.

Type:: Matrix | Array

(async) transform_async(…args) → {Promise.<(Matrix|Array.<Array.<number>>)>}

Computes the projection.

Parameters:

Name	Type	Attributes	Description
`args`	unknown	<repeatable>	Arguments the transform method of the respective DR method takes.

Overrides: DR#transform_async
Source: dimred/DR.js, line 126

Returns:

the dimensionality reduced dataset.

Type:: Promise.<(Matrix|Array.<Array.<number>>)>