UmapStatus

UmapStatus

Wrapper around the UMAP status object on the Wasm heap, typically created by initializeUmap.

Classes

UmapStatus

Methods

clone() → {UmapStatus}

Source:
Returns:

A deep copy of this object.

Type
UmapStatus

currentEpoch() → {number}

Source:
Returns:

Number of epochs processed so far. This changes with repeated invocations of runUmap, up to the maximum in totalEpochs.

Type
number

extractCoordinates() → {object}

Source:
Returns:

Object with x and y keys. 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.

numberOfCells() → {number}

Source:
Returns:

Number of cells in the dataset.

Type
number

run(optionsopt)

Source:

Run the UMAP algorithm 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
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 total number of epochs used to initialize x, or until the requested run time is exceeded, whichever comes first.

totalEpochs() → {number}

Source:
Returns:

Total number of epochs used to initialize this object.

Type
number