Skip to main content

Math methods

Explore the list of utility methods for performing mathematical operations.

The mathUtils module provides various utility functions for performing mathematical operations.

Info

mathUtils library uses Lodash's Math methods. For full details of how to use these methods, refer to Lodash documentation.

Methods reference in mathUtils library​

mathUtils.add(a, b)​

Adds two numbers.

Parameters​

  • a (number): The first number.
  • b (number): The second number.

Returns​

  • (number): The result of the addition.

Example​

const result = mathUtils.add(5, 3);
// Result: 8

mathUtils.ceil(source)​

Rounds a number upward to the nearest integer.

Parameters​

  • source (number): The number to round.

Returns​

  • (number): The rounded number.

Example​

const roundedNumber = mathUtils.ceil(5.3);
// Result: 6

mathUtils.divide(dividend, divisor)​

Divides two numbers.

Parameters​

  • dividend (number): The number to be divided.
  • divisor (number): The divisor.

Returns​

  • (number): The result of the division.

Example​

const result = mathUtils.divide(10, 2);
// Result: 5

mathUtils.floor(source)​

Rounds a number downward to the nearest integer.

Parameters​

  • source (number): The number to round.

Returns​

  • (number): The rounded number.

Example​

const roundedNumber = mathUtils.floor(5.7);
// Result: 5

mathUtils.max(...numbers)​

Finds the maximum value among a list of numbers.

Parameters​

  • numbers (...number): The numbers to compare.

Returns​

  • (number): The maximum value.

Example​

const maxValue = mathUtils.max(3, 7, 2, 9);
// Result: 9

mathUtils.maxBy(numbers, iteratee)​

Finds the maximum value from an array of numbers, determined by an iteratee.

Parameters​

  • numbers (Array): The array of numbers to compare.
  • iteratee (Function): The iteratee to determine values.

Returns​

  • (number): The maximum value.

Example​

const numbers = [{ 'n': 1 }, { 'n': 5 }, { 'n': 3 }];
const maxValue = mathUtils.maxBy(numbers, obj => obj.n);
// Result: 5

mathUtils.mean(numbers)​

Calculates the mean value of an array of numbers.

Parameters​

  • numbers (Array): The array of numbers.

Returns​

  • (number): The mean value.

Example​

const meanValue = mathUtils.mean([1, 2, 3, 4, 5]);
// Result: 3

mathUtils.meanBy(numbers, iteratee)​

Calculates the mean value of an array of numbers, determined by an iteratee.

Parameters​

  • numbers (Array): The array of numbers.
  • iteratee (Function): The iteratee to determine values.

Returns​

  • (number): The mean value.

Example​

const numbers = [{ 'n': 1 }, { 'n': 5 }, { 'n': 3 }];
const meanValue = mathUtils.meanBy(numbers, obj => obj.n);
// Result: 3

mathUtils.min(...numbers)​

Finds the minimum value among a list of numbers.

Parameters​

  • numbers (...number): The numbers to compare.

Returns​

  • (number): The minimum value.

Example​

const minValue = mathUtils.min(3, 7, 2, 9);
// Result: 2

mathUtils.minBy(numbers, iteratee)​

Finds the minimum value from an array of numbers, determined by an iteratee.

Parameters​

  • numbers (Array): The array of numbers to compare.
  • iteratee (Function): The iteratee to determine values.

Returns​

  • (number): The minimum value.

Example​

const numbers = [{ 'n': 1 }, { 'n': 5 }, { 'n': 3 }];
const minValue = mathUtils.minBy(numbers, obj => obj.n);
// Result: 1

mathUtils.multiply(a, b)​

Multiplies two numbers.

Parameters​

  • a (number): The first number.
  • b (number): The second number.

Returns​

  • (number): The result of the multiplication.

Example​

const result = mathUtils.multiply(5, 3);
// Result: 15

mathUtils.round(source, [precision=0])​

Rounds a number to the nearest integer or to a specified number of decimal places.

Parameters​

  • source (number): The number to round.
  • precision (number): Optional. The number of decimal places to round to.

Returns​

  • (number): The rounded number.

Example​

const roundedInteger = mathUtils.round(5.7);
// Result: 6

const roundedDecimal = mathUtils.round(3.14159, 2);
// Result: 3.14

mathUtils.subtract(minuend, subtrahend)​

Subtracts two numbers.

Parameters​

  • minuend (number): The number from which to subtract.
  • subtrahend (number): The number to subtract.

Returns​

  • (number): The result of the subtraction.

Example​

const result = mathUtils.subtract(10, 5);
// Result: 5

mathUtils.sum(numbers)​

Calculates the sum of an array of numbers.

Parameters​

  • numbers (Array): The array of numbers.

Returns​

  • (number): The sum.

Example​

const sumValue = mathUtils.sum([1, 2, 3, 4, 5]);
// Result: 15

mathUtils.sumBy(numbers, iteratee)​

Calculates the sum of an array of numbers, determined by an iteratee.

Parameters​

  • numbers (Array): The array of numbers.
  • iteratee (Function): The iteratee to determine values.

Returns​

  • (number): The sum.

Example​

const numbers = [{ 'n': 1 }, { 'n': 2 }, { 'n': 3 }];
const sumValue = mathUtils.sumBy(numbers, obj => obj.n);
// Result: 6