field

package

v0.8.3 Latest Latest Go to latest Published: Feb 19, 2025 License: MIT Imports: 3 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/bytemare/ecc

Documentation ¶

Overview ¶

Package field provides modular operations over very high integers.

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func String2Int ¶

func String2Int(s string) big.Int

String2Int returns a big.Int representation of the integer s.

Types ¶

type Field ¶

type Field struct {
	// contains filtered or unexported fields
}

Field represents a Galois Field.

func NewField ¶

func NewField(prime *big.Int) Field

NewField returns a newly instantiated field for the given prime order.

func (Field) Add ¶

func (f Field) Add(res, x, y *big.Int)

Add sets res to x + y modulo the field order.

func (Field) ByteLen ¶

func (f Field) ByteLen() int

ByteLen returns the length of the field order in bytes.

func (Field) Exponent ¶

func (f Field) Exponent(res, x, n *big.Int) *big.Int

Exponent returns x^n mod field order.

func (Field) Inv ¶

func (f Field) Inv(res, x *big.Int)

Inv sets res to the modular inverse of x mod field order.

func (Field) IsEqual ¶

func (f Field) IsEqual(f2 *Field) bool

IsEqual returns whether the two fields have the same order.

func (Field) IsZero ¶

func (f Field) IsZero(e *big.Int) bool

IsZero returns whether the big.Int is equivalent to zero.

func (Field) Mod ¶

func (f Field) Mod(x *big.Int) *big.Int

Mod reduces x modulo the field order.

func (Field) Mul ¶

func (f Field) Mul(res, x, y *big.Int)

Mul sets res to the multiplication of x and y modulo the field order.

func (Field) Order ¶

func (f Field) Order() *big.Int

Order returns the size of the Field.

func (Field) PMinusOne ¶

func (f Field) PMinusOne() *big.Int

PMinusOne returns p-1, the greatest integer below the order.

func (Field) Random ¶

func (f Field) Random(res *big.Int) *big.Int

Random sets res to a random big.Int in the Field.

func (Field) Sub ¶

func (f Field) Sub(res, x, y *big.Int) *big.Int

Sub sets res to x - y modulo the field order.

Source Files ¶

View all Source files

field.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL