package octez-libs

  1. Overview
  2. Docs
package octez-libs
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module G1.ScalarSource

Sourceexception Not_in_field of Bytes.t
Sourcetype t = Fr.t
Sourceval order : Z.t

The order of the finite field

Sourceval size_in_bytes : int

minimal number of bytes required to encode a value of the field.

Sourceval check_bytes : Bytes.t -> bool

check_bytes bs returns true if bs is a correct byte representation of a field element

Sourceval zero : t

The neutral element for the addition

Sourceval one : t

The neutral element for the multiplication

Sourceval add : t -> t -> t

add a b returns a + b mod order

Sourceval mul : t -> t -> t

mul a b returns a * b mod order

Sourceval eq : t -> t -> bool

eq a b returns true if a = b mod order, else false

Sourceval negate : t -> t

negate x returns -x mod order. Equivalently, negate x returns the unique y such that x + y mod order = 0

Sourceval inverse_exn : t -> t

inverse_exn x returns x^-1 if x is not 0, else raise Division_by_zero

Sourceval inverse_opt : t -> t option

inverse_opt x returns x^-1 if x is not 0 as an option, else None

Sourceval pow : t -> Z.t -> t

pow x n returns x^n

Sourceval of_bytes_exn : Bytes.t -> t

From a predefined bytes representation, construct a value t. It is not required that to_bytes (of_bytes_exn t) = t. Raise Not_in_field if the bytes do not represent an element in the field.

Sourceval of_bytes_opt : Bytes.t -> t option

From a predefined bytes representation, construct a value t. It is not required that to_bytes (Option.get (of_bytes_opt t)) = t. By default, little endian encoding is used and the given element is modulo the prime order

Sourceval to_bytes : t -> Bytes.t

Convert the value t to a bytes representation which can be used for hashing for instance. It is not required that to_bytes (of_bytes_exn t) = t. By default, little endian encoding is used, and length of the resulting bytes may vary depending on the order.

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