@rysun/numeasy
TypeScript icon, indicating that this package has built-in type declarations

1.1.2 • Public • Published

@rysun/numeasy

Introduction

@rysun/numeasy is a comprehensive NPM package that helps in performing a wide range of mathematical and statistical operations using JavaScript. This document gives a complete overview of its installation, usage, core modules, etc.

Package Overview

@rysun/numeasy offers a robust set of modules, each tailored to address specific mathematical and statistical requirements. Here is an overview of the core modules:

  1. Array Creation: It comprises single and multi-dimensional arrays. A single-dimensional array stores data sequentially in a linear structure, while a multi-dimensional array arranges data in a nested structure with multiple indices.

  2. Mathematical Set Operations: This module equips users with the tools to perform essential set operations, including union, intersection, and difference, among others.

  3. Statistical Operations: Starting from calculating measures such as mean, median, and percentile, to assessing data variability through standard deviation; this module is crucial for in-depth data analysis.

  4. Interpolation: This module facilitates the interpolation of data points, enabling users to represent and analyze data, especially when dealing with irregularly spaced data sets.

  5. Array Utility Functions: This module allow users to work with arrays. Users can able to create arrays with evenly spaced elements, arrays with zeros, arrays with ones and arrays with random numbers.

  6. Matrix Library: This module allow users to perform matrix operations such as transpose, addition, multiplication, determinant etc.

Licensing

@rysun/numeasy is distributed under the MIT license. This open-source license ensures that users have the freedom to use, modify, and distribute the package in their projects, fostering a vibrant and collaborative development community.

Installation & Usage

To incorporate the @rysun/numeasy package into the project, follow the installation instructions below:

  1. By using NPM:
    npm install @rysun/numeasy
  2. By using yarn:
    yarn add @rysun/numeasy
    These commands need to be executed within your terminal. Once you have successfully installed the package, you will gain full access to @rysun/numeasy.

Core Modules

1. Array Creation:

A. Single Dimensional Array

import mu from "@rysun/numeasy"

let A = mu.array([1,2,3]);

console.log(A)

Output:

[1, 2, 3]

B. Multidimensional Array

let A = mu.array([
  [1, 2, 3],
  [4, 5, 6],
]);
console.log(A);

Output:

[[1,2,3],[4,5,6]]

2. Set Operations

Sets are collections of unique data, that ensure no elements are repeated. The @rysun/numeasy package facilitates fundamental set operations like Union, Intersection, Difference, and Symmetric Difference on arrays.

A. Union

The union of two sets A and B includes all the elements of sets A and B.

Example
import ms from "@rysun/numeasy"

let A = ms.array([1,2,3]);
let B = ms.array([7,8,3]);

let Result = ms.union(A,B)

console.log (Result)
Output
[1,2,3,7,8]

B. Intersection

The intersection of two sets A and B includes the common elements between sets A and B.

Example
import mu from "@rysun/numeasy"

const arr1 = mu.array([
  [1, 2, 3],
  [9, 7, 6],
]);
const arr2 = mu.array([
  [3, 4, 5],
  [6, 7, 8],
]);

const result = mu.intersect(arr1, arr2);

console.log("intersect of two 2D arrays:", result);
Output
[3, 7, 6]

C. Difference

The difference between two sets A and B includes elements of set A that are not present in set B.

Example
//Set Difference for 1D array
import mu from "@rysun/numeasy"

const arr1 = mu.array([1, 2, 3]);
const arr2 = mu.array([3, 4, 5]);

const result = mu.setDiff(arr1, arr2);

console.log("setDiff of two arrays:", result);
Output
[1, 2]
//Set Difference for 2D array
import mu from "@rysun/numeasy"

const arr1 = mu.array([
  [1, 2, 3],
  [9, 7, 6],
]);
const arr2 = mu.array([
  [3, 4, 5],
  [6, 7, 8],
]);

const result = mu.setDiff(arr1, arr2);

console.log("setDiff of two  2D arrays:", result);
Output
[1, 2, 9]

D. Symmetric Difference

