package hardcaml

  1. Overview
  2. Docs
package hardcaml
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Bits_list.Int_combSource

Uses 0,1 as the bit type.

include Comb.S with type t = Base.int Base.list
Sourceval sexp_of_t : t -> Sexplib0.Sexp.t
include Base.Equal.S with type t := t
Sourceval empty : t

the empty signal

Sourceval is_empty : t -> Base.bool
Sourceval (--) : t -> Base.string -> t

names a signal

let a = a -- "a" in ...

signals may have multiple names.

Sourceval width : t -> Base.int

returns the width (number of bits) of a signal.

let w = width s in ...

Sourceval address_bits_for : Base.int -> Base.int

addess_bits_for num_elements returns the address width required to index num_elements.

It is the same as Int.ceil_log2, except it wll return a minimum value of 1 (since you cannot have 0 width vectors). Raises if num_elements is < 0.

Sourceval num_bits_to_represent : Base.int -> Base.int

num_bits_to_represent x returns the number of bits required to represent the number x, which should be >= 0.

Sourceval of_constant : Constant.t -> t
Sourceval to_constant : t -> Constant.t
Sourceval of_bit_string : Base.string -> t

convert binary string to constant

Sourceval of_int : width:Base.int -> Base.int -> t

convert integer to constant

Sourceval of_int32 : width:Base.int -> Base.int32 -> t
Sourceval of_int64 : width:Base.int -> Base.int64 -> t
Sourceval of_hex : ?signedness:Signedness.t -> width:Base.int -> Base.string -> t

convert hex string to a constant. If the target width is greater than the hex length and signedness is Signed then the result is sign extended. Otherwise the result is zero padded.

Sourceval of_octal : ?signedness:Signedness.t -> width:Base.int -> Base.string -> t

convert octal string to a constant. If the target width is greater than the octal length and signedness is Signed then the result is sign extended. Otherwise the result is zero padded.

Sourceval of_z : width:Base.int -> Z.t -> t

Convert an arbitrarily wide integer value to a constant.

Sourceval of_string : Base.string -> t

convert verilog style or binary string to constant

Sourceval of_bit_list : Base.int Base.list -> t

convert IntbitsList to constant

Sourceval of_decimal_string : width:Base.int -> Base.string -> t
Sourceval of_char : Base.char -> t

convert a char to an 8 bit constant

Sourceval of_bool : Base.bool -> t

convert a bool to vdd or gnd

Sourceval to_z : t -> signedness:Signedness.t -> Z.t

Convert bits to a Zarith.t

Sourceval concat_msb : t Base.list -> t

concat ts concatenates a list of signals - the msb of the head of the list will become the msb of the result.

let c = concat [ a; b; c ] in ...

concat raises if ts is empty or if any t in ts is empty.

Sourceval concat_lsb : t Base.list -> t

Similar to concat_msb except the lsb of the head of the list will become the lsb of the result.

Sourceval concat_msb_e : t Base.list -> t

same as concat_msb except empty signals are first filtered out

Sourceval concat_lsb_e : t Base.list -> t

same as concat_lsb except empty signals are first filtered out

Sourceval (@:) : t -> t -> t

concatenate two signals.

let c = a @: b in ...

equivalent to concat [ a; b ]

Sourceval vdd : t

logic 1

Sourceval is_vdd : t -> Base.bool
Sourceval gnd : t

logic 0

Sourceval is_gnd : t -> Base.bool
Sourceval zero : Base.int -> t

zero w makes a the zero valued constant of width w

Sourceval ones : Base.int -> t

ones w makes a constant of all ones of width w

Sourceval one : Base.int -> t

one w makes a one valued constant of width w

Sourceval select : t -> Base.int -> Base.int -> t

select t hi lo selects from t bits in the range hi...lo, inclusive. select raises unless hi and lo fall within 0 .. width t - 1 and hi >= lo.

Sourceval select_e : t -> Base.int -> Base.int -> t

same as select except invalid indices return empty

Sourceval bit : t -> Base.int -> t

select a single bit

Sourceval msb : t -> t

get most significant bit

Sourceval lsbs : t -> t

get least significant bits

Sourceval lsb : t -> t

get least significant bit

Sourceval msbs : t -> t

get most significant bits

Sourceval drop_bottom : t -> Base.int -> t

