Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/47ng/tapers

Transform [0;1] <=> [X,Y] values with custom curves
https://github.com/47ng/tapers

curve denormalize maths normalize transforms

Last synced: about 2 months ago
JSON representation

Transform [0;1] <=> [X,Y] values with custom curves

Host: GitHub
URL: https://github.com/47ng/tapers
Owner: 47ng
License: mit
Created: 2020-02-07T06:43:34.000Z (almost 5 years ago)
Default Branch: master
Last Pushed: 2023-01-05T16:24:18.000Z (almost 2 years ago)
Last Synced: 2024-11-01T23:05:41.045Z (2 months ago)
Topics: curve, denormalize, maths, normalize, transforms
Language: TypeScript
Homepage: https://tapers.47ng.com
Size: 1.67 MB
Stars: 1
Watchers: 3
Forks: 0
Open Issues: 27
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # `tapers`

[![NPM](https://img.shields.io/npm/v/tapers?color=red)](https://www.npmjs.com/package/tapers)

[![MIT License](https://img.shields.io/github/license/47ng/tapers.svg?color=blue)](https://github.com/47ng/tapers/blob/master/LICENSE)

[![Travis CI Build](https://img.shields.io/travis/com/47ng/tapers.svg)](https://travis-ci.com/47ng/tapers)

[![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=47ng/tapers)](https://dependabot.com)

[![Average issue resolution time](https://isitmaintained.com/badge/resolution/47ng/tapers.svg)](https://isitmaintained.com/project/47ng/tapers)

[![Number of open issues](https://isitmaintained.com/badge/open/47ng/tapers.svg)](https://isitmaintained.com/project/47ng/tapers)

Map values between [0;1] to [X,Y] with various curves.

Check out the [Demo website](https://tapers.47ng.com).

## Featured Tapers

- [Linear](#linear-taper)

- [Piecewise Linear](#piecewise-linear-taper)

- [S-Curve](#s-curve-taper)

## Installation

```shell

$ yarn add tapers

# or

$ npm i tapers

```

## Documentation

### Linear Taper

Implements an affine function `a * x + b`.

```ts

import { LinearTaper } from 'tapers'

const taper = new LinearTaper(3, 5)

taper.map(0) // => 3

taper.map(0.5) // => 4

taper.map(1) // => 5

```

### Piecewise Linear Taper

Given an array of Y values, interpolate linearily between those points.

```ts

import { PiecewiseLinearTaper } from 'tapers'

const taper = new PiecewiseLinearTaper([3, 5, 2, 12])

taper.map(0) // => 3

taper.map(0.5) // => 3.5

taper.map(1) // => 12

```

### S-Curve Taper

A [0;1] to [0;1] mapping curve with 3 inflexion points (y === x): 0, 1

and 0.5, with a configurable S-shape bend.

```ts

import { SCurveTaper } from 'tapers'

const taper = new SCurveTaper(0.75)

taper.map(0) // => 0

taper.map(0.25) // => 0.1

taper.map(0.5) // => 0.5

taper.map(0.75) // => 0. 9

taper.map(1) // => 1

```

See this taper in action on [Desmos](https://www.desmos.com/calculator/0jnlso1nwz) :

[![S-Curve taper](./img/s-curve.png)](https://www.desmos.com/calculator/0jnlso1nwz)

## License

[MIT](https://github.com/47ng/tapers/blob/master/LICENSE) - Made with ❤️ by [François Best](https://francoisbest.com) - [Donations welcome](https://paypal.me/francoisbest?locale.x=fr_FR) 🙏