Skip to content

v0.5.1: Readme typo #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
GeEom merged 1 commit into from
Jan 11, 2026
Merged

v0.5.1: Readme typo #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "fixed_analytics"
version = "0.5.0"
version = "0.5.1"
edition = "2024"
rust-version = "1.88"
authors = ["David Gathercole"]
Expand Down
9 changes: 4 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,14 @@ Requires Rust 1.88 or later.

```toml
[dependencies]
fixed_analytics = "0.5"
fixed_analytics = "0.5.1"
```

For `no_std` environments:

```toml
[dependencies]
fixed_analytics = { version = "0.5", default-features = false }
fixed_analytics = { version = "0.5.1", default-features = false }
```

## Available Functions
Expand All @@ -50,16 +50,15 @@ fixed_analytics = { version = "0.5", default-features = false }
| Category | Total Functions | Fallible Functions |
|----------|-----------------|-------------------|
| Trigonometric | `sin`, `cos`, `tan`, `sin_cos`, `atan`, `atan2` | `asin`, `acos` |
| Hyperbolic | `sinh`, `cosh`, `tanh`, `sinh_cosh`\*, `asinh` | `acosh`, `atanh`, `acoth`, `coth` |
| Hyperbolic | `sinh`, `cosh`, `tanh`, `sinh_cosh`, `asinh` | `acosh`, `atanh`, `acoth`, `coth` |
| Exponential | `exp`, `pow2` | `ln`, `log2`, `log10` |
| Algebraic | — | `sqrt` |

Functions are calculated via CORDIC, Newton-Raphson, and Taylor series techniques.

### Saturation Behavior

The following total functions use **saturation semantics**: rather than returning an error or
panicking on overflow, they clamp to the representable range.
The following total functions saturate, clamping to the representable range near the following thresholds.

| Function | I16F16 Threshold | I32F32 Threshold | Result |
|----------|------------------|------------------|--------|
Expand Down