@elarsaks/umap-wasm 0.3.13 → 0.3.15

package/dist/heap.d.ts

@@ -1,111 +1,12 @@
-/**
- * @license
- *
- * Copyright 2019 Google LLC. All Rights Reserved.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * ==============================================================================
- */
-/**
- * This is a JavaScript reimplementation of UMAP (original license below), from
- * the python implementation found at https://github.com/lmcinnes/umap.
- *
- * @author andycoenen@google.com (Andy Coenen)
- */
-/**
- * @license
- * BSD 3-Clause License
- *
- * Copyright (c) 2017, Leland McInnes
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * * Redistributions of source code must retain the above copyright notice, this
- *   list of conditions and the following disclaimer.
- *
- * * Redistributions in binary form must reproduce the above copyright notice,
- *   this list of conditions and the following disclaimer in the documentation
- *   and/or other materials provided with the distribution.
- *
- * * Neither the name of the copyright holder nor the names of its
- *   contributors may be used to endorse or promote products derived from
- *   this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
 import { RandomFn } from './umap.js';
 export type Heap = number[][][];
-/**
- *  Constructor for the heap objects. The heaps are used
- * for approximate nearest neighbor search, maintaining a list of potential
- * neighbors sorted by their distance. We also flag if potential neighbors
- * are newly added to the list or not. Internally this is stored as
- * a single array; the first axis determines whether we are looking at the
- * array of candidate indices, the array of distances, or the flag array for
- * whether elements are new or not. Each of these arrays are of shape
- * (``nPoints``, ``size``)
- */
 export declare function makeHeap(nPoints: number, size: number): Heap;
-/**
- * Generate n_samples many integers from 0 to pool_size such that no
- * integer is selected twice. The duplication constraint is achieved via
- * rejection sampling.
- */
 export declare function rejectionSample(nSamples: number, poolSize: number, random: RandomFn): number[];
-/**
- * Push a new element onto the heap. The heap stores potential neighbors
- * for each data point. The ``row`` parameter determines which data point we
- * are addressing, the ``weight`` determines the distance (for heap sorting),
- * the ``index`` is the element to add, and the flag determines whether this
- * is to be considered a new addition.
- */
 export declare function heapPush(heap: Heap, row: number, weight: number, index: number, flag: number): number;
-/**
- * Push a new element onto the heap. The heap stores potential neighbors
- * for each data point. The ``row`` parameter determines which data point we
- * are addressing, the ``weight`` determines the distance (for heap sorting),
- * the ``index`` is the element to add, and the flag determines whether this
- * is to be considered a new addition.
- */
 export declare function uncheckedHeapPush(heap: Heap, row: number, weight: number, index: number, flag: number): number;
-/**
- * Build a heap of candidate neighbors for nearest neighbor descent. For
- * each vertex the candidate neighbors are any current neighbors, and any
- * vertices that have the vertex as one of their nearest neighbors.
- */
 export declare function buildCandidates(currentGraph: Heap, nVertices: number, nNeighbors: number, maxCandidates: number, random: RandomFn): Heap;
-/**
- * Given an array of heaps (of indices and weights), unpack the heap
- * out to give and array of sorted lists of indices and weights by increasing
- * weight. This is effectively just the second half of heap sort (the first
- * half not being required since we already have the data in a heap).
- */
 export declare function deheapSort(heap: Heap): {
     indices: number[][];
     weights: number[][];
 };
-/**
- * Search the heap for the smallest element that is still flagged.
- */
 export declare function smallestFlagged(heap: Heap, row: number): number;

package/dist/index.d.ts

@@ -1,20 +1,2 @@
-/**
- * @license
- *
- * Copyright 2019 Google LLC. All Rights Reserved.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * ==============================================================================
- */
 export { UMAP, UMAPParameters } from './umap.js';
 export { initWasm, isWasmAvailable } from './wasmBridge.js';

package/dist/lib.d.ts

@@ -1,20 +1,2 @@
-/**
- * @license
- *
- * Copyright 2019 Google LLC. All Rights Reserved.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * ==============================================================================
- */
 export { UMAP } from './umap.js';
 export { initWasm, isWasmAvailable } from './wasmBridge.js';

package/dist/matrix.d.ts

