package tezos-plonk
Install
dune-project
Dependency
Authors
Maintainers
Sources
md5=03d6ca5fb1c6865b6628e0dd49575895
sha512=20494d1d00ded43f3625e06e037d3bad04f0a7320914b542b882d3d0293c9b02845b7ca9ee4ff0eb8ea495eff5633016861c39370cca92c12aacae0e84483ca4
doc/tezos-plonk.aggregation/Aggregation/Main_protocol/Make_impl/argument-1-Super_PP/Evaluations/index.html
Module Super_PP.Evaluations
Module to operate with polynomials in FFT evaluations form.
type polynomial = PC.Polynomial.Polynomial.ttype t = PC.Polynomial.Evaluations.tval of_array : (int * PC.Scalar.t array) -> tof_array (d, e) creates a value of type t from the evaluation representation of a polynomial e of degree d, i.e, it converts an OCaml array to a C array
val to_array : t -> PC.Scalar.t arrayto_array converts a C array to an OCaml array
val string_of_eval : t -> stringstring_of_eval e returns the string representation of evaluation e
type domain = PC.Polynomial.Domain.tval zero : tzero returns the evaluation representation of the zero polynomial
val is_zero : t -> boolis_zero p checks whether a polynomial p is the zero polynomial
val degree : t -> intdegree returns the degree of a polynomial. Returns -1 for the zero polynomial
val length : t -> intlength e returns the size of domain where a polynomial is evaluated, or equally, the size of a C array where evaluation e is stored
val create : int -> tcreate len returns the evaluation representation of a zero polynomial of size len
copy ?res a returns a copy of evaluation a. The function writes the result in res if res has the correct size and allocates a new array for the result otherwise
val get : t -> int -> PC.Scalar.tget p i returns the i-th element of a given array p
val mul_by_scalar : PC.Scalar.t -> t -> tmul_by_scalar computes muliplication of a polynomial by a blst_fr element
val mul_c :
?res:t ->
evaluations:t list ->
?composition_gx:(int list * int) ->
?powers:int list ->
unit ->
tmul_c computes p₁(gᶜ₁·x)ᵐ₁·p₂(gᶜ₂·x)ᵐ₂·…·pₖ(gᶜₖ·x)ᵐₖ, where
pᵢ = List.nth evaluations imᵢ = List.nth powers icᵢ = List.nth (fst composition_gx) in = snd composition_gxis the order of generator, i.e.,gⁿ = 1
The function writes the result in res if res has the correct size (= min (size pᵢ)) and allocates a new array for the result otherwise
Note: res and pᵢ are disjoint
val linear_c :
?res:t ->
evaluations:t list ->
?linear_coeffs:PC.Scalar.t list ->
?composition_gx:(int list * int) ->
?add_constant:PC.Scalar.t ->
unit ->
tlinear_c computes λ₁·p₁(gᶜ₁·x) + λ₂·p₂(gᶜ₂·x) + … + λₖ·pₖ(gᶜₖ·x) + add_constant, where
pᵢ = List.nth evaluations iλᵢ = List.nth linear_coeffs icᵢ = List.nth (fst composition_gx) in = snd composition_gxis the order of generator, i.e.,gⁿ = 1
The function writes the result in res if res has the correct size (= min (size pᵢ)) and allocates a new array for the result otherwise
Note: res and pᵢ are disjoint
val linear_with_powers : t list -> PC.Scalar.t -> tlinear_with_powers p s computes ∑ᵢ sⁱ·p.(i). This function is more efficient than linear + powers for evaluations of the same size
add ?res a b computes polynomial addition of a and b. The function writes the result in res if res has the correct size (= min (size (a, b))) and allocates a new array for the result otherwise
Note: res can be equal to either a or b
equal a b checks whether a polynomial a is equal to a polynomial b
Note: equal is defined as restrictive equality, i.e., the same polynomial evaluated on different domains are said to be different
val evaluation_fft : domain -> polynomial -> tevaluation_fft domain p converts the coefficient representation of a polynomial p to the evaluation representation. domain can be obtained using Domain.build
Note:
- size of domain must be a power of two
- degree of polynomial must be strictly less than the size of domain
val interpolation_fft : domain -> t -> polynomialinterpolation_fft domain p converts the evaluation representation of a polynomial p to the coefficient representation. domain can be obtained using Domain.build
Note:
- size of domain must be a power of two
- size of a polynomial must be equal to size of domain
val interpolation_fft2 : domain -> PC.Scalar.t array -> polynomialval dft : domain -> polynomial -> tdft domain polynomial converts the coefficient representation of a polynomial p to the evaluation representation. domain can be obtained using Domain.build
requires:
size domainto divide Bls12_381.Fr.order - 1size domain != 2^kdegree polynomial < size domain
val idft_inplace : domain -> t -> polynomialidft_inplace domain t converts the evaluation representation of a polynomial p to the coefficient representation. domain can be obtained using Domain.build
requires:
size domainto divide Bls12_381.Fr.order - 1size domain != 2^ksize domain = size t
val evaluation_fft_prime_factor_algorithm :
domain1:domain ->
domain2:domain ->
polynomial ->
tevaluation_fft_prime_factor_algorithm domain1 domain2 p converts the coefficient representation of a polynomial p to the evaluation representation. domain can be obtained using Domain.build. See the Prime-factor FFT algorithm.
requires:
size domain1 * size domain2to divide Bls12_381.Fr.order - 1size domain1andsize domain2to be coprime- if for some k
size domain1 != 2^kthensize domain1 <= 2^10 - if for some k
size domain2 != 2^kthensize domain2 <= 2^10 degree polynomial < size domain1 * size domain2
val interpolation_fft_prime_factor_algorithm_inplace :
domain1:domain ->
domain2:domain ->
t ->
polynomialinterpolation_fft_prime_factor_algorithm domain1 domain2 t converts the evaluation representation of a polynomial p to the coefficient representation. domain can be obtained using Domain.build. See the Prime-factor FFT algorithm.
requires:
size domain1 * size domain2to divide Bls12_381.Fr.order - 1size domain1andsize domain2to be coprime- if for some k
size domain1 != 2^kthensize domain1 <= 2^10 - if for some k
size domain2 != 2^kthensize domain2 <= 2^10 size t = size domain1 * size domain2
val size_evaluations : t Plonk.SMap.t -> intsize_evaluations returns the maximum size of elements in evaluations
val find_evaluation : t Plonk.SMap.t -> string -> tfind_evaluation m name returns the evaluation for a given name name
val print_evaluations_name : t Plonk.SMap.t -> unitprint_evaluations_name prints (name, degree, length) for each evaluation
val get_domain : t Plonk.SMap.t -> domainget_domain returns the evaluation for "X"
val compute_evaluations :
domain:domain ->
polynomial Plonk.SMap.t ->
t Plonk.SMap.tcompute_evaluations converts the coefficient representation of each polynomial pᵢ to the evaluation representation.
Note:
- size of domain must be a power of two
- size of a polynomial
pᵢmust be less than or equal to size of domain
val compute_evaluations_update_map :
?domain:domain ->
evaluations:t Plonk.SMap.t ->
polynomial Plonk.SMap.t ->
t Plonk.SMap.tcompute_evaluations_update_map writes the result of compute_evaluations in evaluations. If domain is not provided, get_domain is called
val mul :
?res:t ->
evaluations:t Plonk.SMap.t ->
poly_names:string list ->
?composition_gx:(int list * int) ->
?powers:int list ->
unit ->
tmul invokes mul_c with the evaluations for given names poly_names
val linear :
?res:t ->
evaluations:t Plonk.SMap.t ->
poly_names:Plonk.SMap.key list ->
?linear_coeffs:PC.Scalar.t list ->
?composition_gx:(int list * int) ->
?add_constant:PC.Scalar.t ->
unit ->
tlinear invokes linear_c with the evaluations for given names poly_names