drop_bottom s n drop bottom n bits of s

Sourceval drop_top : t -> Base.int -> t

drop_top s n drop top n bits of s

Sourceval sel_bottom : t -> Base.int -> t

sel_bottom s n select bottom n bits of s

Sourceval sel_top : t -> Base.int -> t

sel_top s n select top n bits of s

Sourceval (.:[]) : t -> (Base.int * Base.int) -> t

x.:[hi, lo] == select x hi lo

Sourceval (.:+[]) : t -> (Base.int * Base.int Base.option) -> t

x.:+[lo, width] == select x (lo + width - 1) lo. If width is None it selects all remaining msbs of the vector ie x.:+[lo,None] == drop_bottom x lo

Sourceval (.:-[]) : t -> (Base.int Base.option * Base.int) -> t

x.:-[hi, width] == select x hi (hi - width + 1). If hi is None it defaults to the msb of the vector ie x.:-[None, width] == sel_top x width

Sourceval (.:()) : t -> Base.int -> t

x.(i) == bit x i

Sourceval insert : into:t -> t -> at_offset:Base.int -> t

insert ~into:t x ~at_offset insert x into t at given offet

Sourceval mux : t -> t Base.list -> t

multiplexer.

let m = mux sel inputs in ...

Given l = List.length inputs and w = width sel the following conditions must hold.

l <= 2**w, l >= 2

If l < 2**w, the last input is repeated.

All inputs provided must have the same width, which will in turn be equal to the width of m.

Sourceval mux2 : t -> t -> t -> t

mux2 c t f 2 input multiplexer. Selects t if c is high otherwise f.

t and f must have same width and c must be 1 bit.

Equivalent to mux c [f; t]

Sourceval mux_init : t -> Base.int -> f:(Base.int -> t) -> t
Sourceval (&:) : t -> t -> t

logical and

Sourceval (&:.) : t -> Base.int -> t
Sourceval (&&:) : t -> t -> t

a <>:. 0 &: b <>:. 0

Sourceval (|:) : t -> t -> t

logical or

Sourceval (|:.) : t -> Base.int -> t
Sourceval (||:) : t -> t -> t

a <>:. 0 |: b <>:. 0

Sourceval (^:) : t -> t -> t

logic xor

Sourceval (^:.) : t -> Base.int -> t
Sourceval (~:) : t -> t

logical not

Sourceval (+:) : t -> t -> t

addition

Sourceval (+:.) : t -> Base.int -> t
Sourceval (-:) : t -> t -> t

subtraction

Sourceval (-:.) : t -> Base.int -> t
Sourceval negate : t -> t

negation

Sourceval (*:) : t -> t -> t

unsigned multiplication

Sourceval (*+) : t -> t -> t

signed multiplication

Sourceval (==:) : t -> t -> t

equality

Sourceval (==:.) : t -> Base.int -> t
Sourceval (<>:) : t -> t -> t

inequality

Sourceval (<>:.) : t -> Base.int -> t
Sourceval (<:) : t -> t -> t

less than

Sourceval (<:.) : t -> Base.int -> t
Sourceval lt : t -> t -> t
Sourceval (>:) : t -> t -> t

greater than

Sourceval (>:.) : t -> Base.int -> t
Sourceval (<=:) : t -> t -> t

less than or equal to

Sourceval (<=:.) : t -> Base.int -> t
Sourceval (>=:) : t -> t -> t

greater than or equal to

Sourceval (>=:.) : t -> Base.int -> t
Sourceval (<+) : t -> t -> t

signed less than

Sourceval (<+.) : t -> Base.int -> t
Sourceval (>+) : t -> t -> t

signed greater than

Sourceval (>+.) : t -> Base.int -> t
Sourceval (<=+) : t -> t -> t

signed less than or equal to

Sourceval (<=+.) : t -> Base.int -> t
Sourceval (>=+) : t -> t -> t

signed greated than or equal to

Sourceval (>=+.) : t -> Base.int -> t
Sourceval (-->:) : t -> t -> t

Propositional logic implication operator

Sourceval to_string : t -> Base.string

create string from signal

Sourceval to_int : t -> Base.int

