package octez-libs

  1. Overview
  2. Docs
A package that contains multiple base libraries used by the Octez suite

Install 

dune-project
 Dependency

www.tezos.com Readme Edit opam file Versions (5)

Authors

  1. T
    Tezos devteam

Maintainers

  1. C
    contact@tezos.com

Sources

octez-19.0.tar.gz
sha256=c6df840ebbf115e454db949028c595bec558a59a66cade73b52a6d099d6fa4d4
sha512=d8aee903b9fe130d73176bc8ec38b78c9ff65317da3cb4f3415f09af0c625b4384e7498201fdb61aa39086a7d5d409d0ab3423f9bc3ab989a680cf444a79bc13

doc/octez-libs.bls12-381-polynomial/Octez_bls12_381_polynomial/G1_carray/index.html

Module Octez_bls12_381_polynomial.G1_carraySource

Sourcetype t
Sourceval t : t Repr.t
Sourceval empty : t
Sourceval allocate : int -> t

allocate len creates a C array of size len initialized with zeros.

Sourceval init : int -> (int -> elt) -> t

init n f returns a fresh C array of length n, with element number i initialized to the result of f i.

Sourceval degree : t -> int

degree p returns the index of the last non-zero element of p. Returns -1 if all elements of p are zero.

Sourceval erase : t -> int -> unit

erase p n fills with zeros the first n elements of p.

Sourceval length : t -> int

length c returns the length of a C array c

Sourceval get : t -> int -> elt

get c i returns the i-th element of a C array c

Sourceval get_inplace : t -> int -> elt -> unit

get_inplace c i res copies the i-th element of a C array c in res

Sourceval iter_copy_elt : (elt -> unit) -> t -> unit

iter_copy_elt f a applies function f in turn to a **copy** of all the elements of a. It is equivalent to f a.(0); f a.(1); ...; f a.(length a - 1); ().

Sourceval iteri_copy_elt : (int -> elt -> unit) -> t -> unit

Same as iter_copy_elt, but the function is applied to the index of the element as first argument, and a **copy** of the element itself as second argument.

Sourceval set : t -> elt -> int -> unit
Sourceval copy : ?offset:int -> ?len:int -> t -> t

copy c copies len elements from a C array c starting from position offset

Sourceval blit : t -> src_off:int -> t -> dst_off:int -> len:int -> unit

blit src src_off dst dst_off len copies len elements from src to dst starting at the respective offsets.

Sourceval equal : t -> offset1:int -> t -> offset2:int -> len:int -> bool

equal a offset1 b offset2 returns true if the segments of len elements of a and b are equal starting from their respective offsets offset1 (for a) and offset2 (for b).

Sourceval to_array : ?offset:int -> ?len:int -> t -> elt array

to_array c converts a C array c to an OCaml array

Sourceval of_array : elt array -> t

of_array c converts an OCaml array c to a C array

Sourceval of_bigstring : Bigstringaf.t -> t
Sourceval to_bigstring : t -> Bigstringaf.t
Sourceval eq : t -> t -> bool

eq a b returns true if C arrays a and b are equals

Sourceval sub : t -> off:int -> len:int -> t

sub a off len extracts a sub-array of a

Sourceval fold_left_map : ('acc -> elt -> 'acc * elt) -> 'acc -> t -> 'acc * t

fold_left_map is a combination of fold_left and map that threads an accumulator through calls to f.

Sourcetype domain = Domain.t
Sourceval evaluation_ecfft : domain:domain -> points:t -> t

evaluation_ecfft domain points computes the ECFFT. domain can be obtained using Domain.build.

The ECFFT computes the G-linear map G^n -> G^n : (P_i)_{i=0,...,n-1} |-> (sum_{i=0}^{n-1} [domain.(i*j mod n)]P_i)_{j=0,...,n-1}.

where aP denotes the elliptic curve point multiplication.

Note:

  • size of domain must be a power of two
  • degree of polynomial must be strictly less than the size of domain
Sourceval interpolation_ecfft_inplace : domain:domain -> points:t -> unit

interpolation_ecfft_inplace domain points computes the inverse ECFFT. domain can be obtained using Domain.build.

It is the inverse function of evaluation_ecfft_inplace.

Note:

  • size of domain must be a power of two
  • size of a polynomial must be equal to size of domain
Sourceval add_arrays_inplace : t -> t -> unit

add_arrays_inplace a b writes the element-wise sum of the input vectors a and b into a

Sourcetype evaluations = Evaluations.t
Sourceval mul_arrays : evaluations:evaluations array -> arrays:t array -> t array

mul_arrays evaluations arrays computes the EC point multiplication given the scalar multipliers evaluations and the points arrays