@saehrimnir/druidjs / LocalMAP
Class: LocalMAP<T>
Defined in: dimred/LocalMAP.js:36
LocalMAP
A variant of PaCMAP that sharpens local cluster separation in phase 3. Attraction on the nearest-neighbor pairs is scaled by low_dist_thres / (2 * sqrt(d_ij)), which strengthens it for pairs already close in the embedding and weakens it for far ones, and the further pairs are periodically redrawn from points that are near in the current embedding rather than staying the random set chosen at initialization.
Template
T
See
Example
import * as druid from "@saehrimnir/druidjs";
const X = [[1, 2, 3, 4], [5, 6, 7, 8], [9, 10, 11, 12]];
const localmap = new druid.LocalMAP(X, {
n_neighbors: 10,
low_dist_thres: 10,
seed: 42
});
const Y = localmap.transform(); // 450 iterations (default)
// [[x1, y1], [x2, y2], [x3, y3]]Extends
Type Parameters
| Type Parameter | Description |
|---|---|
T extends InputType |
Constructors
Constructor
new LocalMAP<T>(X: T, parameters?: Partial<ParametersLocalMAP>): LocalMAP<T>;Defined in: dimred/LocalMAP.js:41
Parameters
| Parameter | Type | Description |
|---|---|---|
X | T | The high-dimensional data. |
parameters? | Partial<ParametersLocalMAP> | Object containing parameterization of the DR method. |
Returns
LocalMAP<T>
Overrides
Properties
Accessors
projection
Get Signature
get projection(): T;Defined in: dimred/DR.js:219
Returns
T
The projection in the type of input X.
Inherited from
Methods
[dispose]()
dispose: void;Defined in: dimred/DR.js:320
Alias of release for the using declaration, so a hand-driven run frees its buffers when the block exits. Note that transform and a completed or break-ed generator() already release on their own — this only matters for a generator abandoned part way.
using tsne = new TSNE(X, { d: 2 });
const steps = tsne.generator(500);
steps.next(); // buffers released when the enclosing block exitsReturns
void
Inherited from
check_init()
check_init(): DR<T, ParametersLocalMAP>;Defined in: dimred/DR.js:210
If the respective DR method has an init function, call it before transform.
Returns
DR<T, ParametersLocalMAP>
Inherited from
generator()
generator(iterations?: number): Generator<T, T, void>;Defined in: dimred/PaCMAP.js:605
Parameters
| Parameter | Type | Description |
|---|---|---|
iterations? | number | Total number of iterations. Defaults to sum of num_iters. |
Returns
Generator<T, T, void>
Inherited from
init()
init(): LocalMAP<T>;Defined in: dimred/PaCMAP.js:474
Initializes PaCMAP: preprocessing, PCA embedding, NN, MN and FP pairs, and Adam state.
Returns
LocalMAP<T>
Inherited from
next()
next(): Matrix;Defined in: dimred/PaCMAP.js:570
Performs one optimization step.
Returns
Inherited from
parameter()
Call Signature
parameter(): ParametersLocalMAP;Defined in: dimred/DR.js:82
Get all Parameters.
Returns
Inherited from
Call Signature
parameter<K>(name: K): ParametersLocalMAP[K];Defined in: dimred/DR.js:88
Get value of given parameter.
Type Parameters
| Type Parameter | Description |
|---|---|
K extends keyof ParametersLocalMAP |
Parameters
| Parameter | Type | Description |
|---|---|---|
name | K | Name of the parameter. |
Returns
Inherited from
Call Signature
parameter<K>(name: K, value: ParametersLocalMAP[K]): LocalMAP<T>;Defined in: dimred/DR.js:95
Set value of given parameter.
Type Parameters
| Type Parameter | Description |
|---|---|
K extends keyof ParametersLocalMAP |
Parameters
| Parameter | Type | Description |
|---|---|---|
name | K | Name of the parameter. |
value | ParametersLocalMAP[K] | Value of the parameter to set. |
Returns
LocalMAP<T>
Inherited from
release()
release(): LocalMAP<T>;Defined in: dimred/DR.js:302
Hands back the WASM buffers this instance is holding.
Only needed after driving generator() by hand and stopping early — a plain transform(), or a for…of over generator() (including one you break), already releases when it ends. It frees only this method's buffers, never another running instance's, and the next run simply reallocates, so it is safe to call at any time, more than once, and while other instances are mid-run.
Returns
LocalMAP<T>
Example
const tsne = new TSNE(X, { d: 2 });
const steps = tsne.generator(500);
steps.next();
tsne.release(); // stop early and give the buffers backInherited from
transform()
transform(iterations?: number): T;Defined in: dimred/PaCMAP.js:591
Parameters
| Parameter | Type | Description |
|---|---|---|
iterations? | number | Total number of iterations. Defaults to sum of num_iters. |
Returns
T
Inherited from
transform_async()
transform_async(...args: unknown[]): Promise<T>;Defined in: dimred/DR.js:241
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
generator()
static generator<T>(X: T, parameters?: Partial<ParametersLocalMAP>): Generator<T, T, void>;Defined in: dimred/LocalMAP.js:214
Type Parameters
| Type Parameter | Description |
|---|---|
T extends InputType |
Parameters
| Parameter | Type | Description |
|---|---|---|
X | T | - |
parameters? | Partial<ParametersLocalMAP> | - |
Returns
Generator<T, T, void>
Overrides
transform()
static transform<T>(X: T, parameters?: Partial<ParametersLocalMAP>): T;Defined in: dimred/LocalMAP.js:203
Type Parameters
| Type Parameter | Description |
|---|---|
T extends InputType |
Parameters
| Parameter | Type | Description |
|---|---|---|
X | T | - |
parameters? | Partial<ParametersLocalMAP> | - |
Returns
T
Overrides
transform_async()
static transform_async<T>(X: T, parameters?: Partial<ParametersLocalMAP>): Promise<T>;Defined in: dimred/LocalMAP.js:226
Type Parameters
| Type Parameter | Description |
|---|---|
T extends InputType |
Parameters
| Parameter | Type | Description |
|---|---|---|
X | T | - |
parameters? | Partial<ParametersLocalMAP> | - |
Returns
Promise<T>