This project is part of the @thi.ng/umbrella monorepo.
Closed/open/semi-open interval data type, queries & operations.
Supports point & range queries and set operations with other intervals (union, intersection, difference).
Furthermore, a parser for ISO 80000-2 / ISO 31-11 interval
notation is provided. See
parse()
for details.
STABLE - used in production
Search or submit any issues for this package
With version 3.0.0 the API has been updated to be largely functional rather than
OOP, with all static (and most instance) Interval methods converted into
standalone functions. The only class methods remaining are to implement these
standard interfaces: ICompare, IContains, ICopy, IEquiv.
yarn add @thi.ng/intervals// ES module
<script type="module" src="https://unpkg.com/@thi.ng/intervals?module" crossorigin></script>
// UMD
<script src="https://unpkg.com/@thi.ng/intervals/lib/index.umd.js" crossorigin></script>Package sizes (gzipped, pre-treeshake): ESM: 1.63 KB / CJS: 1.78 KB / UMD: 1.73 KB
Several demos in this repo's /examples directory are using this package.
A selection:
| Screenshot | Description | Live demo | Source |
|---|---|---|---|
 |
Interactive pixel sorting tool using thi.ng/color & thi.ng/pixel | Demo | Source |
// [0 .. +∞] (fully closed)
a = withMin(0);
// [-∞ .. 1) (open on RHS)
b = withMax(1, true);
i = intersection(a, b);
i.toString();
// [0 .. 1)
// parse from string
interval("[0 .. 1)")
// Interval { l: 0, r: 1, lopen: false, ropen: true }
contains(i, 1);
// or
i.contains(1);
// false (because interval is open on RHS)
contains(i, 0.999999);
// true
// classify interval relative to point (true if RHS < x)
isBefore(i, -1)
// false
isBefore(i, 1)
// true
// classify interval relative to point (true if LHS > x)
isAfter(i, -1);
// true
isAfter(i, 1);
// false
// grow interval to include 2 => [0 ... 2]
i2 = include(i, 2);
// sort order: LHS -> RHS
compare(i, i2);
// -1
// classify WRT given interval arg
// returns Classifier enum
classify(i, infinity());
// 3 (aka Classifier.SUBSET)
// create transformed interval
// (here scaled around centroid)
transform(i, (x) => x + (x - centroid(i)) * 2).toString();
// [-1 .. 2)
// iterator of decimated interval values
[...values(i, 0.25)];
// [ 0, 0.25, 0.5, 0.75 ]
// close RHS
i.ropen = false;
// iterator of 0.25-spaced values in interval
[...values(i, 0.25)];
// [ 0, 0.25, 0.5, 0.75, 1 ] => now includes 1
// iterator of n equidistant samples
[...samples(i, 4)]
// [ 0, 0.3333333333333333, 0.6666666666666666, 1 ]
// constrain values to interval (taking openness into account)
max(interval("(0..1)"), -2)
// 0.000001
// if given value is outside interval, uses opt epsilon value
// to return closest inside value (default: 1e-6)...
max(interval("(0..1)"), -2, 1e-3)
// 0.001
min(interval("(0..1)"), 2, 1e-3)
// 0.999
// clamp on both sides
clamp(interval("[0..1)"), -2, 1e-3)
// 0
clamp(interval("[0..1)"), 2, 1e-3)
// 0.999- Karsten Schmidt (@postspectacular)
If this project contributes to an academic publication, please cite it as:
@misc{thing-intervals,
title = "@thi.ng/intervals",
author = "Karsten Schmidt and others",
note = "https://thi.ng/intervals",
year = 2018
}© 2018 - 2021 Karsten Schmidt // Apache Software License 2.0