Module LibCircuit.LimbsSource

This module is a more generic version of Bytes, where each scalar stores an nb_bits-bit number.

Parameters

module N : sig ... end

Signature

Sourcetype 'a input = 'a Input.t

Input for a Plompiler program.

Sourcetype scalar = scalar

Element of the native scalar field.

Sourcetype 'a repr = 'a repr

Representation of values.

Sourcetype 'a t = 'a t

Plompiler program.

Sourcetype tl = scalar list

Representation of elements.

Sourceval input_bytes : le:bool -> bytes -> tl input

input_bytes ~le b returns the representation of b that Plompiler expects as input. le can be used to set the endianness.

Sourceval constant : le:bool -> bytes -> tl repr t

constant ~le b returns the constant b as a Plompiler value. le can be used to set the endianness.

Sourceval of_scalar : total_nb_bits:int -> scalar repr -> tl repr t

of_scalar ~total_nb_bits b converts the scalar b of size total_nb_bits in bits into the tl representation.

Sourceval to_scalar : tl repr -> scalar repr t

to_scalar b return the scalar representing the value b.

Sourceval of_bool_list : bool list repr -> tl repr t

of_bool_list b converts the list of bits in little-endian order into the tl representation.

Sourceval to_bool_list : tl repr -> bool list repr t

to_bool_list b returns the list of bits in little-endian order, representing the value b.

Sourceval xor : tl repr -> tl repr -> tl repr t

xor a b returns the exclusive disjunction of a and b.

Sourceval band : tl repr -> tl repr -> tl repr t

band a b returns the conjunction of a and b.

Sourceval not : tl repr -> tl repr t

not b returns the negation of b.

Sourceval rotate_right : tl repr -> int -> tl repr t

rotate_right b n shifts the bits right by n positions, so that each bit is less significant. The least significant bit becomes the most significant i.e. it is "rotated". rotate_right bs (length bl) = bl

Sourceval shift_right : tl repr -> int -> tl repr t

shift_right b n shifts all bits right by n positions, so that each bit is less significant. The least signigicant bit is lost and the most significant bit is set to zero. More precisely, if we interpret the b as an integer, shift_right b n = b / 2^n