no-std Fix #6 (#38)

.circleci/config.yml

@@ -8,7 +8,9 @@ jobs:
       - run: rustup toolchain install nightly
       - run: cargo +nightly -Zscript ./pre-publish.rs
       - run: cargo test
+      - run: cargo test --no-default-features
       - run: cargo test --test 'serde' --features serde
+      - run: cargo test --test 'serde' --no-default-features --features serde
   build_and_test_arm:
     machine:
       image: ubuntu-2004:current 
@@ -19,7 +21,9 @@ jobs:
       - run: rustup toolchain install nightly
       - run: cargo +nightly -Zscript ./pre-publish.rs
       - run: cargo test
+      - run: cargo test --no-default-features
       - run: cargo test --test 'serde' --features serde
+      - run: cargo test --test 'serde' --no-default-features --features serde
 
 workflows:
   version: 2

.github/workflows/tests.yml

@@ -32,8 +32,12 @@ jobs:
           cargo build
       - name: Run tests
         run: cargo test --verbose
+      - name: Run no-std tests
+        run: cargo test --verbose --no-default-features
       - name: Run serde tests
         run: cargo test --verbose --test 'serde' --features serde
+      - name: Run no-std+serde tests
+        run: cargo test --verbose --test 'serde' --no-default-features --features serde
 
   clippy:
     runs-on: ubuntu-latest

README.md

@@ -111,7 +111,8 @@ Any other overhead is considered a bug and should be reported.
 
 # Features
 
-- `serde`: implements `Serialize` and `Deserialize` for all types
+- `std`: enabled by default, required by some `f32` and `f64` methods.
+- `serde`: implements `Serialize` and `Deserialize` for all types.
 
 ## How it works
 

typed_floats/Cargo.toml

@@ -7,7 +7,7 @@ include = [
   "src/*.rs",
   "*.md",
 ]
-keywords = ["floats", "non-zero", "NaN"]
+keywords = ["floats", "non-zero", "NaN", "no_std"]
 license = "MIT OR Apache-2.0"
 name = "typed_floats"
 readme = "./README.md"
@@ -16,13 +16,22 @@ version = "0.3.0"
 rust-version = "1.56"
 
 [features]
-default = []
+default = ["std"]
 serde = ["dep:serde"]
+std = ["typed_floats_macros/std"]
 
 [dependencies]
-thiserror = "1.0"
-typed_floats_macros = {version = "=0.3.0", path = "../typed_floats_macros"}
-serde = { version = "1.0", features = ["derive"], optional = true }
+
+[dependencies.typed_floats_macros]
+version = "=0.3.0"
+path = "../typed_floats_macros"
+
+[dependencies.serde]
+version = "1.0"
+default-features = false
+features = ["derive"]
+optional = true
+
 
 [dev-dependencies]
 # For examples

typed_floats/src/lib.rs

@@ -107,6 +107,7 @@
 #![warn(clippy::unwrap_in_result)]
 #![warn(clippy::indexing_slicing)]
 #![warn(missing_docs)]
+#![cfg_attr(not(feature = "std"), no_std)]
 
 /// This macros assert that two values are close to each other.
 ///
@@ -247,6 +248,7 @@ macro_rules! assert_is_negative_zero {
     }};
 }
 
