1// Copyright 2020 ConsenSys Software Inc.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15// Code generated by consensys/gnark-crypto DO NOT EDIT
16
17// Package fr contains field arithmetic operations for modulus = 0x30644e...000001.
18//
19// The API is similar to math/big (big.Int), but the operations are significantly faster (up to 20x for the modular multiplication on amd64, see also https://hackmd.io/@zkteam/modular_multiplication)
20//
21// The modulus is hardcoded in all the operations.
22//
23// Field elements are represented as an array, and assumed to be in Montgomery form in all methods:
24// 	type Element [4]uint64
25//
26// Example API signature
27// 	// Mul z = x * y mod q
28// 	func (z *Element) Mul(x, y *Element) *Element
29//
30// and can be used like so:
31// 	var a, b Element
32// 	a.SetUint64(2)
33// 	b.SetString("984896738")
34// 	a.Mul(a, b)
35// 	a.Sub(a, a)
36// 	 .Add(a, b)
37// 	 .Inv(a)
38// 	b.Exp(b, new(big.Int).SetUint64(42))
39//
40// Modulus
41// 	0x30644e72e131a029b85045b68181585d2833e84879b9709143e1f593f0000001 // base 16
42// 	21888242871839275222246405745257275088548364400416034343698204186575808495617 // base 10
43package fr
44