Skip to content

Commit

Permalink
feat: [wip] ordered-float feature options
Browse files Browse the repository at this point in the history
  • Loading branch information
Greg Echelberger committed Nov 4, 2024
1 parent d385d79 commit 75e0e26
Show file tree
Hide file tree
Showing 11 changed files with 614 additions and 13 deletions.
10 changes: 10 additions & 0 deletions Cargo.lock
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions Cargo.toml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ num-bigint = { version = "0.4", optional = true, default-features = false, featu
num-complex = { version = "0.4", optional = true, default-features = false, features = ["std"] }
serde = { version = "1.0", optional = true, default-features = false }
typenum = "1.13"
ordered-float = { version = "4.5.0", optional = true, default-features = false, features = ["std"] }

[dev-dependencies]
approx = "0.5"
Expand Down Expand Up @@ -67,6 +68,10 @@ rational64 = ["rational-support"]
bigrational = ["bigint-support"]
complex32 = ["complex-support"]
complex64 = ["complex-support"]
orderedf32 = ["ordered-float-support"]
orderedf64 = ["ordered-float-support"]
notnanf32 = ["ordered-float-support"]
notnanf64 = ["ordered-float-support"]
f32 = []
f64 = []
si = []
Expand All @@ -81,6 +86,7 @@ use_serde = ["serde"]
rational-support = ["num-rational"]
bigint-support = ["num-bigint", "num-rational/num-bigint-std"]
complex-support = ["num-complex"]
ordered-float-support = ["ordered-float"]

[[example]]
name = "base"
Expand Down
94 changes: 93 additions & 1 deletion src/lib.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,8 @@
feature = "bigint", feature = "biguint",
feature = "rational", feature = "rational32", feature = "rational64", feature = "bigrational",
feature = "complex32", feature = "complex64",
feature = "orderedf32", feature = "orderedf64",
feature = "notnanf32", feature = "notnanf64",
feature = "f32", feature = "f64", )))]
compile_error!("A least one underlying storage type must be enabled. See the features section of \
uom documentation for available underlying storage type options.");
Expand All @@ -215,6 +217,10 @@ pub extern crate num_rational;
#[cfg(feature = "complex-support")]
pub extern crate num_complex;

#[doc(hidden)]
#[cfg(feature = "ordered-float-support")]
pub extern crate ordered_float;

#[doc(hidden)]
#[cfg(feature = "serde")]
pub extern crate serde;
Expand All @@ -224,7 +230,7 @@ pub extern crate typenum;

#[cfg(all(
test,
any(feature = "f32", feature = "f64", feature = "complex32", feature = "complex64")
any(feature = "f32", feature = "f64", feature = "complex32", feature = "complex64", feature = "orderedf32", feature = "orderedf64", feature="notnanf32", feature="notnanf64")
))]
#[macro_use]
extern crate approx;
Expand Down Expand Up @@ -293,6 +299,15 @@ pub mod num {
pub mod complex {
pub use num_complex::*;
}

#[cfg(feature = "ordered-float-support")]
pub mod ordered_float {
pub use ordered_float::*;
pub type Orderedf32 = OrderedFloat<f32>;
pub type Orderedf64 = OrderedFloat<f64>;
pub type NotNanf32 = NotNan<f32>;
pub type NotNanf64 = NotNan<f64>;
}
}

/// Primitive traits and types representing basic properties of types.
Expand Down Expand Up @@ -697,6 +712,83 @@ storage_types! {
}
}


storage_types! {
types: OrderedFloat;

impl crate::Conversion<Self> for V {
type T = VV;

#[inline(always)]
fn constant(op: crate::ConstantOp) -> Self::T {
match op {
crate::ConstantOp::Add => -<Self::T as crate::num::Zero>::zero(),
crate::ConstantOp::Sub => <Self::T as crate::num::Zero>::zero(),
}
}

#[inline(always)]
fn conversion(&self) -> Self::T {
self.0
}
}

impl crate::ConversionFactor<V> for VV {
#[inline(always)]
fn powi(self, e: i32) -> Self {
<Self as crate::num::Float>::powi(self, e)
}

#[inline(always)]
fn value(self) -> V {
ordered_float::OrderedFloat::<VV>(self)
}
}

impl crate::ConstZero for V {
const ZERO: Self = ordered_float::OrderedFloat::<VV>(0.0);
}
}

storage_types! {
types: NotNan;

impl crate::Conversion<Self> for V {
type T = VV;

#[inline(always)]
fn constant(op: crate::ConstantOp) -> Self::T {
match op {
crate::ConstantOp::Add => -<Self::T as crate::num::Zero>::zero(),
crate::ConstantOp::Sub => <Self::T as crate::num::Zero>::zero(),
}
}

#[inline(always)]
fn conversion(&self) -> Self::T {
self.into_inner()
}
}

impl crate::ConversionFactor<V> for VV {
#[inline(always)]
fn powi(self, e: i32) -> Self {
<Self as crate::num::Float>::powi(self, e)
}

#[inline(always)]
fn value(self) -> V {
ordered_float::NotNan::new(self).unwrap()
}
}

// can't provide this since ::new().unwrap() is not const, but unsafe is forbidden.
//impl crate::ConstZero for V {
// const ZERO: Self = notnan_unwrap(ordered_float::NotNan::new(0.0));
//}

}

