Added doc for fractional_even

Author: goualard-f

docs/src/manual.md

@@ -142,6 +142,12 @@ maxintfloat(::Type{Floatmu{szE,szf}})  where {szE,szf}
 
 ```
 
+Lastly, some methods test properties on the different parts of a `Floatmu`:
+
+```@docs
+fractional_even(x::Floatmu{szE,szf}) where {szE,szf}
+```
+
 ### Tests 
 
 ```@docs

src/Floatmu.jl

@@ -208,6 +208,19 @@ Emax(::Type{Floatmu{szE,szf}}) where {szE, szf} = UInt32(2^(UInt32(szE)-1)-1)
 exponent_max(::Type{Floatmu{szE,szf}}) where {szE, szf} = Int64(Emax(Floatmu{szE,szf}))
 exponent_raw_max(::Type{Floatmu{szE,szf}}) where {szE, szf} = Int64(exponent_mask(Floatmu{szE,szf}) >> szf)
 
+
+"""
+    fractional_even(x::Floatmu{szE,szf}) where {szE,szf}
+
+Return `true` if the fractional part of `x` has a zero as the rightmost bit.
+
+BEWARE: the function does not check whether `x` is an NaN or an infinite value.
+"""
+function fractional_even(x::Floatmu{szE,szf}) where {szE,szf}
+    return (x.v & 1) == 0
+end
+
+
 """
     Emin(::Type{Floatmu{szE,szf}}) where {szE, szf}
 

src/MFPUtils.jl

@@ -22,7 +22,7 @@ module MFPUtils
 
 import ..MicroFloatingPoints: Floatmu
 
-export vertical_popcount, fractional_even
+export vertical_popcount
 
 """
     vertical_popcount(T::Vector{Floatmu{szE,szf}}) where {szE,szf}
@@ -59,15 +59,4 @@ function vertical_popcount(T::Vector{Floatmu{szE,szf}}) where {szE,szf}
     return count
 end
 
-"""
-    fractional_even(x::Floatmu{szE,szf}) where {szE,szf}
-
-Return `true` if the fractional part of `x` has a zero as the rightmost bit.
-
-BEWARE: the function does not check whether `x` is an NaN or an infinite value.
-"""
-function fractional_even(x::Floatmu{szE,szf}) where {szE,szf}
-    return (x.v & 1) == 0
-end
-
 end # Module

src/MicroFloatingPoints.jl

@@ -26,6 +26,7 @@ export FloatmuIterator
 export isinexact, errorsign, reset_inexact, inexact
 export Emax, Emin, nb_fp_numbers, bias
 export eligible_step
+export fractional_even
 
 include("Floatmu.jl")