shravan20 / flare.ts

A powerful utility library for clean code in js (npm package)
https://shravan20.github.io/flare.ts
MIT License
2 stars 6 forks source link

feat: create a MathUtils to base mathematics operations #13

Open shravan20 opened 9 months ago

shravan20 commented 9 months ago

Summary:

Create a comprehensive MathUtils utility library that offers a wide range of mathematical operations, both base and complex, to assist developers in performing various mathematical calculations within their applications. This library should include functions like acosh, acos, absolute, atanh, copySign, getExponent, max, pow, sin, cos, tan, cosec, sec, cot, sinh, tanh, toDegrees, toRadians, lcm, gcd, verifyMathExpression, isNumber, getAbsolutePrecised, getEpsilon, and potentially more.

Motivation

Mathematical operations are fundamental in software development, and having a centralized utility library will aid developers in performing complex mathematical calculations accurately and efficiently. This will not only improve code readability but also reduce redundant code and enhance application performance.

Utility Functions

The MathUtils utility should encompass a comprehensive set of mathematical functions, including, but not limited to:

Documentation

Comprehensive documentation should accompany each utility function, detailing its purpose, usage, parameters, return values, and examples.

Expected Behavior

Developers should be able to easily integrate the MathUtils utility into their projects, simplifying mathematical operations and improving code quality.

shravan20 commented 9 months ago

I can add more details for each specific method expected. Please reach out to me

abdulbari149 commented 9 months ago

Hey, would like to work on the following proposed functionalities. Please reach out to me

shravan20 commented 9 months ago

@abdulbari149: Sure, feel to pick this up and raise the PR. If there is anything specific that you want to discuss, please feel free to join the discord server added as part of the readme

Discord Server: https://discord.gg/2nN2VqwNaK

shravan20 commented 9 months ago

@abdulbari149: Awesome, feel free to pick this up and do let me know if you want to discuss anything specific.