TsneStatus

TsneStatus

Wrapper around the t-SNE status object on the Wasm heap, typically created by initializeTsne.

Classes

TsneStatus

Methods

clone() → {TsneStatus}

Source:
Returns:

A deep copy of this object.

Type
TsneStatus

extractCoordinates() → {object}

Source:
Returns:

Object with x and y keys. The corresponding values are Float64Array objects of length equal to the number of cells, containing the x- and y- coordinates for each cell at the current state of the algorithm.

Type
object

free()

Source:
Returns:

Frees the memory allocated on the Wasm heap for this object. This invalidates this object and all references to it.

iterations() → {number}

Source:
Returns:

Number of iterations processed so far. This will change with repeated invocations of runTsne on this object.

Type
number

numberOfCells() → {number}

Source:
Returns:

Number of cells in the dataset.

Type
number

run(optionsopt)

Source:

Run the t-SNE algorithm to the specified number of iterations or for a certain time. This method may be called any number of times.

Parameters:
Name Type Attributes Default Description
options object <optional>
 {}

Optional parameters.

Properties
Name Type Attributes Default Description
maxIterations number <optional>
 1000

Maximum number of iterations to perform. This number includes all existing iterations that were already performed in x from previous calls to this method, so it should be greater than iterations.
runTime number <optional>
<nullable>
 null

Number of milliseconds for which the algorithm is allowed to run before returning. If null, no limit is imposed on the runtime.
Returns:

The algorithm status in x is advanced up to the requested number of iterations, or until the requested run time is exceeded, whichever comes first.