Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

nearest-periodic-value

jmeas176.7kMIT1.2.0TypeScript support: definitely-typed

Find the nearest value of a discrete periodic function, given a point.

mathematics, math, period, periodic, nearest, solution, function

readme

nearest-periodic-value.js

Travis build status Code Climate Test Coverage Dependency Status devDependency Status

Find the nearest value of a discrete periodic function, given a point.

What are discrete periodic functions?

Periodic functions are functions that repeat. Discrete functions are functions whose values do not connect. An example of a discrete periodic function is the function of "Wednesdays" on a calendar. Wednesdays are discrete values along a timeline, and they repeat every 7 days.

Terminology

The members of a periodic function's output are the "values." A single member is a "value."

The interval that the function repeats along is the "period."

A "point" is any value in the domain of the function.

API

nearestPeriodicValue(point, value, period)

Find the nearest value to point. Supply a value from the codomain of the function, and its period.

FAQ

What if my point is equidistant between two values?

The value in front of your point will be chosen.