Class: DR

new DR(X, parameters) → {DR}

Takes the default parameters and seals them, remembers the type of input X, and initializes the random number generator.

Parameters:

Name Type Description

X

Matrix | Array.<Array.<number>>

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	<optional>	euclidean	the metric which defines the distance between two points.
`seed`	number	<optional>	1212	the seed value for the random number generator.

Source: dimred/DR.js, line 10

Returns:

Type:: DR

Members

projection

Source: dimred/DR.js, line 112

Methods

(generator, static) generator(…args) → {Generator}

Computes the projection.

Parameters:

Name	Type	Attributes	Description
`args`	unknown	<repeatable>	Takes the same arguments of the constructor of the respective DR method.

Source: dimred/DR.js, line 157

Returns:

a generator yielding the intermediate steps of the dimensionality reduction method.

Type:: Generator

(static) transform(…args) → {Matrix|Array.<Array.<number>>}

Computes the projection.

Parameters:

Name	Type	Attributes	Description
`args`	unknown	<repeatable>	Takes the same arguments of the constructor of the respective DR method.

Source: dimred/DR.js, line 136

Returns:

the dimensionality reduced dataset.

Type:: Matrix | Array.<Array.<number>>

(async, static) transform_async(…args) → {Promise}

Computes the projection.

Parameters:

Name	Type	Attributes	Description
`args`	unknown	<repeatable>	Takes the same arguments of the constructor of the respective DR method.

Source: dimred/DR.js, line 147

Returns:

a promise yielding the dimensionality reduced dataset.

Type:: Promise

check_init() → {DR}

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

Source: dimred/DR.js, line 101

Returns:

Type:: DR

(generator) generator() → {Matrix|Array.<Array.<number>>}

Computes the projection.

Source: dimred/DR.js, line 93

Yields:

the intermediate steps of the projection.

Type:: Matrix | Array.<Array.<number>>

p(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.

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>.
'''

p(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.

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>.
'''

para(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.

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>.
'''

para(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.

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>.
'''

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.

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() → {Matrix}

Computes the projection.

Source: dimred/DR.js, line 84

Returns:

the projection.

Type:: Matrix

(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.

Source: dimred/DR.js, line 126

Returns:

the dimensionality reduced dataset.

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