generator

Documentation

Overview

Package generator provides a wrapper around the internal field generator.

Index

• func Generate(packageName, elementName, modulus string, outputDir string, opts ...Option) error
• type Option
  • func WithASM(buildDir, includeDir string) Option
  • func WithAddChain() Option
  • func WithExtensions() Option
  • func WithFFT(generatorFullMultiplicativeGroup uint64, generatorMaxTwoAdicSubgroup string, ...) Option
  • func WithIOP() Option
  • func WithPoseidon2() Option
  • func WithSIS() Option

Examples

• Generate

Functions

func Generate

func Generate(packageName, elementName, modulus string, outputDir string, opts ...Option) error

Generate generates arithmetic operations for a given modulus.

Example

package main

import (
	"fmt"
	"os"
	"path/filepath"

	"github.com/consensys/gnark-crypto/field/generator"
)

func main() {
	// Define the field parameters
	packageName := "goldilocks"
	elementName := "Element"
	modulus := "0xffffffff00000001"
	outputDir := filepath.Join(os.TempDir(), "gnark-crypto-field-gen")

	// Ensure output directory exists
	_ = os.MkdirAll(outputDir, 0755)
	defer os.RemoveAll(outputDir)

	// Generate the field arithmetic code
	err := generator.Generate(packageName, elementName, modulus, outputDir,
		generator.WithASM(filepath.Join(outputDir, "asm"), "asm"),
	)
	if err != nil {
		fmt.Printf("failed to generate field: %v\n", err)
		return
	}

	fmt.Println("successfully generated field arithmetic code")
}

Types

type Option

type Option func(*options)

Option is a functional option for the generator.

func WithASM

func WithASM(buildDir, includeDir string) Option

WithASM enables assembly code generation. buildDir is the destination path to create output files. includeDir is the directory name to include in the generated files.

func WithAddChain

func WithAddChain() Option

WithAddChain enables the use of addition chains for inversion.

func WithExtensions

func WithExtensions() Option

WithExtensions enables field extensions code generation.

func WithFFT

func WithFFT(generatorFullMultiplicativeGroup uint64, generatorMaxTwoAdicSubgroup string, logTwoOrderMaxTwoAdicSubgroup string) Option

WithFFT enables FFT code generation.

func WithIOP

func WithIOP() Option

WithIOP enables IOP code generation.

func WithPoseidon2

func WithPoseidon2() Option

WithPoseidon2 enables Poseidon2 code generation.

func WithSIS

func WithSIS() Option

WithSIS enables SIS code generation.