/// Utilities for formatting and printing quantities.
pub mod fmt {
/// An enum to specify the display style to use.
Expand Down
51 changes: 51 additions & 0 deletions src/storage_types.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,37 @@ macro_rules! storage_types {
pub type VV = f64;
$($tt)*));
};
(@type ($(#[$attr:meta])*) @$M:ident Orderedf32 ($($tt:tt)*)) => {
storage_type_orderedf32!(($(#[$attr])*) @$M (
/// Inner storage type.
#[allow(dead_code)]
pub type VV = f32;
$($tt)*));
};
(@type ($(#[$attr:meta])*) @$M:ident Orderedf64 ($($tt:tt)*)) => {
storage_type_orderedf64!(($(#[$attr])*) @$M (
/// Inner storage type.
#[allow(dead_code)]
pub type VV = f64;
$($tt)*));
};


(@type ($(#[$attr:meta])*) @$M:ident NotNanf32 ($($tt:tt)*)) => {
storage_type_notnanf32!(($(#[$attr])*) @$M (
/// Inner storage type.
#[allow(dead_code)]
pub type VV = f32;
$($tt)*));
};
(@type ($(#[$attr:meta])*) @$M:ident NotNanf64 ($($tt:tt)*)) => {
storage_type_notnanf64!(($(#[$attr])*) @$M (
/// Inner storage type.
#[allow(dead_code)]
pub type VV = f64;
$($tt)*));
};

(@type ($(#[$attr:meta])*) @$M:ident f32 ($($tt:tt)*)) => {
storage_type_f32!(($(#[$attr])*) @$M ($($tt)*));
};
Expand Down Expand Up @@ -142,6 +173,10 @@ macro_rules! storage_types {
storage_types!(@type ($(#[$attr])*) @$M BigRational ($($tt)*));
storage_types!(@type ($(#[$attr])*) @$M Complex32 ($($tt)*));
storage_types!(@type ($(#[$attr])*) @$M Complex64 ($($tt)*));
storage_types!(@type ($(#[$attr])*) @$M Orderedf32 ($($tt)*));
storage_types!(@type ($(#[$attr])*) @$M Orderedf64 ($($tt)*));
storage_types!(@type ($(#[$attr])*) @$M NotNanf32 ($($tt)*));
storage_types!(@type ($(#[$attr])*) @$M NotNanf64 ($($tt)*));
storage_types!(@type ($(#[$attr])*) @$M f32 ($($tt)*));
storage_types!(@type ($(#[$attr])*) @$M f64 ($($tt)*));
};
Expand Down Expand Up @@ -181,6 +216,10 @@ macro_rules! storage_types {
storage_types!(@type ($(#[$attr])*) @$M Rational32 ($($tt)*));
storage_types!(@type ($(#[$attr])*) @$M Rational64 ($($tt)*));
storage_types!(@type ($(#[$attr])*) @$M BigRational ($($tt)*));
storage_types!(@type ($(#[$attr])*) @$M Orderedf32 ($($tt)*));
storage_types!(@type ($(#[$attr])*) @$M Orderedf64 ($($tt)*));
storage_types!(@type ($(#[$attr])*) @$M NotNanf32 ($($tt)*));
storage_types!(@type ($(#[$attr])*) @$M NotNanf64 ($($tt)*));
storage_types!(@type ($(#[$attr])*) @$M f32 ($($tt)*));
storage_types!(@type ($(#[$attr])*) @$M f64 ($($tt)*));
};
Expand All @@ -197,6 +236,14 @@ macro_rules! storage_types {
storage_types!(@type ($(#[$attr])*) @$M Complex32 ($($tt)*));
storage_types!(@type ($(#[$attr])*) @$M Complex64 ($($tt)*));
};
(@type ($(#[$attr:meta])*) @$M:ident OrderedFloat ($($tt:tt)*)) => {
storage_types!(@type ($(#[$attr])*) @$M Orderedf32 ($($tt)*));
storage_types!(@type ($(#[$attr])*) @$M Orderedf64 ($($tt)*));
};
(@type ($(#[$attr:meta])*) @$M:ident NotNan ($($tt:tt)*)) => {
storage_types!(@type ($(#[$attr])*) @$M NotNanf32 ($($tt)*));
storage_types!(@type ($(#[$attr])*) @$M NotNanf64 ($($tt)*));
};
(@mod ($(#[$attr:meta])*) $M:ident, $V:ty; ($($tt:tt)*)) => {
$(#[$attr])*
mod $M {
Expand Down Expand Up @@ -268,6 +315,10 @@ storage_type_types! {
storage_type_bigrational!("bigrational", bigrational, $crate::num::BigRational);
storage_type_complex32!("complex32", complex32, $crate::num::complex::Complex32);
storage_type_complex64!("complex64", complex64, $crate::num::complex::Complex64);
storage_type_orderedf32!("orderedf32", orderedf32, $crate::num::ordered_float::Orderedf32);
storage_type_orderedf64!("orderedf64", orderedf64, $crate::num::ordered_float::Orderedf64);
storage_type_notnanf32!("notnanf32", notnanf32, $crate::num::ordered_float::NotNanf32);
storage_type_notnanf64!("notnanf64", notnanf64, $crate::num::ordered_float::NotNanf64);
storage_type_f32!("f32", f32, f32);
storage_type_f64!("f64", f64, f64);
}
Loading

0 comments on commit 75e0e26

Please sign in to comment.