https://github.com/figureland/mathkit

A minimal toolkit for working with numbers, matrices and vectors
https://github.com/figureland/mathkit

2d bun math matrix matrix2d typescript vector vector2

Last synced: 5 days ago
JSON representation

A minimal toolkit for working with numbers, matrices and vectors

• Host: GitHub
• URL: https://github.com/figureland/mathkit
• Owner: figureland
• License: mit
• Created: 2024-04-13T09:52:09.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-05-02T18:45:25.000Z (9 months ago)
• Last Synced: 2024-05-02T21:42:50.156Z (9 months ago)
• Topics: 2d, bun, math, matrix, matrix2d, typescript, vector, vector2
• Language: TypeScript
• Homepage:
• Size: 92.8 KB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
> [!IMPORTANT]

> This codebase is deprecated, and has been moved to [@figureland/kit](https://github.com/figureland/kit/).

![mathkit illustration](./docs/mathkit-hero.svg)

[![CI](https://github.com/figureland/mathkit/actions/workflows/ci.yml/badge.svg)](https://github.com/figureland/mathkit/actions/workflows/ci.yml)

[![NPM](https://img.shields.io/npm/v/@figureland/mathkit.svg)](https://img.shields.io/npm/v/@figureland/mathkit.svg)

**mathkit** is a collection of tools for working with numbers, matrices, shapes and more. The aim here is to have something minimal and unbloated, and also a place to learn by building from scratch.

> [!NOTE]

> It would be great to use [DOMMatrix](https://developer.mozilla.org/en-US/docs/Web/API/DOMMatrix#specifications) and [DOMPoint](https://developer.mozilla.org/en-US/docs/Web/API/DOMPoint#specifications) more. I could remove a big chunk of this library. But somehow I found them inflexible and didn't perform that well. Maybe something to do with having to call `new DOMMatrix()` every time you want to multiply two matrices, for example, feels as if it incurs a real cost if you're running it every frame. Maybe in 2024 that's not the case and when I have time I will revisit. They would need to be polyfilled somehow in Bun/node.js servers.

>

> In the meantime, there are some helpers in [src/style.ts](./src/style.ts) to help with translation.

Credit to [gl-matrix](https://glmatrix.net/) for inspiration, some API choices and indeed directly copying over a few methods. A library I've used many many times over the years.

## Scripts

### Install

```bash

bun install

```

### Test

```bash

bun test

```

### Build

```bash

bun run build

```