The symmetric difference between two sets A and B includes all elements of A and B without the common elements.

Example
//Set Symmetric Difference for 1D array
import mu from "@rysun/numeasy"

const arr1 = mu.array([1, 2, 3]);
const arr2 = mu.array([3, 4, 5]);

const result = mu.setXOR(arr1, arr2);

console.log("Symmetric Difference of two arrays:", result);
Output
[1, 2, 4, 5]
//Set Symmetric Difference for 2D array
import mu from "@rysun/numeasy"

const arr1 = mu.array([
  [1, 2, 3],
  [9, 7, 6],
]);
const arr2 = mu.array([
  [3, 4, 5],
  [6, 7, 8],
]);

const result = mu.setXOR(arr1, arr2);

console.log("setXOR of two 2D arrays:", result);
Output
[1, 2, 4, 5, 8, 9]

3. Statistical Operations

Statistical operations within the @rysun/numeasy package enable complete data analysis. This package provides essential statistical functions such as Median, Mean, Standard Deviation, and Percentile.

A. Median

The median is the middle value in a sorted array. For odd-sized arrays, it's the middle element; for even-sized arrays, it's the average of the two middle elements.

Example
// Find Median from 1D array
import ms from "@rysun/numeasy"

const arr = ms.array([1, 2, 3, 4, 5]);

const result = ms.median(arr);

console.log("median:", result);
Output
3
// Find Median from 2D array
import ms from "@rysun/numeasy"

const arr = ms.array([
  [2, 4, 6],
  [8, 10, 12],
  [14, 16, 18],
]);

// compute median along horizontal axis
const res1 = ms.median(arr, 1);
console.log("Median along horizontal axis :", res1);

// compute median along vertical axis
const res2 = ms.median(arr, 0);
console.log("Median along vertical axis :", res2);

// compute median of entire array
const res3 = ms.median(arr);
console.log("Median of entire array :", res3);
Output
Median along horizontal axis : [ 4, 10, 16 ]
Median along vertical axis : [ 8, 10, 12 ]
Median of entire array : 10

B. Mean

The mean value of an array is the average value of all the elements in the array. It is calculated by adding all elements in the array and then dividing the result by the total number of elements in the array.

Example
// Find Mean from 1D array
import ms from "@rysun/numeasy"

const arr = ms.array([1, 2, 3, 4, 5]);

const result = ms.mean(arr);

console.log("mean:", result);
Output
3
// Find Mean from 2D array
import ms from "@rysun/numeasy"

const arr = ms.array([
  [2, 4, 6],
  [8, 10, 12],
  [14, 16, 18],
]);

// compute mean along horizontal axis
const res1 = ms.mean(arr, 1);
console.log("Mean along horizontal axis :", res1);

// compute mean along vertical axis
const res2 = ms.mean(arr, 0);
console.log("Mean along vertical axis :", res2);

// compute mean of entire array
const res3 = ms.mean(arr);
console.log("Mean of entire array :", res3);
Output
Mean along horizontal axis : [ 4, 10, 16 ]
Mean along vertical axis : [ 8, 10, 12 ]
Mean of entire array : 10

C. Standard Deviation

The standard deviation is a measure of the spread of data in an array. It gives the degree to which the data points deviate from the mean. A smaller standard deviation indicates that data points are closer to the mean and a larger standard deviation indicates that data points are more spread out.

Example
// Standard Deviation of 1D array
import ms from "@rysun/numeasy"

const arr = ms.array([1, 2, 3, 4, 5]);

const result = ms.std(arr);

console.log(result);
Output
1.4142135623730951
// Standard Deviation of 2D array
import ms from "@rysun/numeasy"

const arr = ms.array([[2, 4, 6], [8, 10, 12], [14, 16, 18]])

// compute standard deviation along horizontal axis
const res1 = ms.std(arr,1)
console.log("Standard deviation along horizontal axis:", res1);

// compute standard deviation along vertical axis
const res2 = ms.std(arr,0)
console.log("Standard deviation along vertical axis:", res2);

