Skip to content

Commit 28896d9

Browse files
committed
v1.5.5: Toolchain (benchmarking) and documentation update, no functional changes.
1 parent 09f922d commit 28896d9

File tree

2 files changed

+9
-10
lines changed

2 files changed

+9
-10
lines changed

README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,22 +13,21 @@
1313
[![Charts](https://github.com/shBLOCK/spatium/actions/workflows/charts.yml/badge.svg)](https://github.com/shBLOCK/spatium/actions/workflows/charts.yml)
1414

1515
## ⚙️Main features
16-
- Fast Pure Cython Implementation
17-
- ~***20x*** speedup from pure python(3.12) impl on average
18-
- Based on custom code generation
19-
- Almost all static dispatch
16+
- **Fast** Pure Cython Implementation
17+
- ~***16x*** faster than pure python(3.12) implementation
2018
- Spatial Math
2119
- [Vector](https://github.com/shBLOCK/spatium/wiki#vectors)
2220
- Operators +, -, *, /, @(dot), ^(cross), |(distance) ...
23-
- Fast (compile time) swizzling (e.g. `Vec3(1, 2, 3).zxy`)
21+
- Fast (compile-time) swizzling (e.g. `Vec3(1, 2, 3).zxy`)
2422
- Flexible constructor (e.g. `Vec3(Vec2(1, 2), 3)`)
2523
- Iterating and unpacking (e.g. `x, y, z = Vec3(1, 2, 3)`)
2624
- Works with other libraries (pygame, numpy, ...)
2725
- Transform
2826
- [Transform2D](https://github.com/shBLOCK/spatium/wiki#transform2d) & [Transform3D](https://github.com/shBLOCK/spatium/wiki#transform3d)
29-
- All floats are double-precision
30-
- Full pythonic interface & GLSL-like API
31-
- Stubs for better IDE support
27+
- Double-precision floats
28+
- Pythonic & GLSL-like interface
29+
- Custom code generation
30+
- IDE-friendly stubs
3231

3332
Please refer to the [wiki](https://github.com/shBLOCK/spatium/wiki) for more details
3433

@@ -41,7 +40,7 @@ Please refer to the [wiki](https://github.com/shBLOCK/spatium/wiki) for more det
4140
Every swizzle pattern and constructor are implemented as individual methods and properties (For performance reasons).<br>
4241
As a result, code generation is required so that I don't have to maintain 50,000+ lines of code by hand...<br>
4342
Besides, it also handles vector classes of every dimension and type (e.g. Vec2 Vec3 Vec2i Vec3i) are generated from the same template, so a lot of repetitive code is avoided.<br>
44-
There's also a stub generator.
43+
There's also a stub generator that generates stub files from the cython code generated by codegen.
4544

4645
## Credits
4746
- This library is partially inspired by [Godot](https://godotengine.org/)'s math library.

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ requires = ["setuptools", "cython"]
44

55
[project]
66
name = "spatium"
7-
version = "1.5.4"
7+
version = "1.5.5"
88
description = "Spatium: a fast spatial math library"
99
readme = "README.md"
1010
requires-python = ">= 3.9"

0 commit comments

Comments
 (0)