Samasya NPM | npm.io

samasya

samasya is a TypeScript-based mathematical library inspired by math.js, designed to provide a comprehensive set of mathematical functions and utilities for JavaScript and TypeScript projects.

📚 Documentation

Explore the full documentation at https://samasya-docs.netlify.app. It includes detailed usage examples, API references, and more.

🌟 Features

Core Arithmetic Operations

Basic Arithmetic: Addition, subtraction, multiplication, and division for both numbers and arrays.
Modular Arithmetic: Operations such as modulo, modular addition, subtraction, multiplication, and exponentiation.

Advanced Mathematical Capabilities

Power and Root Calculations: Compute powers and nth roots of numbers.
Prime and Factorial Functions: Compute factorials with modulus and enhance prime-related functionalities.

Algebraic and Expression Evaluation

Algebraic Evaluator: A new Evaluator class that supports algebraic expressions with variables, constants, and built-in functions (e.g., sqrt, log, sin, cos).
Chaining Operations: Chain multiple arithmetic operations in a fluent API style.
Dynamic Expressions: Evaluate complex algebraic expressions dynamically, with support for custom functions and variables.

Cryptography-Oriented Features

Modular Cryptographic Functions: Perform modular hashing, encryption, and decryption.

High-Precision and Big Numbers

BigNumber: Built on Decimal.js for handling large floating-point numbers with complete precision.
BigInt: A custom implementation leveraging JavaScript's native BigInt for arbitrary-sized integer operations.

Robust Design

Error Handling: Comprehensive error handling for invalid inputs and edge cases.

📦 Installation

You can install samasya using npm:

npm install samasya

🚀 Quick Start

Basic Arithmetic Example

import { add, multiply } from 'samasya';

console.log(add(2, 3)); // Output: 5
console.log(multiply([2, 3, 4])); // Output: 24

Chaining Example

import { Chain } from 'samasya';

const result = new Chain(5).add(3).multiply(2).getResult();
console.log(result); // Output: 16

🛠 Development

To set up the project for development:

Clone the repository:

git clone https://github.com/tejasbenibagde/samasya.git
cd samasya

Install dependencies:
```
npm install
```
Run tests:
```
npm test
```
Build the project:
```
npm run build
```

Contributing

We welcome contributions to samasya! Please see our Contributing Guide for more details on how to get started.

License

samasya is MIT licensed.

Author

samasya is created and maintained by Tejas Benibagde.

Support

If you encounter any issues or have questions, please file an issue on our GitHub issues page.

Acknowledgements

This project is inspired by math.js. We're grateful to the math.js team for their excellent work, which has served as a reference for many of the features planned for samasya.