to_int t treats t as unsigned and resizes it to fit exactly within an OCaml Int.t.

  • If width t > Int.num_bits then the upper bits are truncated.
  • If width t >= Int.num_bits and bit t (Int.num_bits-1) = vdd (i.e. the msb of the resulting Int.t is set), then the result is negative.
  • If t is Signal.t and not a constant value, an exception is raised.
Sourceval to_sint : t -> Base.int

to_sint t treats t as signed and resizes it to fit exactly within an OCaml Int.t.

  • If width t > Int.num_bits then the upper bits are truncated.
  • If t is Signal.t and not a constant value, an exception is raised.
Sourceval to_int32 : t -> Base.int32
Sourceval to_sint32 : t -> Base.int32
Sourceval to_int64 : t -> Base.int64
Sourceval to_sint64 : t -> Base.int64
Sourceval to_bool : t -> Base.bool
Sourceval to_char : t -> Base.char

Convert signal to a char. The signal must be 8 bits wide.

Sourceval to_bstr : t -> Base.string

create binary string from signal

Sourceval bits_msb : t -> t Base.list

convert signal to a list of bits with msb at head of list

Sourceval bits_lsb : t -> t Base.list

convert signal to a list of bits with lsb at head of list

Sourceval to_array : t -> t Base.array

to_array s convert signal s to array of bits with lsb at index 0

Sourceval of_array : t Base.array -> t

of_array a convert array a of bits to signal with lsb at index 0

Sourceval repeat : t -> Base.int -> t

repeat signal n times

Sourceval split_in_half_msb : ?msbs:Base.int -> t -> t * t

Split signal in half. The most significant bits will be in the left half of the returned tuple.

  • If msbs is not provided, the signal will be split in half with the MSB part possibly containing one more bit.
  • If msbs is provided, msbs most significant bits will be split off.
Sourceval split_in_half_lsb : ?lsbs:Base.int -> t -> t * t

Same as split_in_half_msb, but

  • If lsbs is not provided, the LSB part might have one more bit.
  • If lsbs is provided, lsbs least significant bits will be split off.

The most significant bits will still be in the left half of the tuple.

Sourceval split_lsb : ?exact:Base.bool -> part_width:Base.int -> t -> t Base.list

Split signal into a list of signals with width equal to part_width. The least significant bits are at the head of the returned list. If exact is true the input signal width must be exactly divisable by part_width. When exact is false and the input signal width is not exactly divisible by part_width, the last element will contains residual bits.

eg:

  split_lsb ~part_width:4 16b0001_0010_0011_0100 =
    [ 4b0100; 4b0011; 4b0010; 4b0001 ]

  split_lsb ~exact:false ~part_width:4 17b11_0001_0010_0011_0100 =
    [ 4b0100; 4b0011; 4b0010; 4b0001; 2b11 ]
Sourceval split_msb : ?exact:Base.bool -> part_width:Base.int -> t -> t Base.list

Like split_lsb except the most significant bits are at the head of the returned list. Residual bits when exact is false goes to the last element of the list, so in the general case split_lsb is not necessarily equivalent to split_msb |> List.rev.

Sourceval bswap : t -> t
Sourceval sll : t -> Base.int -> t

shift left logical

Sourceval srl : t -> Base.int -> t

shift right logical

Sourceval sra : t -> Base.int -> t

shift right arithmetic

Sourceval rotl : t -> Base.int -> t

rotate left

Sourceval rotr : t -> Base.int -> t

rotate right

Sourceval log_shift : (t -> Base.int -> t) -> t -> t -> t

shift by variable amount

Sourceval uresize : t -> Base.int -> t

uresize t w returns the unsigned resize of t to width w. If w = width t, this is a no-op. If w < width t, this selects the w low bits of t. If w > width t, this extends t with zero (w - width t).

Sourceval sresize : t -> Base.int -> t

sresize t w returns the signed resize of t to width w. If w = width t, this is a no-op. If w < width t, this selects the w low bits of t. If w > width t, this extends t with w - width t copies of msb t.

Sourceval ue : t -> t

unsigned resize by +1 bit

Sourceval se : t -> t

signed resize by +1 bit

Sourceval resize_list : resize:(t -> Base.int -> t) -> t Base.list -> t Base.list

resize_list ?resize l finds the maximum width in l and applies resize el max to each element.

Sourceval resize_op2 : resize:(t -> Base.int -> t) -> (t -> t -> t) -> t -> t -> t

