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

1.0.0 • Public • Published

contained-periodic-values.js

Travis build status Code Climate Test Coverage Dependency Status devDependency Status

Find how many values of a discrete periodic function contained in an interval.

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.

What might I use this library for?

Continuing the example from above, this library could be used to determine the number of Wednesdays between two days. You could extend this to find the number of work days or week days between two days.

Terminology

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

The distance that the function repeats itself along is the "period."

An interval is defined by a "start" and "end".

API

containedPeriodicValues(start, end, value, period)

Find the number of values contained with the "start" and "end." This method works with intervals with inclusive starts and exclusive ends. In math syntax, this would be written as [start, end).

The order that you specify the start and end does not matter.

Package Sidebar

Install

npm i contained-periodic-values

Weekly Downloads

35,173

Version

1.0.0

License

MIT

Last publish

Collaborators

  • jmeas