Files
mev-beta/vendor/github.com/consensys/gnark-crypto/ecc/bls12-381/fr/doc.go

47 lines
1.4 KiB
Go

// Copyright 2020-2025 Consensys Software Inc.
// Licensed under the Apache License, Version 2.0. See the LICENSE file for details.
// Code generated by consensys/gnark-crypto DO NOT EDIT
// Package fr contains field arithmetic operations for modulus = 0x73eda7...000001.
//
// The API is similar to math/big (big.Int), but the operations are significantly faster (up to 20x).
//
// Additionally fr.Vector offers an API to manipulate []Element using AVX512 instructions if available.
//
// The modulus is hardcoded in all the operations.
//
// Field elements are represented as an array, and assumed to be in Montgomery form in all methods:
//
// type Element [4]uint64
//
// # Usage
//
// Example API signature:
//
// // Mul z = x * y (mod q)
// func (z *Element) Mul(x, y *Element) *Element
//
// and can be used like so:
//
// var a, b Element
// a.SetUint64(2)
// b.SetString("984896738")
// a.Mul(a, b)
// a.Sub(a, a)
// .Add(a, b)
// .Inv(a)
// b.Exp(b, new(big.Int).SetUint64(42))
//
// Modulus q =
//
// q[base10] = 52435875175126190479447740508185965837690552500527637822603658699938581184513
// q[base16] = 0x73eda753299d7d483339d80809a1d80553bda402fffe5bfeffffffff00000001
//
// # Warning
//
// There is no security guarantees such as constant time implementation or side-channel attack resistance.
// This code is provided as-is. Partially audited, see https://github.com/Consensys/gnark/tree/master/audits
// for more details.
package fr