Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aanckar/interval-operations
Utility functions for performing mathematical set operations on intervals and arrays of intervals
https://github.com/aanckar/interval-operations
Last synced: 3 months ago
JSON representation
Utility functions for performing mathematical set operations on intervals and arrays of intervals
- Host: GitHub
- URL: https://github.com/aanckar/interval-operations
- Owner: aanckar
- Created: 2019-07-29T16:17:33.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-06-26T05:16:27.000Z (over 1 year ago)
- Last Synced: 2024-10-09T16:43:42.371Z (3 months ago)
- Language: TypeScript
- Size: 327 KB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Interval operations
A collection of dependency-free utility functions for performing mathematical set operations on intervals and arrays of intervals.
## Installation
```
npm install interval-operations
// or, with yarn
yarn add interval-operations
```
## Usage
### Union
```
import { union, arrayUnion } from 'interval-operations';
union([1,3], [2,4], [5,7]); // [[1,4], [5,7]]
arrayUnion([[1,3], [5,7]], [[2,4], [6,8]]); // [[1,4], [5,8]]
```
### Intersection
```
import { intersection, arrayIntersection } from 'interval-operations';
intersection([1,3], [2,4]); // [2,3]
intersection([1,2], [3,4]); // null
arrayIntersection([[1,3], [5,7]], [[2,4], [6,8]]); // [[2,3], [5,6]]
```
### Difference
```
import { difference, arrayDifference } from 'interval-operations';
difference([1,3], [2,3]); // [1,2]
arrayDifference([[1,3], [4,6]], [[2,5]]); // [[1,2], [5,6]]
```
### Contains
```
import { contains, arrayContains } from 'interval-operations';
contains([1,3], [2,3]); // true
contains([1,3], [3,4]); // false
arrayContains([[1,3], [2,5]], [[1,5]]); // true
```
### Example with dates
```
const store1Hours = [
[new Date('2019-03-14 08:00'), new Date('2019-03-14 16:00')],
[new Date('2019-03-16 10:00'), new Date('2019-03-16 14:00')]
];
const store2Hours = [
[new Date('2019-03-14 10:00'), new Date('2019-03-14 14:00')],
[new Date('2019-03-15 08:00'), new Date('2019-03-15 16:00')],
];
// When is at least one store open?
arrayUnion(store1Hours, store2Hours);
/* [
[new Date('2019-03-14 08:00'), new Date('2019-03-14 16:00')],
[new Date('2019-03-15 08:00'), new Date('2019-03-15 16:00')],
[new Date('2019-03-16 10:00'), new Date('2019-03-16 14:00')]
] */
// When are both stores open?
arrayIntersection(store1Hours, store2Hours);
// [[new Date('2019-03-14 10:00'), new Date('2019-03-14 14:00')]]
// When is only store 1 open?
arrayDifference(store1Hours, store2Hours);
/* [
[new Date('2019-03-14 08:00'), new Date('2019-03-14 10:00')],
[new Date('2019-03-14 14:00'), new Date('2019-03-14 16:00')],
[new Date('2019-03-16 10:00'), new Date('2019-03-16 14:00')]
] */
```