nearest-periodic-value
DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/nearest-periodic-value package

1.2.0 • Public • Published

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.

Package Sidebar

Install

npm i nearest-periodic-value

Weekly Downloads

22,809

Version

1.2.0

License

MIT

Last publish

Collaborators

  • jmeas