// compute standard deviation of entire array
const res3 = ms.std(arr)
console.log("Standard deviation of entire array:", res3);
Output
Standard deviation along horizontal axis: [ 1.632993161855452, 1.632993161855452, 1.632993161855452 ] 
Standard deviation along vertical axis: [ 4.898979485566356, 4.898979485566356, 4.898979485566356 ] 
Standard deviation of entire array: 5.163977794943222 

D. Percentile

The Percentile function is used to calculate the nth percentile of a given array.

Example
// Compute Percentile of 1D array 
import ms from "@rysun/numeasy"

const arr = ms.array([1, 2, 3, 4, 5]) 

const result = ms.percentile(arr, 25) 

console.log("percentile:", result); 
Output
2
// Compute Percentile of 2D array 
import ms from "@rysun/numeasy"

const arr = ms.array([[2, 4, 6], [8, 10, 12], [14, 16, 18]]) 

// compute percentile along horizontal axis  
const res1 = ms.percentile(arr, 25, 1) 
console.log("25th Percentile along horizontal axis :", res1); 

// compute percentile along vertical axis  
const res2 = ms.percentile(arr, 25, 0) 
console.log("25th Percentile along vertical axis :", res2); 

// compute percentile of entire array  
const res3 = ms.percentile(arr, 25) 
console.log("25th Percentile of entire array :", res3);
Output
25th Percentile along horizontal axis : [3, 9, 15] 
25th Percentile along vertical axis : [5, 7, 9] 
25th Percentile of entire array : 6 

4. Interpolation

Interpolation estimates the value of a function at points where the value is not known.

Example
import ms from "@rysun/numeasy"

const day = ms.array([2, 4, 7]) 
const gold_price = ms.array([55, 58, 65]) 

// find the value of gold on day 3 
const day3_value = ms.interp(3, day, gold_price) 
console.log ("The value of gold on day 3 is", day3_value) 
Output
The value of gold on day 3 is 56.5 

5. Array Utility Functions

Array utility functions allow users to work with arrays.

A. arange

This function creates an array with evenly spaced elements as per the mentioned interval.

Example
import ms from "@rysun/numeasy"

//Creates an array with elements from 1 to 10 with interval of 2
const x = ms.arange(1,10,2); 
console.log(x); 
Output
[1, 3, 5, 7, 9] 

B. zeros

This function creates a new array of given shape, filled with zeros.

Example
import ms from "@rysun/numeasy"

//Creates two-dimensional array with 4 rows and 5 columns filled with zeros.
const x = ms.zeros(4,5); 
console.log(x);
Output
[ 
[0,0,0,0,0 ], 
[0,0,0,0,0 ], 
[0,0,0,0,0 ], 
[0,0,0,0,0 ] 
] 

C. ones

This function creates a new array of given shape, filled with ones.

Example
import ms from "@rysun/numeasy"

//Creates two-dimensional array with 4 rows and 5 columns filled with zeros.
const x = ms.ones(4,5); 
console.log(x);
Output
[ 
  [ 1, 1, 1, 1, 1 ], 
  [ 1, 1, 1, 1, 1 ], 
  [ 1, 1, 1, 1, 1 ], 
  [ 1, 1, 1, 1, 1 ] 
] 

D. full

This function creates a new array of given shape, filled with value.

Example
import ms from "@rysun/numeasy"

//Creates two-dimensional array with 4 rows and 4 columns filled with value 5.
const x = ms.full(4,4,5); 
console.log(x); 
Output
[
  [ 5, 5, 5, 5 ],  
  [ 5, 5, 5, 5 ],  
  [ 5, 5, 5, 5 ],  
  [ 5, 5, 5, 5 ]
] 

E. random

This submodule provides functions for generating random numbers.

I. rand

This function creates new one dimensional array with random values.

Example
import ms from "@rysun/numeasy"

//creates one dimensional array with five random values
const x = ms.random.rand(5) 
console.log(x);  
Output
   [ 
      0.714506621111916, 
      0.736048246505113, 
      0.5530125531776227, 
      0.8934948245361629, 
      0.9967797501065627 
   ] 

