JSPM

fast_array_intersect

1.0.1
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 123437
  • Score
    100M100P100Q152956F
  • License MIT

Fast intersection of multiple arrays

Package Exports

  • fast_array_intersect

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (fast_array_intersect) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

fast_array_intersect

The fastest javascript array intersection function. It takes arrays, and returns the elements that are common to all the arrays. And it does that faster than any other published alternative I am aware of.

npm version size CI status

How to use

This module exports a single default function, with the following signature:

intersect(arrays [, hash])

The arguments are :

# name optional? type description
1 arrays required array of arrays The arrays to intersect
2 hash optional function A function that takes an element of one of the arrays and returns a value. The value should be the same for semantically identical values.

By default, the intersection is computed for values that are equal under SameValueZero. You can use the optional hash function argument when you are intersecting arrays of javascript objects. You should then implement a function that returns the same primitive value when called with identical objects.

The order and references of result values are determined by the shortest of the input arrays.

Examples

import intersect from 'fast_array_intersection'

intersect([
  [1,2,3],
  [1,2,6]
]) // --> [1,2]

intersect([
  [{x:2}, {y:2}],
  [{x:1}, {x:2}]
], JSON.stringify) // --> [{x:2}]

intersect([
  [{id:0, excluded:"A"}, {id:1, excluded:"B"}],
  [{id:0, excluded:"C"}, {id:2, excluded:"C"}]
], x => x.id) // --> [{id:0, excluded:"A"}]

Without the ES6 import syntax, the function can be imported using :

var intersect = require("fast_array_intersect").default;

Performance

fast_array_intersect is designed to be fast, and beats all other array intersection function I tested.

Benchmark

Here is a comparison of fast_array_intersect with intersect, intersection-of and array-intersection-x:

2 arrays of 10 elements, with an intersection of size 5...
+ fast_array_intersect x 1,184,797 ops/sec ±0.37% (95 runs sampled)
intersect x 366,556 ops/sec ±0.42% (96 runs sampled)
intersection-of x 301,857 ops/sec ±0.32% (92 runs sampled)
array-intersection-x x 28,634 ops/sec ±0.37% (92 runs sampled)
+ Fastest is fast_array_intersect

2 arrays of 100 elements, with an intersection of size 10...
+ fast_array_intersect x 129,016 ops/sec ±0.34% (96 runs sampled)
intersect x 27,995 ops/sec ±0.29% (97 runs sampled)
intersection-of x 29,102 ops/sec ±0.33% (92 runs sampled)
array-intersection-x x 3,582 ops/sec ±0.19% (96 runs sampled)
+ Fastest is fast_array_intersect

10 arrays of 100 elements, with an intersection of size 99...
+ fast_array_intersect x 42,378 ops/sec ±0.26% (96 runs sampled)
intersect x 24,630 ops/sec ±0.32% (96 runs sampled)
intersection-of x 39,934 ops/sec ±0.28% (95 runs sampled)
array-intersection-x x 2,525 ops/sec ±0.22% (96 runs sampled)
+ Fastest is fast_array_intersect

10 arrays of 100 elements, with an intersection of size 0...
+ fast_array_intersect x 152,349 ops/sec ±0.41% (97 runs sampled)
intersect x 8,502 ops/sec ±0.40% (98 runs sampled)
intersection-of x 6,429 ops/sec ±0.15% (97 runs sampled)
array-intersection-x x 3,614 ops/sec ±0.35% (96 runs sampled)
+ Fastest is fast_array_intersect

1000 arrays of 10 elements, with an intersection of size 3...
+ fast_array_intersect x 3,804 ops/sec ±0.34% (95 runs sampled)
intersect x 416 ops/sec ±0.77% (87 runs sampled)
intersection-of x 812 ops/sec ±0.23% (94 runs sampled)
array-intersection-x x 2,701 ops/sec ±0.29% (95 runs sampled)
+ Fastest is fast_array_intersect

10 arrays of 1000 elements, with an intersection of size 500...
+ fast_array_intersect x 2,787 ops/sec ±0.29% (96 runs sampled)
intersect x 826 ops/sec ±0.71% (94 runs sampled)
intersection-of x 1,164 ops/sec ±0.17% (95 runs sampled)
array-intersection-x x 232 ops/sec ±0.27% (90 runs sampled)
+ Fastest is fast_array_intersect

For more details about the benchmark, see benchmark.js.