f-utility/lib/math.js

functional utilities

"use strict";

Object.defineProperty(exports, "__esModule", {
  value: true
});
exports.pow = exports.__pow = exports.divide = exports.__divide = exports.multiply = exports.__multiply = exports.subtract = exports.__subtract = exports.add = exports.__add = exports.round = exports.lte = exports.lessThanOrEqualTo = exports.__lessThanOrEqualTo = exports.lt = exports.lessThan = exports.__lessThan = exports.gte = exports.greaterThanOrEqualTo = exports.__greaterThanOrEqualTo = exports.gt = exports.greaterThan = exports.__greaterThan = exports.equal = exports.equals = exports.__equals = undefined;

var _katsuCurry = require("katsu-curry");

/**
 * === comparison
 * @method equals
 * @param {*} a - anything
 * @param {*} b - anything
 * @returns {boolean} whether a triple-equals b
 * @public
 * @alias equal
 * @example
 * import {equals} from 'f-utility'
 * const SAFE_ID = 123456
 * const equalsID = equals(SAFE_ID)
 * equalsID(200) // false
 * equalsID(SAFE_ID) // true
 */
var __equals = exports.__equals = function __equals(a, b) {
  return a === b;
};
var equals = exports.equals = (0, _katsuCurry.curry)(__equals);
var equal = exports.equal = equals;

/**
 * > comparison but inverted
 * @method greaterThan
 * @alias gt
 * @param {*} b - anything
 * @param {*} a - anything
 * @returns {boolean} whether a > b
 * @public
 * @alias equal
 * @example
 * import {greaterThan, gt} from 'f-utility'
 * gt(100, 99) // false
 * gt(100, 100) // false
 * gt(100, 101) // true
 */
var __greaterThan = exports.__greaterThan = function __greaterThan(b, a) {
  return a > b;
};
var greaterThan = exports.greaterThan = (0, _katsuCurry.curry)(__greaterThan);
var gt = exports.gt = greaterThan;

/**
 * >= comparison but inverted
 * @method greaterThanOrEqualTo
 * @alias gte
 * @param {*} b - anything
 * @param {*} a - anything
 * @returns {boolean} whether a > b
 * @public
 * @alias equal
 * @example
 * import {greaterThanOrEqualTo, gte} from 'f-utility'
 * gte(100, 99) // false
 * gte(100, 100) // true
 * gte(100, 101) // true
 */
var __greaterThanOrEqualTo = exports.__greaterThanOrEqualTo = function __greaterThanOrEqualTo(b, a) {
  return a >= b;
};
var greaterThanOrEqualTo = exports.greaterThanOrEqualTo = (0, _katsuCurry.curry)(__greaterThanOrEqualTo);
var gte = exports.gte = greaterThanOrEqualTo;

/**
 * < comparison but inverted
 * @method lessThan
 * @alias lt
 * @param {*} b - anything
 * @param {*} a - anything
 * @returns {boolean} whether a > b
 * @public
 * @alias equal
 * @example
 * import {lessThan, lt} from 'f-utility'
 * lt(100, 99) // true
 * lt(100, 100) // false
 * lt(100, 101) // false
 */
var __lessThan = exports.__lessThan = function __lessThan(b, a) {
  return a < b;
};
var lessThan = exports.lessThan = (0, _katsuCurry.curry)(__lessThan);
var lt = exports.lt = lessThan;

/**
 * < comparison but inverted
 * @method lessThanOrEqualTo
 * @alias lte
 * @param {*} b - anything
 * @param {*} a - anything
 * @returns {boolean} whether a > b
 * @public
 * @alias equal
 * @example
 * import {lessThanOrEqualTo, lte} from 'f-utility'
 * lte(100, 99) // true
 * lte(100, 100) // true
 * lte(100, 101) // false
 */
var __lessThanOrEqualTo = exports.__lessThanOrEqualTo = function __lessThanOrEqualTo(b, a) {
  return a <= b;
};
var lessThanOrEqualTo = exports.lessThanOrEqualTo = (0, _katsuCurry.curry)(__lessThanOrEqualTo); // reverse arrow!
var lte = exports.lte = lessThanOrEqualTo;

/**
 * convenience method for Math.round
 * @method round
 * @param {number} x - a number
 * @returns {number} rounded number
 * @public
 * @example
 * import {round} from 'f-utility'
 * round(10.3) // 10
 * round(10.9) // 11
 */
var round = Math.round;

/**
 * add things
 * @method add
 * @param {number} a - a number
 * @param {number} b - b number
 * @returns {number} sum
 * @public
 * @example
 * import {add} from 'f-utility'
 * add(4, 2) // 6
 */

exports.round = round;
var __add = exports.__add = function __add(a, b) {
  return b + a;
};
var add = exports.add = (0, _katsuCurry.curry)(__add);

/**
 * subtract things
 * @method subtract
 * @param {number} a - a number
 * @param {number} b - b number
 * @returns {number} subtracted
 * @public
 * @example
 * import {subtract} from 'f-utility'
 * subtract(4, 2) // -2
 */
var __subtract = exports.__subtract = function __subtract(a, b) {
  return a - b;
};
var subtract = exports.subtract = (0, _katsuCurry.curry)(__subtract);

/**
 * multiply things
 * @method multiply
 * @param {number} a - a number
 * @param {number} b - b number
 * @returns {number} multiplied
 * @public
 * @example
 * import {multiply} from 'f-utility'
 * multiply(4, 2) // 8
 */
var __multiply = exports.__multiply = function __multiply(a, b) {
  return b * a;
};
var multiply = exports.multiply = (0, _katsuCurry.curry)(__multiply);

/**
 * divide things
 * @method divide
 * @param {number} a - a number
 * @param {number} b - b number
 * @returns {number} divided
 * @public
 * @example
 * import {divide} from 'f-utility'
 * divide(4, 2) // 0.5
 */
var __divide = exports.__divide = function __divide(a, b) {
  return a / b;
};
var divide = exports.divide = (0, _katsuCurry.curry)(__divide);

/**
 * exponentiate things
 * @method pow
 * @param {number} a - a number
 * @param {number} b - b number
 * @returns {number} b to the power of a
 * @public
 * @example
 * import {pow} from 'f-utility'
 * pow(4, 2) // 16
 */
var __pow = exports.__pow = function __pow(a, b) {
  return Math.pow(b, a);
};
var pow = exports.pow = (0, _katsuCurry.curry)(__pow);