Skip to content

Commit

Permalink
docs: Fix poly docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sp301415 committed Aug 28, 2024
1 parent cb63968 commit 17667c1
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 4 deletions.
5 changes: 2 additions & 3 deletions math/poly/fourier_evaluator.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,11 @@ import (
"github.com/sp301415/tfhe-go/math/vec"
)

// FourierEvaluator calculates algorithms related to FFT,
// most notably the polynomial multiplication.
// FourierEvaluator computes polynomial algorithms over the Fourier domain.
//
// Operations usually take two forms: for example,
// - Add(fp0, fp1) adds fp0, fp1, allocates a new polynomial to store the result and returns it.
// - AddAssign(fp0, fp1, fpOut) adds fp0, fp1 and writes the result to pre-allocated pOut without returning.
// - AddAssign(fp0, fp1, fpOut) adds fp0, fp1 and writes the result to pre-allocated fpOut without returning.
//
// Note that in most cases, fp0, fp1, and fpOut can overlap.
// However, for operations that cannot, InPlace methods are implemented separately.
Expand Down
2 changes: 1 addition & 1 deletion math/poly/poly_evaluator.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ const (
MaxDegree = 1 << 30
)

// Evaluator calculates polynomial algorithms.
// Evaluator computes polynomial algorithms over the coefficient domain.
//
// Operations usually take two forms: for example,
// - Add(p0, p1) adds p0, p1, allocates a new polynomial to store the result and returns it.
Expand Down

0 comments on commit 17667c1

Please sign in to comment.