@@ -1,24 +1,3 @@
-/**
- * @license
- *
- * Copyright 2019 Google LLC. All Rights Reserved.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * ==============================================================================
- */
-/**
- * Internal 2-dimensional sparse matrix class
- */
 export declare class SparseMatrix {
     private entries;
     readonly nRows: number;
@@ -41,53 +20,20 @@ export declare class SparseMatrix {
     map(fn: (value: number, row: number, col: number) => number): SparseMatrix;
     toArray(): number[][];
 }
-/**
- * Transpose a sparse matrix
- */
 export declare function transpose(matrix: SparseMatrix): SparseMatrix;
-/**
- * Construct a sparse identity matrix
- */
 export declare function identity(size: number[]): SparseMatrix;
-/**
- * Element-wise multiplication of two matrices
- */
 export declare function pairwiseMultiply(a: SparseMatrix, b: SparseMatrix): SparseMatrix;
-/**
- * Element-wise addition of two matrices
- */
 export declare function add(a: SparseMatrix, b: SparseMatrix): SparseMatrix;
-/**
- * Element-wise subtraction of two matrices
- */
 export declare function subtract(a: SparseMatrix, b: SparseMatrix): SparseMatrix;
-/**
- * Element-wise maximum of two matrices
- */
 export declare function maximum(a: SparseMatrix, b: SparseMatrix): SparseMatrix;
-/**
- * Scalar multiplication of two matrices
- */
 export declare function multiplyScalar(a: SparseMatrix, scalar: number): SparseMatrix;
-/**
- * Returns a new matrix with zero entries removed.
- */
 export declare function eliminateZeros(m: SparseMatrix): SparseMatrix;
-/**
- * Normalization of a sparse matrix.
- */
 export declare function normalize(m: SparseMatrix, normType?: NormType): SparseMatrix;
 export declare const enum NormType {
     max = "max",
     l1 = "l1",
     l2 = "l2"
 }
-/**
- * Helper function for getting data, indices, and inptr arrays from a sparse
- * matrix to follow csr matrix conventions. Super inefficient (and kind of
- * defeats the purpose of this convention) but a lot of the ported python tree
- * search logic depends on this data format.
- */
 export declare function getCSR(x: SparseMatrix): {
     indices: number[];
     values: number[];

package/dist/nn_descent.d.ts

@@ -1,71 +1,7 @@
-/**
- * @license
- *
- * Copyright 2019 Google LLC. All Rights Reserved.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * ==============================================================================
- */
-/**
- * This is a JavaScript reimplementation of UMAP (original license below), from
- * the python implementation found at https://github.com/lmcinnes/umap.
- *
- * @author andycoenen@google.com (Andy Coenen)
- */
-/**
- * @license
- * BSD 3-Clause License
- *
- * Copyright (c) 2017, Leland McInnes
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * * Redistributions of source code must retain the above copyright notice, this
- *   list of conditions and the following disclaimer.
- *
- * * Redistributions in binary form must reproduce the above copyright notice,
- *   this list of conditions and the following disclaimer in the documentation
- *   and/or other materials provided with the distribution.
- *
- * * Neither the name of the copyright holder nor the names of its
- *   contributors may be used to endorse or promote products derived from
- *   this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
 import * as heap from './heap.js';
 import * as matrix from './matrix.js';
 import * as tree from './tree.js';
 import { RandomFn, Vectors, DistanceFn } from './umap.js';
-/**
- * Create a version of nearest neighbor descent with optional WASM acceleration.
- *
- * @param distanceFn - Distance function for comparing vectors
- * @param random - Random number generator
- * @param useWasm - Whether to use WASM implementation when available
- * @returns The NN-Descent function
- */
 export declare function makeNNDescent(distanceFn: DistanceFn, random: RandomFn, useWasm?: boolean): (data: Vectors, leafArray: Vectors, nNeighbors: number, nIters?: number, maxCandidates?: number, delta?: number, rho?: number, rpTreeInit?: boolean) => {
     indices: number[][];
     weights: number[][];

package/dist/tree.d.ts

@@ -1,21 +1,3 @@
-/**
- * @license
- *
- * Copyright 2019 Google LLC. All Rights Reserved.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * ==============================================================================
- */
 import { RandomFn, Vector, Vectors } from './umap.js';
 import { WasmFlatTree } from './wasmBridge.js';
 export declare class FlatTree {
@@ -25,34 +7,10 @@ export declare class FlatTree {
     indices: number[][];
     private wasmTree?;
     constructor(hyperplanes: number[][], offsets: number[], children: number[][], indices: number[][]);
-    /**
-     * Create a FlatTree from a WASM tree object
-     */
     static fromWasm(wasmTree: WasmFlatTree): FlatTree;
-    /**
-     * Get the underlying WASM tree if available
-     */
     getWasmTree(): WasmFlatTree | undefined;
-    /**
-     * Clean up WASM resources
-     */
     dispose(): void;
 }
-/**
- * Build a random projection forest with ``nTrees``.
- */
 export declare function makeForest(data: Vectors, nNeighbors: number, nTrees: number, random: RandomFn, useWasm?: boolean): FlatTree[];
-/**
- * Generate an array of sets of candidate nearest neighbors by
- * constructing a random projection forest and taking the leaves of all the
- * trees. Any given tree has leaves that are a set of potential nearest
- * neighbors. Given enough trees the set of all such leaves gives a good
- * likelihood of getting a good set of nearest neighbors in composite. Since
- * such a random projection forest is inexpensive to compute, this can be a
- * useful means of seeding other nearest neighbor algorithms.
- */
 export declare function makeLeafArray(rpForest: FlatTree[]): number[][];
-/**
- * Searches a flattened rp-tree for a point.
- */
 export declare function searchFlatTree(point: Vector, tree: FlatTree, random: RandomFn): number[];