+#[cfg(feature = "std")]
 /// This trait is used to specify the return type of the [`Hypot::hypot()`] function.
 pub trait Hypot<T> {
     /// The resulting type after applying [`Hypot::hypot()`].
@@ -325,6 +327,7 @@ pub trait Max<T> {
     fn max(self, rhs: T) -> Self::Output;
 }
 
+#[cfg(feature = "std")]
 /// This trait is used to specify the return type of the [`Copysign::copysign()`] function.
 pub trait Copysign<T> {
     /// The resulting type after applying [`Copysign::copysign()`].
@@ -359,6 +362,7 @@ pub trait Copysign<T> {
     fn copysign(self, rhs: T) -> Self::Output;
 }
 
+#[cfg(feature = "std")]
 /// This trait is used to specify the return type of the [`DivEuclid::div_euclid()`] function.
 pub trait DivEuclid<T> {
     /// The resulting type after applying [`DivEuclid::div_euclid()`].
@@ -389,6 +393,7 @@ pub trait DivEuclid<T> {
     fn div_euclid(self, rhs: T) -> Self::Output;
 }
 
+#[cfg(feature = "std")]
 /// This trait is used to specify the return type of the [`Atan2::atan2()`] function.
 pub trait Atan2<T> {
     /// The resulting type after applying [`Atan2::atan2()`].
@@ -418,14 +423,15 @@ pub trait Atan2<T> {
     /// let x2 = -3.0_f64;
     /// let y2 = 3.0_f64;
     ///
-    /// assert_relative_eq!(y1.atan2(x1), -std::f64::consts::FRAC_PI_4);
-    /// assert_relative_eq!(y2.atan2(x2), 3.0 * std::f64::consts::FRAC_PI_4);
+    /// assert_relative_eq!(y1.atan2(x1), -core::f64::consts::FRAC_PI_4);
+    /// assert_relative_eq!(y2.atan2(x2), 3.0 * core::f64::consts::FRAC_PI_4);
     /// ```
     ///
     /// See [`f64::atan2()`] for more details.
     fn atan2(self, rhs: T) -> Self::Output;
 }
 
+#[cfg(feature = "std")]
 /// This trait is used to specify the return type of the [`Powf::powf()`] function.
 pub trait Powf<T> {
     /// The resulting type after applying [`Powf::powf()`].
@@ -440,44 +446,62 @@ typed_floats_macros::generate_docs!(
 );
 
 /// An error that can occur when converting from a string into a `TypedFloat`
-#[derive(Error, Debug)]
+#[derive(Debug)]
 pub enum FromStrError {
     /// The string did not contain a valid float number
-    #[error("{0:?}")]
     ParseFloatError(core::num::ParseFloatError),
     /// The string contained a valid float number but it didn't fit in the target type
-    #[error("{0:?}")]
     InvalidNumber(InvalidNumber),
 }
 
+impl core::fmt::Display for FromStrError {
+    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
+        match self {
+            FromStrError::ParseFloatError(e) => write!(f, "{e}"),
+            FromStrError::InvalidNumber(e) => write!(f, "{e}"),
+        }
+    }
+}
+
+#[cfg(feature = "std")]
+impl std::error::Error for FromStrError {}
+
 #[cfg(feature = "serde")]
 use serde::{Deserialize, Deserializer, Serialize};
 
 use core::num::{NonZeroI16, NonZeroI32, NonZeroI64, NonZeroI8};
 use core::num::{NonZeroU16, NonZeroU32, NonZeroU64, NonZeroU8};
 
-use thiserror::Error;
-
 /// An error that can occur when converting into a typed float
-#[derive(Error, Debug, Eq, PartialEq)]
+#[derive(Debug, Eq, PartialEq)]
 pub enum InvalidNumber {
     /// Any variant of `Nan`
-    #[error("Number is NaN")]
     NaN,
     /// `+0.0` or `-0.0`
-    #[error("Number is zero")]
     Zero,
     /// Any negative number, including `-0.0` and `-inf`
-    #[error("Number is negative")]
     Negative,
     /// Any positive number, including `+0.0` and `+inf`
-    #[error("Number is positive")]
     Positive,
     /// `+inf` or `-inf`
-    #[error("Number is infinite")]
     Infinite,
 }
 
+impl core::fmt::Display for InvalidNumber {
+    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
+        match self {
+            InvalidNumber::NaN => write!(f, "Number is NaN"),
+            InvalidNumber::Zero => write!(f, "Number is zero"),
+            InvalidNumber::Negative => write!(f, "Number is negative"),
+            InvalidNumber::Positive => write!(f, "Number is positive"),
+            InvalidNumber::Infinite => write!(f, "Number is infinite"),
+        }
+    }
+}
+
+#[cfg(feature = "std")]
+impl std::error::Error for InvalidNumber {}
+
 typed_floats_macros::generate_floats!();
 
 macro_rules! add_const {

typed_floats/tests/abs.rs

@@ -1,3 +1,5 @@
+#![cfg(feature = "std")]
+
 use typed_floats::*;
 
 typed_floats_macros::generate_tests_self!(abs);

typed_floats/tests/acos.rs

@@ -1,3 +1,5 @@
+#![cfg(feature = "std")]
+
 use typed_floats::*;
 
 typed_floats_macros::generate_tests_self!(acos);

typed_floats/tests/acosh.rs

@@ -1,3 +1,5 @@
+#![cfg(feature = "std")]
+
 use typed_floats::*;
 
 typed_floats_macros::generate_tests_self!(acosh);

typed_floats/tests/asin.rs

@@ -1,3 +1,5 @@
+#![cfg(feature = "std")]
+
 use typed_floats::*;
 
 typed_floats_macros::generate_tests_self!(asin);

typed_floats/tests/asinh.rs

@@ -1,3 +1,5 @@
+#![cfg(feature = "std")]
+
 use typed_floats::*;
 
 typed_floats_macros::generate_tests_self!(asinh);

typed_floats/tests/atan.rs

@@ -1,3 +1,5 @@
+#![cfg(feature = "std")]
+
 use typed_floats::*;
 
 typed_floats_macros::generate_tests_self!(atan);

typed_floats/tests/atan2.rs

@@ -1,3 +1,5 @@
+#![cfg(feature = "std")]
+
 use typed_floats::*;
 
 typed_floats_macros::generate_tests_self_rhs!(atan2);

typed_floats/tests/atanh.rs

@@ -1,3 +1,5 @@
+#![cfg(feature = "std")]
+
 use typed_floats::*;
 
 typed_floats_macros::generate_tests_self!(atanh);

typed_floats/tests/cbrt.rs

@@ -1,3 +1,5 @@
+#![cfg(feature = "std")]
+
 use typed_floats::*;
 
 typed_floats_macros::generate_tests_self!(cbrt);

typed_floats/tests/ceil.rs

@@ -1,3 +1,5 @@
+#![cfg(feature = "std")]
+
 use typed_floats::*;
 
 typed_floats_macros::generate_tests_self!(ceil);

typed_floats/tests/copysign.rs

@@ -1,3 +1,5 @@
+#![cfg(feature = "std")]
+
 use typed_floats::*;
 
 typed_floats_macros::generate_tests_self_rhs!(copysign);

typed_floats/tests/cos.rs

@@ -1,3 +1,5 @@
+#![cfg(feature = "std")]
+
 use typed_floats::*;
 
 typed_floats_macros::generate_tests_self!(cos);

typed_floats/tests/cosh.rs

@@ -1,3 +1,5 @@
+#![cfg(feature = "std")]
+
 use typed_floats::*;
 
 typed_floats_macros::generate_tests_self!(cosh);

typed_floats/tests/div_euclid.rs

@@ -1,3 +1,5 @@
+#![cfg(feature = "std")]
+
 use typed_floats::*;
 
 typed_floats_macros::generate_tests_self_rhs!(div_euclid);

typed_floats/tests/exp.rs

@@ -1,3 +1,5 @@
+#![cfg(feature = "std")]
+
 use typed_floats::*;
 
 typed_floats_macros::generate_tests_self!(exp);

typed_floats/tests/exp2.rs

@@ -1,3 +1,5 @@
+#![cfg(feature = "std")]
+
 use typed_floats::*;
 
 typed_floats_macros::generate_tests_self!(exp2);

typed_floats/tests/exp_m1.rs

@@ -1,3 +1,5 @@
+#![cfg(feature = "std")]
+
 use typed_floats::*;
 
 typed_floats_macros::generate_tests_self!(exp_m1);

typed_floats/tests/floor.rs

@@ -1,3 +1,5 @@
+#![cfg(feature = "std")]
+
 use typed_floats::*;
 
 typed_floats_macros::generate_tests_self!(floor);

typed_floats/tests/fract.rs

@@ -1,3 +1,5 @@
+#![cfg(feature = "std")]
+
 use typed_floats::*;
 
 typed_floats_macros::generate_tests_self!(fract);

typed_floats/tests/hypot.rs

@@ -1,3 +1,19 @@
+#![cfg(feature = "std")]
+
 use typed_floats::*;
 
 typed_floats_macros::generate_tests_self_rhs!(hypot);
+
+#[test]
+fn test_hypot() {
+    let a = 3.0f64;
+    let b = 4.0f64;
+    let c = 5.0f64;
+
+    let a = NonNaN::try_from(a).unwrap();
+    let b = NonNaN::try_from(b).unwrap();
+    let c = Positive::try_from(c).unwrap();
+
+    let result = a.hypot(b);
+    assert_eq!(result, c);
+}

typed_floats/tests/ln.rs

@@ -1,3 +1,5 @@
+#![cfg(feature = "std")]
+
 use typed_floats::*;
 
 typed_floats_macros::generate_tests_self!(ln);

typed_floats/tests/ln_1p.rs

@@ -1,3 +1,5 @@
+#![cfg(feature = "std")]
+
 use typed_floats::*;
 
 typed_floats_macros::generate_tests_self!(ln_1p);

typed_floats/tests/log10.rs

@@ -1,3 +1,5 @@
+#![cfg(feature = "std")]
+
 use typed_floats::*;
 
 typed_floats_macros::generate_tests_self!(log10);