You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

43 lines
1.5 KiB

  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. // Code generated by consensys/gnark-crypto DO NOT EDIT
  15. // Package ffg contains field arithmetic operations for modulus = 0xffffff...000001.
  16. //
  17. // 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)
  18. //
  19. // The modulus is hardcoded in all the operations.
  20. //
  21. // Field elements are represented as an array, and assumed to be in Montgomery form in all methods:
  22. // type Element [1]uint64
  23. //
  24. // Example API signature
  25. // // Mul z = x * y mod q
  26. // func (z *Element) Mul(x, y *Element) *Element
  27. //
  28. // and can be used like so:
  29. // var a, b Element
  30. // a.SetUint64(2)
  31. // b.SetString("984896738")
  32. // a.Mul(a, b)
  33. // a.Sub(a, a)
  34. // .Add(a, b)
  35. // .Inv(a)
  36. // b.Exp(b, new(big.Int).SetUint64(42))
  37. //
  38. // Modulus
  39. // 0xffffffff00000001 // base 16
  40. // 18446744069414584321 // base 10
  41. package ffg