项目作者: jedwards1211

项目描述 :
computes floor and ceiling for any modulus, not just 1
高级语言: JavaScript
项目地址: git://github.com/jedwards1211/mod-floor-ceiling.git
创建时间: 2017-04-27T19:26:45Z
项目社区:https://github.com/jedwards1211/mod-floor-ceiling

开源协议:MIT License

下载


mod-floor-ceiling

Build Status
Coverage Status
semantic-release
Commitizen friendly

computes floor and ceiling for any modulus, not just 1

  1. node
  2. > require('mod-floor-ceiling').modFloor(3.8, 1.7)
  3. 3.4
  4. > require('mod-floor-ceiling').modFloor(3.4, 1.7)
  5. 3.4
  6. > require('mod-floor-ceiling').modCeiling(-17.8, 2.5)
  7. -17.5
  8. > require('mod-floor-ceiling').modLower(15, 5)
  9. 10
  10. > require('mod-floor-ceiling').modLower(16, 5)
  11. 15
  12. > require('mod-floor-ceiling').modHigher(15, 5)
  13. 20
  14. > require('mod-floor-ceiling').modHigher(14, 5)
  15. 15

Usage

  1. npm install mod-floor-ceiling

modFloor(value: number, modulus: number, anchor?: number = 0): number

Returns the greatest (closest to positive infinity) multiple of modulus, plus anchor, that is <= value.

modCeiling(value: number, modulus: number, anchor?: number = 0): number

Returns the least (closest to negative infinity) multiple of modulus, plus anchor, that is >= value.

modLower(value: number, modulus: number, anchor?: number = 0): number

Returns the greatest (closest to positive infinity) multiple of modulus, plus anchor, that is < value.

modHigher(value: number, modulus: number, anchor?: number = 0): number

Returns the greatest (closest to positive infinity) multiple of modulus, plus anchor, that is > value.

What is anchor?

Anchor controls the offset of multiples of modulus.

For example, with a modulus of 3 and the default anchor of 0, possible return values include -6, -3, 0, 3, 6, etc.

But with anchor of 1, possible return values include -5, -2, 1, 4, 7, etc.

It’s simple; modFloor(value, modulus, anchor) just computes anchor + modFloor(value - anchor, modulus).