# math-rs

> A basic mathematical engine

Latest version **0.1.5** (published 2023-05-25) · MIT OR Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install math-rs
pnpm add math-rs
yarn add math-rs
bun add math-rs
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.5 |
| Published | 2023-05-25 |
| First published | 2023-05-22 |
| Weekly downloads | 0 |
| License | MIT OR Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 181.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | viksa |
| Keywords | mathematics, algebra, math, matrix |

## Links

- npm: https://www.npmjs.com/package/math-rs
- Repository: https://github.com/VikSa666/mathrs
- Homepage: https://math-rs.rs
- Issues: https://github.com/VikSa666/mathrs/issues
- npm.io page: https://npm.io/package/math-rs

## Alternatives

- [random-seedable](https://npm.io/package/random-seedable.md) — 27.9K weekly downloads
- [n2words](https://npm.io/package/n2words.md) — 22.2K weekly downloads
- [@stdlib/math-base-special-factorialln](https://npm.io/package/@stdlib/math-base-special-factorialln.md) — 5.7K weekly downloads
- [@stdlib/math-base-special-abs2](https://npm.io/package/@stdlib/math-base-special-abs2.md) — 1.7K weekly downloads
- [commons-math-interpolation](https://npm.io/package/commons-math-interpolation.md) — 1.4K weekly downloads

## Recent versions

- 0.1.5 (latest) — 2023-05-25
- 0.1.4 — 2023-05-22

## README

# Mathrs

A mathematical library

For now, only matrices calculator is implemented.

## What you can do

1. Calculate the sum, the substraction and the multiplication of matrices.
2. Calculate the reduced matrix using Gauss Triangulation.
3. Calculate the determinant matrix using both Gauss Triangulation and LU decomposition.
4. Calculate the inverse of a matrix using the Gauss-Jordan method.

## Usage in Rust

Every matrix can be created using a macro that will parse a string represenging the matrix in the following way: `{{a11, a12, a13, ...}. {a21, a22, a23, ...}, ...}`. As each matrix can contain different type of numbers, you have to specify which type of number will you get: `matrix_<number_type>!("{{a11, a12, ...}, {a21, a22, ...}, ...}")`.

### Examples

The call

```rust
let matrix = matrix_f32!("{{1.1, 2.2}, {2.1, 3.2}}");
println!("{matrix}")
```

will print

```asdf
+1.1000000 +2.2000000
+2.1000000 +3.2000000
```

## Usage in Javascript or Typescript

```ts
const performSum = async () => {
  await init();
  result.value = RMatrixF32.checked_sum(
    RMatrixF32.from_string(matA.value, 1e-6),
    RMatrixF32.from_string(matB.value, 1e-6)
  ).to_string();
};

const performSub = async () => {
  await init();
  result.value = RMatrixF32.checked_sub(
    RMatrixF32.from_string(matA.value, 1e-6),
    RMatrixF32.from_string(matB.value, 1e-6)
  ).to_string();
};

const performMul = async () => {
  await init();
  result.value = RMatrixF32.checked_mul(
    RMatrixF32.from_string(matA.value, 1e-6),
    RMatrixF32.from_string(matB.value, 1e-6)
  ).to_string();
};

const mat = ref("");
const result2 = ref("Nothing yet...");

const preformGaussReduction = async () => {
  await init();
  result2.value = RMatrixF32.from_string(mat.value, 1e-6)
    .gaussian_triangulation()
    .to_string();
};

const performGaussJordanDeterminant = async () => {
  await init();
  result2.value = RMatrixF32.from_string(mat.value, 1e-6)
    .determinant_using_gauss()
    .toString();
};

const performGaussJordanInverse = async () => {
  await init();
  result2.value = RMatrixF32.from_string(mat.value, 1e-6)
    .inverse_gauss_jordan()
    .to_string();
};
```

---
_Source: https://npm.io/package/math-rs · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