resize_op2 ~resize f a b applies resize x w to a and b where w is the maximum of their widths. It then returns f a b

Sourceval reduce : f:('a -> 'a -> 'a) -> 'a Base.list -> 'a

fold 'op' though list

Sourceval reverse : t -> t

reverse bits

Sourceval mod_counter : max:Base.int -> t -> t

mod_counter max t is if t = max then 0 else (t + 1), and can be used to count from 0 to max then from zero again. If max == (1<<n - 1), then a comparator is not generated and overflow arithmetic is used instead.

Sourceval compute_arity : steps:Base.int -> Base.int -> Base.int

compute_arity ~steps num_values computes the tree arity required to reduce num_values in steps. steps<=0 raises.

Sourceval compute_tree_branches : steps:Base.int -> Base.int -> Base.int Base.list

compute_tree_branches ~steps num_values returns a list of length steps of branching factors required to reduce num_values. This tends to produce a slightly more balanced sequence than just applying compute_arity at every step.

Sourceval tree : arity:Base.int -> f:('a Base.list -> 'a) -> 'a Base.list -> 'a

tree ~arity ~f input creates a tree of operations. The arity of the operator is configurable. tree raises if input = [].

Sourceval priority_select : ?branching_factor:Base.int -> (t, t) Hardcaml__.Comb_intf.with_valid2 Base.list -> (t, t) Hardcaml__.Comb_intf.with_valid2

priority_select cases returns the value associated with the first case whose valid signal is high. valid will be set low in the returned with_valid if no case is selected.

Sourceval priority_select_with_default : ?branching_factor:Base.int -> (t, t) Hardcaml__.Comb_intf.with_valid2 Base.list -> default:t -> t

Same as priority_select except returns default if no case matches.

Sourceval onehot_select : ?branching_factor:Base.int -> (t, t) Hardcaml__.Comb_intf.with_valid2 Base.list -> t

Select a case where one and only one valid signal is enabled. If more than one case is valid then the return value is undefined. If no cases are valid, 0 is returned by the current implementation, though this should not be relied upon.

Sourceval popcount : ?branching_factor:Base.int -> t -> t

popcount t returns the number of bits set in t.

Sourceval is_pow2 : ?branching_factor:Base.int -> t -> t

is_pow2 t returns a bit to indicate if t is a power of 2.

Sourceval leading_ones : ?branching_factor:Base.int -> t -> t

leading_ones t returns the number of consecutive 1s from the most significant bit of t down.

Sourceval trailing_ones : ?branching_factor:Base.int -> t -> t

trailing_ones t returns the number of consecutive 1s from the least significant bit of t up.

Sourceval leading_zeros : ?branching_factor:Base.int -> t -> t

leading_zeros t returns the number of consecutive 0s from the most significant bit of t down.

Sourceval trailing_zeros : ?branching_factor:Base.int -> t -> t

trailing_zeros t returns the number of consecutive 0s from the least significant bit of t up.

Sourceval floor_log2 : ?branching_factor:Base.int -> t -> (t, t) Hardcaml__.Comb_intf.with_valid2

floor_log2 x returns the floor of log-base-2 of x. x is treated as unsigned and an error is indicated by valid = gnd in the return value if x = 0.

Sourceval ceil_log2 : ?branching_factor:Base.int -> t -> (t, t) Hardcaml__.Comb_intf.with_valid2

ceil_log2 x returns the ceiling of log-base-2 of x. x is treated as unsigned and an error is indicated by valid = gnd in the return value if x = 0.

Sourceval binary_to_onehot : t -> t

convert binary to onehot

Sourceval onehot_to_binary : t -> t

convert onehot to binary

Sourceval binary_to_gray : t -> t

convert binary to gray code

Sourceval gray_to_binary : t -> t

convert gray code to binary

Sourceval random : width:Base.int -> t

create random constant vector of given width

Sourcemodule type Typed_math = sig ... end

Unsigned vectors.

Signed vectors.

Sourcemodule Uop : Typed_math with type v := t

Unsigned vector operations (ie may operate on Bits.t or Signal.t directly).

Sourcemodule Sop : Typed_math with type v := t

Signed vector operations (ie may operate on Bits.t or Signal.t directly).

Sourceval t_of_sexp : Base.Sexp.t -> t
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct