Skip to content

Latest commit

 

History

History
174 lines (105 loc) · 4.93 KB

File metadata and controls

174 lines (105 loc) · 4.93 KB

@wholebuzz/cluster / Exports / hamming

Module: hamming

Table of contents

Interfaces

Variables

Functions

Variables

one

Const one: bigint

Defined in: hamming.ts:8


zero

Const zero: bigint

Defined in: hamming.ts:7

Functions

addHammingNeighbors

addHammingNeighbors<Item>(output: ItemGraph<Item>, data: FingerprintedLabeledDataset<Item>, threshhold: number, beamWidth: number, hammingDist: (x: bigint, y: bigint) => number): ItemGraph<Item>

Finds approximate nearest neighbors by Hamming distance. References: [1]

Type parameters

Name
Item

Parameters

Name Type Description
output ItemGraph<Item> -
data FingerprintedLabeledDataset<Item> -
threshhold number Maximum Hamming distance for two articles to be considered neighbors.
beamWidth number Number of sort-order adjacent points to check for nearness.
hammingDist (x: bigint, y: bigint) => number -

Returns: ItemGraph<Item>

Defined in: hamming.ts:64


clusterByHammingDistance

clusterByHammingDistance<Item>(data: FingerprintedLabeledDataset<Item>, options?: ClusterByHammingDistanceOptions<Item>): ItemClustering

Clusters [[FingerprintedLabeledDataset]] by Hamming distance. References: [1]

optional options The [[ClusterOptions]] to apply.

Type parameters

Name
Item

Parameters

Name Type
data FingerprintedLabeledDataset<Item>
options? ClusterByHammingDistanceOptions<Item>

Returns: ItemClustering

Defined in: hamming.ts:26


hammingDistance

hammingDistance(x: bigint, y: bigint): number

Returns Hamming distance between points. References: [1]

Parameters

Name Type Description
x bigint First point to compare.
y bigint Second point to compare.

Returns: number

Defined in: hamming.ts:94


hammingDistanceConstantTimeFunction

hammingDistanceConstantTimeFunction(bits: number): function

Returns function for Hamming distance using constant-time algorithm. It's just a little slower than hammingDistance for 64 bit hashes. References: [1]

Parameters

Name Type
bits number

Returns: (x: bigint, y: bigint) => number

Defined in: hamming.ts:116


hammingWeight

hammingWeight(x: bigint): number

Returns Hamming weight for point. References: [1]

Parameters

Name Type Description
x bigint The [[bigint]] to count the set bits of.

Returns: number

Defined in: hamming.ts:103


permuteBits

permuteBits(x: bigint, permutation: bigint[]): bigint

Reorders the bits in the input according to the supplied permutation.

Parameters

Name Type Description
x bigint The input bits to permute.
permutation bigint[] Order created by newPermutation.

Returns: bigint

Defined in: hamming.ts:128