Merge pull request #24 from vaibhavraj-exe/adding-get-rms-value-function

adding get_rms_value function

Author: Hetarth02

README.md

@@ -26,6 +26,7 @@ import {
 	object_to_array,
 	search_in_array,
 	sanitize_array,
+  get_rms_value,
 } from "@hetarth02/js-array-helpers";
 
 let arr = [1, 2];
@@ -75,6 +76,17 @@ console.log(sanitize_array(my_array, my_schema));
 //      { name: 'sam', age: 123, isEmployed: false }
 // ]
 
+// get_rms_value example
+
+// Given array of numbers
+const values = [23, 54, 19];
+
+// Run get_rms_value with array
+console.log(get_rms_value(values))
+
+// Calculated Root Mean Square value
+// 35.61834733205159
+
 // to reverse an array in parts
 let my_array = [1, 2, 3, 4, 5];
 let reverseInPart_array = array_reverse_part(my_array, 3, 4);

index.js

@@ -395,6 +395,18 @@ function array_reverse_part(arr, start, end) {
 }
 
 /**
+ * To get RMS (Root Mean Square) Value.
+ *
+ * @param array arr
+ * @returns number
+ */
+ function get_rms_value(arr) {
+    is_array(arr);
+    let sum_square = arr.reduce((ss, curr) => (isNaN(curr) ? 0 : ss + curr*curr), 0);
+    return Math.sqrt(sum_square/arr.length);
+  }
+
+ /**
  *  To rotate an array to the left counter-clockwise by x steps, where x is non-negative
  *
  * @param array arr
@@ -478,4 +490,5 @@ export {
 	array_reverse_part,
 	array_rotate,
     equilibrium_Point,
+    get_rms_value,
 };