hardcaml_fixed_point

Hardcaml fixed point arithmetic
README

hardcaml_fixed_point

A simple fixed point library for Hardcaml.

Numbers are represented in a [I.F] format which provides [I] integer
bits and [F] fractional bits. We require [I>0] and [F>=0].

Seperate modules for Signed and Unsigned fixed point numbers are
implemented.

The basic arithmetic operators are provided which ensure no overflow
is possible and track precision.

Comparisions do not require the same precision for each argument.

The most important function is [resize]. This can increase or decrease
[I] and [F]. When increasing appropriate padding is performed. When
decreasing [I] the result can either [saturate] or [wrap]. When
decreasing [F] a rounding function can be specified:

  • neg_infinity

  • pos_infinity

  • to_zero

  • away_from_zero

  • tie_to_neg_infinity

  • tie_to_pos_infinity

  • tie_to_zero

  • tie_away_from_zero

  • tie_to_nearest_even

  • tie_to_nearest_odd

Note that [wrap] along with rounding to [neg_infinity] is effectively
just truncating the top and bottom bits and uses no hardware.

Install
Sources
hardcaml_fixed_point-v0.15.0.tar.gz
sha256=aac72d5a89d3a93147781c248436d29db5ee86c93e0fc6c92bab5e0011dde910
Dependencies
dune
>= "2.0.0"
ppx_jane
>= "v0.15" & < "v0.16"
hardcaml
>= "v0.15" & < "v0.16"
base
>= "v0.15" & < "v0.16"
ocaml
>= "4.08.0"
Reverse Dependencies