developer.md

DocTestSetup = quote
	using Random
    using MicroFloatingPoints
	using MicroFloatingPoints.MFPPlot, MicroFloatingPoints.MFPRandom
end
CurrentModule = MicroFloatingPoints

Developer Documentation

This part is intended for developers who intend to extend or maintain the package.

!!! warning "Work In Progress" This part is a work in progress and should be expanded in the next revisions.

Construction of a Floatmu

The Floatmu type has two constructors that create a float directly from its integer representation.

Floatmu{szE,szf}(x::UInt32, dummy) where {szE,szf}
Floatmu{szE,szf}(x::Tuple{UInt32,Int64}, dummy) where {szE,szf}

The first constructor uses x as the internal representation of the float, assuming no rounding occurred; the second constructor uses the UInt32 element of the tuple as the internal representation , while the Int64 element correspond to the sign of the error if some rounding took place to generate the float.

For both constructors, dummy may be anything and serves only to avoid ambiguities when calling a constructor. It is customary to use nothing for this parameter and the code of the package always does.

nb_fp_numbers(a::Floatmu{szE,szf}, b::Floatmu{szE,szf}) where {szE,szf}
MicroFloatingPoints.inexact_flag
MicroFloatingPoints.double_fields(x::Float64)
MicroFloatingPoints.roundfrac(f,szf)
MicroFloatingPoints.float64_to_uint32mu(x::Float64,szE,szf)

Iterators

check_eligibility_step(start::Floatmu{szE,szf}, stop::Floatmu{szE,szf}, step::Floatmu{szE,szf}) where {szE,szf}

The MicroFloatingPoints.MFPRandom module

CurrentModule = MicroFloatingPoints.MFPRandom

using Random

MicroFloatingPoints.MFPRandom.irandint(rng::Random.AbstractRNG, n::Int64)

Examples

julia> MicroFloatingPoints.MFPRandom.irandint(Random.MersenneTwister(42),23)