Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/influenceth/cubit
https://github.com/influenceth/cubit
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/influenceth/cubit
- Owner: influenceth
- License: mit
- Created: 2023-03-04T19:02:35.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-05T11:16:02.000Z (3 months ago)
- Last Synced: 2024-04-05T12:23:53.208Z (3 months ago)
- Language: Rust
- Size: 287 KB
- Stars: 34
- Watchers: 2
- Forks: 19
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-cairo - `cubit`
README
# Cubit
 [](https://github.com/auditless/cairo-template/blob/main/LICENSE)
A fixed point math library in 64.64 and 32.32 representation built for Cairo & Starknet. Successor to [**`influenceth/cairo-math-64x61`**](https://github.com/influenceth/cairo-math-64x61)
Cubit is currently a WORK IN PROGRESS and should not be used in production (yet). Contributions are welcomed.
## Usage ##
Cubit was built with [**`auditless/cairo-template`**](https://github.com/auditless/cairo-template), reference its installation guide to install dependencies.
## Signed Fixed Point Numbers ##
A signed 64.64-bit fixed point number is a fraction in which the numerator is a signed 128-bit integer and the denominator is 2^64. Since the denominator stays the same there is no need to store it (as in a floating point value).
64.64 (`f128`) values can represent values in the range of -2^64 to 2^64 with precision to 1e-20.
32.32 (`f64`) values can represent vlaues in the range of -2^32 to 2^32 with precision to 1e-9.
## Core Library ##
All libraries in Cubit are referenced via the core type first, either `cubit::f64` or `cubit::f128`.
Within each library, the following functions are available:
`core` includes the following implementations for the `Fixed` type:
- `Add` (`+`)
- `AddEq` (`+=`)
- `Sub` (`-`)
- `SubEq` (`-=`)
- `Mul` (`*`)
- `MulEq` (`*=`)
- `Div` (`/`)
- `DivEq` (`/=`)
- `PartialEq` (`==`, `!=`)
- `PartialOrd` (`>`, `>=`, `<`, `<=`)
- `fixed.ceil`
- `fixed.exp`
- `fixed.floor`
- `fixed.ln`
- `fixed.log2`
- `fixed.log10`
- `fixed.pow`
- `fixed.round`
- `fixed.sqrt`
`trig` includes precise and fast versions of the following trigonometric functions:
- `fixed.cos`
- `fixed.cos_fast`
- `fixed.sin`
- `fixed.sin_fast`
- `fixed.tan`
- `fixed.tan_fast`
- `fixed.acos`
- `fixed.acos_fast`
- `fixed.asin`
- `fixed.asin_fast`
- `fixed.atan`
- `fixed.atan_fast`
## License
[MIT](https://github.com/influenceth/cubit/LICENSE) © [Unstoppable Games, Inc.](https://unstoppablegames.io)