II. random

This function creates new two dimensional array with random values.

Example
import ms from "@rysun/numeasy"

//creates two dimensional array with random values having 3 rows and 4 columns
const x = ms.random.random(3,4) 
console.log(x);
Output
[ 
[ 
0.29887155772703866, 
0.6327841367170803, 
0.9077211642231764, 
0.7828846582948177 
], 
[ 
0.5192162566236251, 
0.36603868808909135, 
0.0507932698224669, 
0.425851373789212 
], 
[ 
0.7443737827909902, 
0.8127019421782091, 
0.003890327404804328, 
0.5747435408734711 
] 
] 

III. randInt

This function takes two arguments, a lower bound and an upper bound. And it returns a random integer between lower and upper bound.

Example
import ms from "@rysun/numeasy"

//creates two dimensional array with 3 rows and 4 columns having values between lower bound 10 and upper bound 100
const x = ms.random.randInt(10,100,3,4) 
console.log(x); 
Output
[
  [29,59,75,84],
  [28,63,13,66],
  [49,21,73,61]
] 

6. Matrix Library

Matrix Library allow users to perform matrix operations such as transpose, addition, multiplication, determinant etc.

A. eye

This function creates a two dimensional array with 1s on the diagonal and 0s elsewhere.

Example
import ms from "@rysun/numeasy"

//creates square matrix with 4 rows and 4 columns having 1s on the diagonal and 0s elsewhere
const x = ms.eye(4) 
console.log(x); 
Output
[ 
[1,0,0,0],
[0,1,0,0], 
[0,0,1,0],
[0,0,0,1]
]

B. transpose

This function swaps the axes of the given array. It means it changes the row elements into column elements and the column elements into row elements.

Example
import ms from "@rysun/numeasy"

//creates array with 2 rows and 3 columns
const mat = ms.array(
  [
  [14,12,19],
  [11,12,19]
  ]
  ) 

//tranpose function changes the row elements into column elements and the column elements into row elements
const x= ms.transpose(mat) 
console.log(x); 
Output
[
  [14,11],
  [12,12],
  [19,19]
] 

C. addition

This function is used when we want to compute the addition of two arrays. It adds arguments element-wise.

Example
import ms from "@rysun/numeasy"

const arr1 = ms.array([
  [18,25,37],
  [5,-7,15]
  ]) 
const arr2 = ms.array([
  [4,8,12],
  [-13,24,17]
  ])
const x = ms.add(arr1,arr2) 
console.log(x);
Output
[ 
  [ 22, 33, 49 ],
  [ -8, 17, 32 ]
] 

D. dot

This function is used to calculate multiplication of two matrices. The number of rows in the first matrix should be equal to the number of columns in the second matrix.

Example
import ms from "@rysun/numeasy"

const mat1 = ms.array([
  [1,3],
  [5,7]
  ]) 
const mat2 = ms.array([
  [2,6],
  [4,8]
  ])
const x = ms.dot(mat1, mat2) 
console.log(x); 
Output
[ 
  [ 14, 30 ],
  [ 38, 86 ] 
] 

E. det

This function is used to calculate determinant of matrix. The determinant is a special number that can be calculated from a matrix. But for that the matrix must be square (same number of rows and columns).

Example
import ms from "@rysun/numeasy"

const matrix = ms.array(
  [
  [1,2,3],
  [4,5,1],
  [2,3,4]
  ]
  ) 
const x = ms.linalg.det(matrix) 
console.log(x); 
Output
-5 

Leverage @rysun/numeasy Today!

Discover the endless possibilities that @rysun/numeasy offers. Dive into the world of mathematics and statistics in JavaScript like never before.

Are you ready?

Install @rysun/numeasy now and unlock the true potential of your data!

Readme

Keywords

none

Package Sidebar

Install

npm i @rysun/numeasy

Weekly Downloads

0

Version

1.1.2

License

ISC

Unpacked Size

99.2 kB

Total Files

32

Last publish

Collaborators

  • rysun