https://github.com/alphaqu/mathie

A rust math type library
https://github.com/alphaqu/mathie

Last synced: about 2 months ago
JSON representation

A rust math type library

• Host: GitHub
• URL: https://github.com/alphaqu/mathie
• Owner: alphaqu
• License: apache-2.0
• Created: 2022-08-06T14:37:47.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-10-06T10:47:16.000Z (over 2 years ago)
• Last Synced: 2024-10-31T11:33:37.085Z (2 months ago)
• Language: Rust
• Size: 47.9 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        
# Mathie

## Overview

Mathie is a rust math type library which contains the 3 basic types

for doing anything 2D.

- `Value` A single number value.

- `Vec2` A two-dimensional position.

- `Rect` A two-dimensional area that has an origin and a size.

## Math

Doing math with the builtin types is designed to be simple and powerful.

All of them support Addition, Subtraction, Multiplication, Division and Remainder.

```rust

fn add() {

    assert_eq!(Vec2D::new(0.5, 0.5) + Vec2D::new(1.0, 1.0), Vec2D::new(1.5, 1.5));

    assert_eq!(Vec2D::new(0.5, 0.5) + 1.0,                  Vec2D::new(1.5, 1.5));

}

```

## Units

This library runs on the optional concept of units which may be sized

and are designed to be easily converted between without thinking about it.

```rust

fn cm_to_m() {

    let v0 = Vec2D::::new_def(250.0, 250.0);

    // () is base unit. In all cases its Meter

    let v1 = v0.convert::<()>();

    assert_eq!(v1, Vec2D::new_def(2.5, 2.5));

}

```

There are builtin units that are optional.

- `metric_units` 20 Metric prefixes

- `imperial_units` 10 Imperial prefixes

- `nautical_units` Nautical mile

## Compatibility

This library has optional features for compatibility between other

math type libraries like `euclid`.

```rust

fn euclid_compat() {

    let _: Vec2D = euclid::Vector2D::new(1.0, 1.0).into();

}

```