strict-num-extended 0.5.0

Type-safe finite floating-point types for Rust - eliminate NaN and infinity at compile time
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

# strict-num-extended

[![Crates.io](https://img.shields.io/crates/v/strict-num-extended)](https://crates.io/crates/strict-num-extended)
[![Documentation](https://docs.rs/strict-num-extended/badge.svg)](https://docs.rs/strict-num-extended)
[![License: Apache-2.0](https://img.shields.io/badge/License-Apache--2.0-blue.svg)](LICENSE)
[![CI](https://github.com/MiyakoMeow/strict-num-extended/actions/workflows/rust.yml/badge.svg)](https://github.com/MiyakoMeow/strict-num-extended/actions/workflows/rust.yml)
[![codecov](https://codecov.io/gh/MiyakoMeow/strict-num-extended/graph/badge.svg)](https://codecov.io/gh/MiyakoMeow/strict-num-extended)
[![Cargo Deny](https://github.com/MiyakoMeow/strict-num-extended/actions/workflows/cargo-deny.yml/badge.svg)](https://github.com/MiyakoMeow/strict-num-extended/actions/workflows/cargo-deny.yml)
[![Downloads](https://img.shields.io/crates/d/strict-num-extended)](https://crates.io/crates/strict-num-extended)
[![Rust Edition: 2024](https://img.shields.io/badge/Rust-Edition%202024-orange.svg)](https://doc.rust-lang.org/edition-guide/rust-2024/index.html)

Type-safe finite floating-point numbers for Rust.

A Rust library providing zero-cost finite floating-point types through the type system, guaranteeing safety by eliminating NaN and infinity values at compile time or runtime.

## Features

- **Type Safety** - Catch floating-point errors at compile time or runtime
- **Zero-Cost Abstractions** - No performance overhead compared to built-in types except the additional value checking
- **Comprehensive Constraints** - Finite, Positive, Negative, NonZero, Normalized, NegativeNormalized, Symmetric, ...
- **Full Trait Implementation** - PartialEq, Eq, PartialOrd, Ord, Display, Debug, arithmetic operators
- **Const Support** - Create compile-time constants with validation
- **Option/Result Arithmetic** - Optional and fallible operations with automatic error propagation
- **Type Conversions** - Safe F32↔F64 conversions with precision detection

## Available Types

| Type | Valid Range | Example |
|------|-------------|---------|
| `FinF32` / `FinF64` | All real numbers | `-∞ < x < ∞` |
| `NonNegativeF32` / `NonNegativeF64` | `x ≥ 0` | `0.0, 1.5, 100.0` |
| `NonPositiveF32` / `NonPositiveF64` | `x ≤ 0` | `0.0, -1.5, -100.0` |
| `NonZeroF32` / `NonZeroF64` | `x ≠ 0` | `1.0, -1.0, 0.001` |
| `PositiveF32` / `PositiveF64` | `x > 0` | `0.001, 1.0, 100.0` |
| `NegativeF32` / `NegativeF64` | `x < 0` | `-0.001, -1.0, -100.0` |
| `NormalizedF32` / `NormalizedF64` | `0.0 ≤ x ≤ 1.0` | `0.0, 0.5, 1.0` |
| `NegativeNormalizedF32` / `NegativeNormalizedF64` | `-1.0 ≤ x ≤ 0.0` | `-0.5, -0.75, -1.0` |
| `SymmetricF32` / `SymmetricF64` | `-1.0 ≤ x ≤ 1.0` | `-1.0, 0.0, 0.5, 1.0` |

## Error Handling

All fallible operations return `Result<T, FloatError>` with detailed error information:

**Error Types**:
- `NaN` - Value is Not a Number
- `PosInf` - Value is positive infinity
- `NegInf` - Value is negative infinity
- `OutOfRange` - Value is outside the valid range for the target type
- `DivisionByZero` - Division by zero occurred
- `NoneOperand` - Right-hand side operand is None in Option arithmetic

The `FloatError` enum provides comprehensive error information for proper error handling and debugging, allowing precise error matching and recovery strategies.

### Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

### License

This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.