working on adding sin_cos_pi
[vector-math.git] / src / traits.rs
index 7837bfe1a7a03f255e8bfae5bb6f64885f1fb555..6555016d98793e1c70b8715fe85e5f3f3a5878cf 100644 (file)
+use crate::{f16::F16, ieee754::FloatEncoding, scalar::Scalar};
 use core::ops::{
     Add, AddAssign, BitAnd, BitAndAssign, BitOr, BitOrAssign, BitXor, BitXorAssign, Div, DivAssign,
     Mul, MulAssign, Neg, Not, Rem, RemAssign, Shl, ShlAssign, Shr, ShrAssign, Sub, SubAssign,
 };
 
-use crate::f16::F16;
-
-#[rustfmt::skip] // work around for https://github.com/rust-lang/rustfmt/issues/4823
-macro_rules! make_float_type {
-    (
-        #[u32 = $u32:ident]
-        #[bool = $bool:ident]
-        [
-            $({
-                #[uint]
-                $uint_smaller:ident;
-                #[int]
-                $int_smaller:ident;
-                $(
-                    #[float]
-                    $float_smaller:ident;
-                )?
-            },)*
-        ],
-        {
-            #[uint]
-            $uint:ident;
-            #[int]
-            $int:ident;
-            #[float(prim = $float_prim:ident $(, scalar = $float_scalar:ident)?)]
-            $float:ident;
-        },
-        [
-            $({
-                #[uint]
-                $uint_larger:ident;
-                #[int]
-                $int_larger:ident;
-                $(
-                    #[float]
-                    $float_larger:ident;
-                )?
-            },)*
-        ]
-    ) => {
-        type $float: Float<Self::$u32, BitsType = Self::$uint>
-            $(+ From<Self::$float_scalar>)?
-            + Compare<Bool = Self::$bool>
-            + Make<Self, Prim = $float_prim>
-            $(+ ConvertTo<Self::$uint_smaller>)*
-            $(+ ConvertTo<Self::$int_smaller>)*
-            $($(+ ConvertTo<Self::$float_smaller>)?)*
-            + ConvertTo<Self::$uint>
-            + ConvertTo<Self::$int>
-            $(+ ConvertTo<Self::$uint_larger>)*
-            $(+ ConvertTo<Self::$int_larger>)*
-            $($(+ Into<Self::$float_larger> + ConvertTo<Self::$float_larger>)?)*;
-    };
-    (
-        #[u32 = $u32:ident]
-        #[bool = $bool:ident]
-        [$($smaller:tt,)*],
-        {
-            #[uint]
-            $uint:ident;
-            #[int]
-            $int:ident;
-        },
-        [$($larger:tt,)*]
-    ) => {};
-}
-
-#[rustfmt::skip] // work around for https://github.com/rust-lang/rustfmt/issues/4823
-macro_rules! make_uint_int_float_type {
-    (
-        #[u32 = $u32:ident]
-        #[bool = $bool:ident]
-        [
-            $({
-                #[uint($($uint_smaller_traits:tt)*)]
-                $uint_smaller:ident;
-                #[int($($int_smaller_traits:tt)*)]
-                $int_smaller:ident;
-                $(
-                    #[float($($float_smaller_traits:tt)*)]
-                    $float_smaller:ident;
-                )?
-            },)*
-        ],
-        {
-            #[uint(prim = $uint_prim:ident $(, scalar = $uint_scalar:ident)?)]
-            $uint:ident;
-            #[int(prim = $int_prim:ident $(, scalar = $int_scalar:ident)?)]
-            $int:ident;
-            $(
-                #[float(prim = $float_prim:ident $(, scalar = $float_scalar:ident)?)]
-                $float:ident;
-            )?
-        },
-        [
-            $({
-                #[uint($($uint_larger_traits:tt)*)]
-                $uint_larger:ident;
-                #[int($($int_larger_traits:tt)*)]
-                $int_larger:ident;
-                $(
-                    #[float($($float_larger_traits:tt)*)]
-                    $float_larger:ident;
-                )?
-            },)*
-        ]
-    ) => {
-        type $uint: UInt<Self::$u32>
-            $(+ From<Self::$uint_scalar>)?
-            + Compare<Bool = Self::$bool>
-            + Make<Self, Prim = $uint_prim>
-            $(+ ConvertTo<Self::$uint_smaller>)*
-            $(+ ConvertTo<Self::$int_smaller>)*
-            $($(+ ConvertTo<Self::$float_smaller>)?)*
-            + ConvertTo<Self::$int>
-            $(+ ConvertTo<Self::$float>)?
-            $(+ Into<Self::$uint_larger> + ConvertTo<Self::$uint_larger>)*
-            $(+ Into<Self::$int_larger> + ConvertTo<Self::$int_larger>)*
-            $($(+ Into<Self::$float_larger> + ConvertTo<Self::$float_larger>)?)*;
-        type $int: SInt<Self::$u32>
-            $(+ From<Self::$int_scalar>)?
-            + Compare<Bool = Self::$bool>
-            + Make<Self, Prim = $int_prim>
-            $(+ ConvertTo<Self::$uint_smaller>)*
-            $(+ ConvertTo<Self::$int_smaller>)*
-            $($(+ ConvertTo<Self::$float_smaller>)?)*
-            + ConvertTo<Self::$uint>
-            $(+ ConvertTo<Self::$float>)?
-            $(+ ConvertTo<Self::$uint_larger>)*
-            $(+ Into<Self::$int_larger> + ConvertTo<Self::$int_larger>)*
-            $($(+ Into<Self::$float_larger> + ConvertTo<Self::$float_larger>)?)*;
-        make_float_type! {
-            #[u32 = $u32]
-            #[bool = $bool]
-            [
-                $({
-                    #[uint]
-                    $uint_smaller;
-                    #[int]
-                    $int_smaller;
-                    $(
-                        #[float]
-                        $float_smaller;
-                    )?
-                },)*
-            ],
-            {
-                #[uint]
-                $uint;
-                #[int]
-                $int;
-                $(
-                    #[float(prim = $float_prim $(, scalar = $float_scalar)?)]
-                    $float;
-                )?
-            },
-            [
-                $({
-                    #[uint]
-                    $uint_larger;
-                    #[int]
-                    $int_larger;
-                    $(
-                        #[float]
-                        $float_larger;
-                    )?
-                },)*
-            ]
-        }
-    };
-}
-
-macro_rules! make_uint_int_float_types {
-    (
-        #[u32 = $u32:ident]
-        #[bool = $bool:ident]
-        [$($smaller:tt,)*],
-        $current:tt,
-        [$first_larger:tt, $($larger:tt,)*]
-    ) => {
-        make_uint_int_float_type! {
-            #[u32 = $u32]
-            #[bool = $bool]
-            [$($smaller,)*],
-            $current,
-            [$first_larger, $($larger,)*]
-        }
-        make_uint_int_float_types! {
-            #[u32 = $u32]
-            #[bool = $bool]
-            [$($smaller,)* $current,],
-            $first_larger,
-            [$($larger,)*]
-        }
-    };
-    (
-        #[u32 = $u32:ident]
-        #[bool = $bool:ident]
-        [$($smaller:tt,)*],
-        $current:tt,
-        []
-    ) => {
-        make_uint_int_float_type! {
-            #[u32 = $u32]
-            #[bool = $bool]
-            [$($smaller,)*],
-            $current,
-            []
-        }
-    };
-}
-
-#[rustfmt::skip] // work around for https://github.com/rust-lang/rustfmt/issues/4823
-macro_rules! make_types {
-    (
-        #[bool]
-        $(#[scalar = $ScalarBool:ident])?
-        type $Bool:ident;
-
-        #[u8]
-        $(#[scalar = $ScalarU8:ident])?
-        type $U8:ident;
-
-        #[u16]
-        $(#[scalar = $ScalarU16:ident])?
-        type $U16:ident;
-
-        #[u32]
-        $(#[scalar = $ScalarU32:ident])?
-        type $U32:ident;
-
-        #[u64]
-        $(#[scalar = $ScalarU64:ident])?
-        type $U64:ident;
-
-        #[i8]
-        $(#[scalar = $ScalarI8:ident])?
-        type $I8:ident;
-
-        #[i16]
-        $(#[scalar = $ScalarI16:ident])?
-        type $I16:ident;
-
-        #[i32]
-        $(#[scalar = $ScalarI32:ident])?
-        type $I32:ident;
-
-        #[i64]
-        $(#[scalar = $ScalarI64:ident])?
-        type $I64:ident;
-
-        #[f16]
-        $(#[scalar = $ScalarF16:ident])?
-        type $F16:ident;
-
-        #[f32]
-        $(#[scalar = $ScalarF32:ident])?
-        type $F32:ident;
-
-        #[f64]
-        $(#[scalar = $ScalarF64:ident])?
-        type $F64:ident;
-    ) => {
-        type $Bool: Bool
-            $(+ From<Self::$ScalarBool>)?
-            + Make<Self, Prim = bool>
-            + Select<Self::$Bool>;
-        make_uint_int_float_types! {
-            #[u32 = $U32]
-            #[bool = $Bool]
-            [],
-            {
-                #[uint(prim = u8 $(, scalar = $ScalarU8)?)]
-                $U8;
-                #[int(prim = i8 $(, scalar = $ScalarI8)?)]
-                $I8;
-            },
-            [
-                {
-                    #[uint(prim = u16 $(, scalar = $ScalarU16)?)]
-                    $U16;
-                    #[int(prim = i16 $(, scalar = $ScalarI16)?)]
-                    $I16;
-                    #[float(prim = F16 $(, scalar = $ScalarF16)?)]
-                    $F16;
-                },
-                {
-                    #[uint(prim = u32 $(, scalar = $ScalarU32)?)]
-                    $U32;
-                    #[int(prim = i32 $(, scalar = $ScalarI32)?)]
-                    $I32;
-                    #[float(prim = f32 $(, scalar = $ScalarF32)?)]
-                    $F32;
-                },
-                {
-                    #[uint(prim = u64 $(, scalar = $ScalarU64)?)]
-                    $U64;
-                    #[int(prim = i64 $(, scalar = $ScalarI64)?)]
-                    $I64;
-                    #[float(prim = f64 $(, scalar = $ScalarF64)?)]
-                    $F64;
-                },
-            ]
-        }
-    };
-}
-
 /// reference used to build IR for Kazan; an empty type for `core::simd`
 pub trait Context: Copy {
-    make_types! {
-        #[bool]
-        type Bool;
-
-        #[u8]
-        type U8;
-
-        #[u16]
-        type U16;
-
-        #[u32]
-        type U32;
-
-        #[u64]
-        type U64;
-
-        #[i8]
-        type I8;
-
-        #[i16]
-        type I16;
-
-        #[i32]
-        type I32;
-
-        #[i64]
-        type I64;
-
-        #[f16]
-        type F16;
-
-        #[f32]
-        type F32;
-
-        #[f64]
-        type F64;
-    }
-    make_types! {
-        #[bool]
-        #[scalar = Bool]
-        type VecBool;
-
-        #[u8]
-        #[scalar = U8]
-        type VecU8;
-
-        #[u16]
-        #[scalar = U16]
-        type VecU16;
-
-        #[u32]
-        #[scalar = U32]
-        type VecU32;
-
-        #[u64]
-        #[scalar = U64]
-        type VecU64;
-
-        #[i8]
-        #[scalar = I8]
-        type VecI8;
-
-        #[i16]
-        #[scalar = I16]
-        type VecI16;
-
-        #[i32]
-        #[scalar = I32]
-        type VecI32;
-
-        #[i64]
-        #[scalar = I64]
-        type VecI64;
-
-        #[f16]
-        #[scalar = F16]
-        type VecF16;
-
-        #[f32]
-        #[scalar = F32]
-        type VecF32;
-
-        #[f64]
-        #[scalar = F64]
-        type VecF64;
-    }
-    fn make<T: Make<Self>>(self, v: T::Prim) -> T {
+    vector_math_proc_macro::make_context_types!();
+    fn make<T: Make<Context = Self>>(self, v: T::Prim) -> T {
         T::make(self, v)
     }
 }
 
-pub trait Make<Context>: Sized {
-    type Prim;
-    fn make(ctx: Context, v: Self::Prim) -> Self;
+pub trait Make: Copy {
+    type Prim: Copy;
+    type Context: Context;
+    fn ctx(self) -> Self::Context;
+    fn make(ctx: Self::Context, v: Self::Prim) -> Self;
 }
 
 pub trait ConvertTo<T> {
     fn to(self) -> T;
 }
 
+impl<T> ConvertTo<T> for T {
+    fn to(self) -> T {
+        self
+    }
+}
+
 macro_rules! impl_convert_to_using_as {
-    ($($src:ident -> [$($dest:ident),*];)*) => {
-        $($(
-            impl ConvertTo<$dest> for $src {
-                fn to(self) -> $dest {
-                    self as $dest
+    ($first:ident $(, $ty:ident)*) => {
+        $(
+            impl ConvertTo<$first> for $ty {
+                fn to(self) -> $first {
+                    self as $first
                 }
             }
-        )*)*
-    };
-    ([$($src:ident),*] -> $dest:tt;) => {
-        impl_convert_to_using_as! {
-            $(
-                $src -> $dest;
-            )*
-        }
+            impl ConvertTo<$ty> for $first {
+                fn to(self) -> $ty {
+                    self as $ty
+                }
+            }
+        )*
+        impl_convert_to_using_as![$($ty),*];
     };
-    ([$($src:ident),*];) => {
-        impl_convert_to_using_as! {
-            [$($src),*] -> [$($src),*];
-        }
+    () => {
     };
 }
 
-impl_convert_to_using_as! {
-    [u8, i8, u16, i16, u32, i32, u64, i64, f32, f64];
-}
+impl_convert_to_using_as![u8, i8, u16, i16, u32, i32, u64, i64, f32, f64];
 
 pub trait Number:
     Compare
@@ -494,62 +105,153 @@ impl<T> BitOps for T where
 {
 }
 
-pub trait Int<ShiftRhs>:
-    Number
-    + BitOps
-    + Shl<ShiftRhs, Output = Self>
-    + Shr<ShiftRhs, Output = Self>
-    + ShlAssign<ShiftRhs>
-    + ShrAssign<ShiftRhs>
+pub trait Int:
+    Number + BitOps + Shl<Output = Self> + Shr<Output = Self> + ShlAssign + ShrAssign
 {
+    fn leading_zeros(self) -> Self;
+    fn leading_ones(self) -> Self {
+        self.not().leading_zeros()
+    }
+    fn trailing_zeros(self) -> Self;
+    fn trailing_ones(self) -> Self {
+        self.not().trailing_zeros()
+    }
+    fn count_zeros(self) -> Self {
+        self.not().count_ones()
+    }
+    fn count_ones(self) -> Self;
 }
 
-pub trait UInt<ShiftRhs>: Int<ShiftRhs> {}
+pub trait UInt: Int {}
+
+pub trait SInt: Int + Neg<Output = Self> {}
 
-pub trait SInt<ShiftRhs>: Int<ShiftRhs> + Neg<Output = Self> {}
+macro_rules! impl_int {
+    ($ty:ident) => {
+        impl Int for $ty {
+            fn leading_zeros(self) -> Self {
+                self.leading_zeros() as Self
+            }
+            fn leading_ones(self) -> Self {
+                self.leading_ones() as Self
+            }
+            fn trailing_zeros(self) -> Self {
+                self.trailing_zeros() as Self
+            }
+            fn trailing_ones(self) -> Self {
+                self.trailing_ones() as Self
+            }
+            fn count_zeros(self) -> Self {
+                self.count_zeros() as Self
+            }
+            fn count_ones(self) -> Self {
+                self.count_ones() as Self
+            }
+        }
+    };
+}
 
 macro_rules! impl_uint {
     ($($ty:ident),*) => {
         $(
-            impl Int<u32> for $ty {}
-            impl UInt<u32> for $ty {}
+            impl_int!($ty);
+            impl UInt for $ty {}
         )*
     };
 }
 
 impl_uint![u8, u16, u32, u64];
 
-macro_rules! impl_int {
+macro_rules! impl_sint {
     ($($ty:ident),*) => {
         $(
-            impl Int<u32> for $ty {}
-            impl SInt<u32> for $ty {}
+            impl_int!($ty);
+            impl SInt for $ty {}
         )*
     };
 }
 
-impl_int![i8, i16, i32, i64];
-
-pub trait Float<BitsShiftRhs>: Number + Neg<Output = Self> {
-    type BitsType: UInt<BitsShiftRhs>;
+impl_sint![i8, i16, i32, i64];
+
+pub trait Float: Number + Neg<Output = Self> {
+    type FloatEncoding: FloatEncoding + Make<Context = Scalar, Prim = <Self as Make>::Prim>;
+    type BitsType: UInt
+        + Make<Context = Self::Context, Prim = <Self::FloatEncoding as Float>::BitsType>
+        + ConvertTo<Self::SignedBitsType>
+        + Compare<Bool = Self::Bool>;
+    type SignedBitsType: SInt
+        + Make<Context = Self::Context, Prim = <Self::FloatEncoding as Float>::SignedBitsType>
+        + ConvertTo<Self::BitsType>
+        + Compare<Bool = Self::Bool>;
     fn abs(self) -> Self;
     fn trunc(self) -> Self;
     fn ceil(self) -> Self;
     fn floor(self) -> Self;
+    /// round to nearest integer, unspecified which way half-way cases are rounded
     fn round(self) -> Self;
+    /// returns `self * a + b` but only rounding once
     #[cfg(feature = "fma")]
     fn fma(self, a: Self, b: Self) -> Self;
-    fn is_nan(self) -> Self::Bool;
-    fn is_infinite(self) -> Self::Bool;
+    /// returns `self * a + b` either using `fma` or `self * a + b`
+    fn mul_add_fast(self, a: Self, b: Self) -> Self {
+        #[cfg(feature = "fma")]
+        return self.fma(a, b);
+        #[cfg(not(feature = "fma"))]
+        return self * a + b;
+    }
+    fn is_nan(self) -> Self::Bool {
+        self.ne(self)
+    }
+    fn is_infinite(self) -> Self::Bool {
+        self.abs().eq(Self::infinity(self.ctx()))
+    }
+    fn infinity(ctx: Self::Context) -> Self {
+        Self::from_bits(ctx.make(Self::FloatEncoding::INFINITY_BITS))
+    }
+    fn nan(ctx: Self::Context) -> Self {
+        Self::from_bits(ctx.make(Self::FloatEncoding::NAN_BITS))
+    }
     fn is_finite(self) -> Self::Bool;
+    fn is_zero_or_subnormal(self) -> Self::Bool {
+        self.extract_exponent_field().eq(self
+            .ctx()
+            .make(Self::FloatEncoding::ZERO_SUBNORMAL_EXPONENT))
+    }
     fn from_bits(v: Self::BitsType) -> Self;
     fn to_bits(self) -> Self::BitsType;
+    fn extract_exponent_field(self) -> Self::BitsType {
+        let mask = self.ctx().make(Self::FloatEncoding::EXPONENT_FIELD_MASK);
+        let shift = self.ctx().make(Self::FloatEncoding::EXPONENT_FIELD_SHIFT);
+        (self.to_bits() & mask) >> shift
+    }
+    fn extract_exponent_unbiased(self) -> Self::SignedBitsType {
+        Self::sub_exponent_bias(self.extract_exponent_field())
+    }
+    fn extract_mantissa_field(self) -> Self::BitsType {
+        let mask = self.ctx().make(Self::FloatEncoding::MANTISSA_FIELD_MASK);
+        self.to_bits() & mask
+    }
+    fn sub_exponent_bias(exponent_field: Self::BitsType) -> Self::SignedBitsType {
+        exponent_field.to()
+            - exponent_field
+                .ctx()
+                .make(Self::FloatEncoding::EXPONENT_BIAS_SIGNED)
+    }
+    fn add_exponent_bias(exponent: Self::SignedBitsType) -> Self::BitsType {
+        (exponent
+            + exponent
+                .ctx()
+                .make(Self::FloatEncoding::EXPONENT_BIAS_SIGNED))
+        .to()
+    }
 }
 
 macro_rules! impl_float {
-    ($ty:ty, $bits:ty) => {
-        impl Float<u32> for $ty {
+    ($ty:ty, $bits:ty, $signed_bits:ty) => {
+        impl Float for $ty {
+            type FloatEncoding = $ty;
             type BitsType = $bits;
+            type SignedBitsType = $signed_bits;
             fn abs(self) -> Self {
                 #[cfg(feature = "std")]
                 return self.abs();
@@ -603,10 +305,10 @@ macro_rules! impl_float {
     };
 }
 
-impl_float!(f32, u32);
-impl_float!(f64, u64);
+impl_float!(f32, u32, i32);
+impl_float!(f64, u64, i64);
 
-pub trait Bool: BitOps {}
+pub trait Bool: Make + BitOps {}
 
 impl Bool for bool {}
 
@@ -623,7 +325,7 @@ impl<T> Select<T> for bool {
         }
     }
 }
-pub trait Compare: Copy {
+pub trait Compare: Make {
     type Bool: Bool + Select<Self>;
     fn eq(self, rhs: Self) -> Self::Bool;
     fn ne(self, rhs: Self) -> Self::Bool;
@@ -661,4 +363,4 @@ macro_rules! impl_compare_using_partial_cmp {
     };
 }
 
-impl_compare_using_partial_cmp![u8, i8, u16, i16, F16, u32, i32, f32, u64, i64, f64];
+impl_compare_using_partial_cmp![bool, u8, i8, u16, i16, F16, u32, i32, f32, u64, i64, f64];