chore: fix naming convention for maths functions (#209)

* chore: added function return type

* chore: fix naming conventions for maths functions

Author: britneywwc

maths/absolute_value.ts

@@ -1,15 +1,15 @@
 /**
- * @function AbsoluteValue
+ * @function absoluteValue
  * @description Calculate the absolute value of an input number.
  * @param {number} number - a numeric input value
  * @return {number} - Absolute number of input number
  * @see https://en.wikipedia.org/wiki/Absolute_value
- * @example AbsoluteValue(-10) = 10
- * @example AbsoluteValue(50) = 50
- * @example AbsoluteValue(0) = 0
+ * @example absoluteValue(-10) = 10
+ * @example absoluteValue(50) = 50
+ * @example absoluteValue(0) = 0
  */
 
-export const AbsoluteValue = (number: number): number => {
+export const absoluteValue = (number: number): number => {
   // if input number is less than 0, convert it to positive via double negation
   // e.g. if n = -2, then return -(-2) = 2
   return number < 0 ? -number : number;

maths/aliquot_sum.ts

@@ -1,5 +1,5 @@
 /**
- * @function AliquotSum
+ * @function aliquotSum
  * @description Returns the aliquot sum of the provided number
  * @summary The aliquot sum of a number n is the sum of all the proper divisors
  * of n apart from n itself.
@@ -9,10 +9,10 @@
  * @param {number} num The input number
  * @return {number} The aliquot sum of the number
  * @see [Wikipedia](https://en.wikipedia.org/wiki/Aliquot_sum)
- * @example AliquotSum(18) = 21
- * @example AliquotSum(15) = 9
+ * @example aliquotSum(18) = 21
+ * @example aliquotSum(15) = 9
  */
-export const AliquotSum = (num: number): number => {
+export const aliquotSum = (num: number): number => {
   if (typeof num !== 'number') throw new TypeError('Input needs to be a number')
   if (num < 0) throw new TypeError('Input cannot be negative')
   if (!Number.isInteger(num)) throw new TypeError('Input cannot be a decimal')

maths/armstrong_number.ts

@@ -1,5 +1,5 @@
 /** 
- * @function ArmstrongNumber
+ * @function armstrongNumber
  * @description Check if the provided number is an Armstrong number or not.
  * @summary Armstrong numbers are numbers, the sum of whose digits each raised
  * to the power of the number of digits is equal to the number itself.
@@ -10,10 +10,10 @@
  * @return {boolean} Whether the input number is an Armstrong number
  * @see [Wikipedia](https://en.wikipedia.org/wiki/Armstrong_number)
  * @see [OEIS](https://oeis.org/A005188)
- * @example ArmstrongNumber(370) = true
- * @example ArmstrongNumber(10) = false
+ * @example armstrongNumber(370) = true
+ * @example armstrongNumber(10) = false
  */
-export const ArmstrongNumber = (num: number): boolean => {
+export const armstrongNumber = (num: number): boolean => {
   if (typeof num !== 'number' || num <= 0) return false;
 
   let compNum = 0

maths/binary_convert.ts

@@ -1,14 +1,14 @@
 /**
- * @function BinaryConvert
+ * @function binaryConvert
  * @description Convert the decimal to binary.
  * @param {number} num - The input integer
  * @return {string} - Binary of num.
  * @see [BinaryConvert](https://www.programiz.com/javascript/examples/decimal-binary)
- * @example BinaryConvert(12) = 1100
- * @example BinaryConvert(12 + 2) = 1110
+ * @example binaryConvert(12) = 1100
+ * @example binaryConvert(12 + 2) = 1110
  */
 
-export const BinaryConvert = (num: number): string => {
+export const binaryConvert = (num: number): string => {
   let binary = ''
 
   while (num !== 0) {

maths/binomial_coefficient.ts

@@ -1,24 +1,24 @@
-import { Factorial } from "./factorial";
+import { factorial } from "./factorial";
 /**
- * @function BinomialCoefficient
+ * @function binomialCoefficient
  * @description Calculate the binomial coefficient (n choose k) of two input numbers.
  * @param {number} n - the total number of items
  * @param {number} k - the number of items to be chosen
  * @return {number} - Binomial coefficient (n choose k)
  * @see https://en.wikipedia.org/wiki/Binomial_coefficient
- * @example BinomialCoefficient(5, 2) = 10
- * @example BinomialCoefficient(10, 3) = 120
- * @example BinomialCoefficient(6, 0) = 1
+ * @example binomialCoefficient(5, 2) = 10
+ * @example binomialCoefficient(10, 3) = 120
+ * @example binomialCoefficient(6, 0) = 1
  */
 
-export const BinomialCoefficient = (n: number, k: number): number => {
+export const binomialCoefficient = (n: number, k: number): number => {
     // Check if k is larger than n or negative
     if (k > n || k < 0) {
         return 0;
     }
 
     // Calculate the binomial coefficient using the implemented factorial
-    const numerator = Factorial(n);
-    const denominator = Factorial(k) * Factorial(n - k);
+    const numerator = factorial(n);
+    const denominator = factorial(k) * factorial(n - k);
     return numerator / denominator;
 };

maths/digit_sum.ts

@@ -1,14 +1,14 @@
 /**
- * @function DigitSum
+ * @function digitSum
  * @description Calculate the sum of all digits of a natural number (number base 10).
  * @param {number} num - A natural number.
  * @return {number} - Sum of all digits of given natural number.
  * @see https://en.wikipedia.org/wiki/Digit_sum
- * @example DigitSum(12) = 3
- * @example DigitSum(9045) = 18
+ * @example digitSum(12) = 3
+ * @example digitSum(9045) = 18
  */
 
-export const DigitSum = (num: number): number => {
+export const digitSum = (num: number): number => {
   if (num < 0 || !Number.isInteger(num)) {
     throw new Error("only natural numbers are supported");
   }

maths/factorial.ts

@@ -1,16 +1,16 @@
 /**
- * @function Factorial
+ * @function factorial
  * @description Calculate the factorial of a natural number.
  * @param {number} num - A natural number.
  * @return {number} - The factorial.
- * @see https://en.wikipedia.org/wiki/Factorial
- * @example Factorial(0) = 1
- * @example Factorial(3) = 6
+ * @see https://en.wikipedia.org/wiki/factorial
+ * @example factorial(0) = 1
+ * @example factorial(3) = 6
  */
-export const Factorial = (num: number): number => {
+export const factorial = (num: number): number => {
   if (num < 0 || !Number.isInteger(num)) {
     throw new Error("only natural numbers are supported");
   }
 
-  return num === 0 ? 1 : num * Factorial(num - 1);
+  return num === 0 ? 1 : num * factorial(num - 1);
 };

maths/factors.ts

@@ -1,14 +1,14 @@
 /**
- * @function FindFactors
+ * @function findFactors
  * @description Find all the factors of a natural number.
  * @param {number} num - A natural number.
  * @return {Set<number>} - A set of all the factors of given natural number.
  * @see https://en.wikipedia.org/wiki/Divisor
- * @example FindFactors(1) = [1]
- * @example FindFactors(4) = [1,2,4]
- * @example FindFactors(16) = [1,3,5,15]
+ * @example findFactors(1) = [1]
+ * @example findFactors(4) = [1,2,4]
+ * @example findFactors(16) = [1,3,5,15]
  */
-export const FindFactors = (num: number): Set<number> => {
+export const findFactors = (num: number): Set<number> => {
     if (num <= 0 || !Number.isInteger(num)) {
         throw new Error("Only natural numbers are supported.");
     }

maths/find_min.ts

@@ -1,15 +1,15 @@
 /**
- * @function FindMin
+ * @function findMin
  * @description Find the minimum in an array of numbers.
  * @param {Number[]} nums - An array of numbers.
  * @return {Number} - The minimum.
  * @see https://infinitbility.com/how-to-find-minimum-value-in-array-in-typescript/
- * @example FindMin([1,2,3,4,5]) = 1
- * @example FindMin([87,6,13,999]) = 6
- * @example FindMin([0.8,0.2,0.3,0.5]) = 0.2
- * @example FindMin([1,0.1,-1]) = -1
+ * @example findMin([1,2,3,4,5]) = 1
+ * @example findMin([87,6,13,999]) = 6
+ * @example findMin([0.8,0.2,0.3,0.5]) = 0.2
+ * @example findMin([1,0.1,-1]) = -1
  */
- export const FindMin = (nums: number[]): number => {
+ export const findMin = (nums: number[]): number => {
     if (nums.length === 0) {
       throw new Error("array must have length of 1 or greater");
     }

maths/greatest_common_factor.ts

@@ -1,5 +1,5 @@
 /**
- * @function GreatestCommonFactor
+ * @function greatestCommonFactor
  * @description Determine the greatest common factor of a group of numbers.
  * @param {Number[]} nums - An array of numbers.
  * @return {Number} - The greatest common factor.