diff --git a/assets/interface/code/lowlevel.jl b/assets/interface/code/lowlevel.jl new file mode 100644 index 00000000..a1d37c1c --- /dev/null +++ b/assets/interface/code/lowlevel.jl @@ -0,0 +1,8 @@ +# This file was generated, do not modify it. # hide +using Groebner +# define {x y - 1, x^3 + 7 y^2} modulo 65537 in DRL +ring = Groebner.PolyRing(2, Groebner.DegRevLex(), 65537) +monoms = [ [[1, 1], [0, 0]], [[3, 0], [0, 2]] ] +coeffs = [ [1, -1], [1, 7] ] +# compute a GB +gb_monoms, gb_coeffs = Groebner.groebner(ring, monoms, coeffs) \ No newline at end of file diff --git a/assets/interface/code/output/lowlevel.out b/assets/interface/code/output/lowlevel.out new file mode 100644 index 00000000..e69de29b diff --git a/assets/interface/code/output/lowlevel.res b/assets/interface/code/output/lowlevel.res new file mode 100644 index 00000000..56a4d6b6 --- /dev/null +++ b/assets/interface/code/output/lowlevel.res @@ -0,0 +1 @@ +(Vector{Vector{UInt32}}[[[0x00000001, 0x00000001], [0x00000000, 0x00000000]], [[0x00000000, 0x00000003], [0x00000002, 0x00000000]], [[0x00000003, 0x00000000], [0x00000000, 0x00000002]]], Vector{UInt32}[[0x00000001, 0x00010000], [0x00000001, 0x00004925], [0x00000001, 0x00000007]]) \ No newline at end of file diff --git a/assets/tutorial/code/output/gcd3.out b/assets/tutorial/code/output/gcd3.out index e704bc8c..56d3d2b0 100644 --- a/assets/tutorial/code/output/gcd3.out +++ b/assets/tutorial/code/output/gcd3.out @@ -1 +1 @@ - 81.782 μs (1669 allocations: 64.62 KiB) + 84.277 μs (1669 allocations: 64.62 KiB) diff --git a/assets/tutorial/code/output/gcd4.out b/assets/tutorial/code/output/gcd4.out index 8e7e2ead..3f200f06 100644 --- a/assets/tutorial/code/output/gcd4.out +++ b/assets/tutorial/code/output/gcd4.out @@ -1 +1 @@ - 151.401 μs (2706 allocations: 160.52 KiB) + 152.125 μs (2706 allocations: 160.52 KiB) diff --git a/assets/tutorial/code/output/graph2.svg b/assets/tutorial/code/output/graph2.svg index 96bfcbe3..a7957702 100644 --- a/assets/tutorial/code/output/graph2.svg +++ b/assets/tutorial/code/output/graph2.svg @@ -13,14 +13,14 @@ - + - + - + @@ -37,13 +37,13 @@ - + - + - + - + @@ -57,7 +57,7 @@ - + 1 @@ -79,7 +79,7 @@ - + diff --git a/assets/tutorial/code/output/graphcolored.svg b/assets/tutorial/code/output/graphcolored.svg index 252d47a1..ef91875f 100644 --- a/assets/tutorial/code/output/graphcolored.svg +++ b/assets/tutorial/code/output/graphcolored.svg @@ -13,14 +13,14 @@ - + - + - + @@ -37,13 +37,13 @@ - + - + - + - + @@ -57,7 +57,7 @@ - + 1 @@ -79,7 +79,7 @@ - + diff --git a/benchmarks/index.html b/benchmarks/index.html index d87319fc..f17e4caf 100644 --- a/benchmarks/index.html +++ b/benchmarks/index.html @@ -58,7 +58,7 @@

Groebner Home -
  • Introductory tutorial + @@ -92,6 +94,7 @@

    Groebner +

    Benchmarks

    Here we compare Groebner.jl vs Singular.jl groebner implementations over fields of characteristic zero. The table below lists runtimes for several standard benchmark systems in seconds

    diff --git a/developer/index.html b/developer/index.html index 5d11f1c5..4458b1de 100644 --- a/developer/index.html +++ b/developer/index.html @@ -59,7 +59,7 @@

    Groebner Home -
  • Introductory tutorial +

    • @@ -93,6 +95,7 @@

    Groebner +

    Development

    diff --git a/index.html b/index.html index fc3cd4b0..b270d29f 100644 --- a/index.html +++ b/index.html @@ -59,7 +59,7 @@

    Groebner Home -
  • Introductory tutorial +

    • @@ -93,16 +95,28 @@

    Groebner +
    -

    Groebner.jl is a package for fast and generic Gröbner bases computations based on Faugère's F4 algorithm written in Julia.

    +

    Groebner.jl is a package for Gröbner bases computations based on the Faugère's F4 algorithm written in Julia.

    Installation

    To install Groebner.jl, run the following in the Julia REPL:

    using Pkg; Pkg.add("Groebner")

    See Interface for a description of all exported functions. For a quick introduction to Groebner bases we refer to Tutorials. Meanwhile, below are simple examples.

    +

    Features

    +

    Groebner.jl features:

    +
      +

    • Gröbner basis computation over integers modulo a prime and over the rationals

      +
      • +

    • Gröbner trace algorithms

      +
      • +

    • Multi-threading by default

      +
      • +
    +

    See Interface page for a list of all exported functions.

    Examples

    -

    Currently, polynomials from AbstractAlgebra.jl, DynamicPolynomials.jl, and Nemo.jl are supported as input.

    +

    As input, Groebner.jl supports polynomials from AbstractAlgebra.jl, DynamicPolynomials.jl, and Nemo.jl.

    with AbstractAlgebra.jl

    First, import AbstractAlgebra.jl. Then, we can create an array of polynomials over a finite field

    diff --git a/interface/index.html b/interface/index.html index 91ed0141..65ab09d2 100644 --- a/interface/index.html +++ b/interface/index.html @@ -59,7 +59,7 @@

    Groebner Home -
  • Introductory tutorial +

    • @@ -93,6 +95,7 @@

    Groebner +

    Interface

    Exported functions

    @@ -548,7 +551,7 @@

    Example@assert flag @assert gb_2 == groebner([2x2*y2^2 + 3x2, 4y2*x2^2 + 5y2], ordering=DegRevLex()) -

    Using groebner_apply! in batches (works only in :degrevlex at the moment):

    +

    Using groebner_apply! in batches:

    using Groebner, AbstractAlgebra
 R, (x, y) = polynomial_ring(GF(2^31-1), ["x", "y"], internal_ordering=:degrevlex)
 
@@ -622,6 +625,19 @@ 
    Notes

    +

    Low-level interface

    + +

    Some functions in the interface have a low-level entry point. Low-level functions accept and output ''raw'' exponent vectors and coefficients. This could be convenient when one does not want to depend on a frontend.

    +

    For example,

    +
    using Groebner
+# define {x y - 1, x^3 + 7 y^2} modulo 65537 in DRL
+ring = Groebner.PolyRing(2, Groebner.DegRevLex(), 65537)
+monoms = [ [[1, 1], [0, 0]], [[3, 0], [0, 2]] ]
+coeffs = [ [1, -1], [1, 7] ]
+# compute a GB
+gb_monoms, gb_coeffs = Groebner.groebner(ring, monoms, coeffs)
    (Vector{Vector{UInt32}}[[[0x00000001, 0x00000001], [0x00000000, 0x00000000]], [[0x00000000, 0x00000003], [0x00000002, 0x00000000]], [[0x00000003, 0x00000000], [0x00000000, 0x00000002]]], Vector{UInt32}[[0x00000001, 0x00010000], [0x00000001, 0x00004925], [0x00000001, 0x00000007]])
    +

    The list of functions that provide a low-level entry point: groebner, normalform, isgroebner, groebner_learn, groebner_apply.

    +

    The low-level functions may be faster than their user-facing analogues since they bypass internal checks and conversions. Low-level functions do not make any specific assumptions, that is, all of these are correctly handled in the input: unsorted monomials, nonnormalized coefficients, duplicate terms, aliasing memory.

    © Alexander Demin, Shashi Gowda, and others. Last modified: October 14, 2024. Website built with Franklin.jl and PkgPage.jl. diff --git a/tutorial/index.html b/tutorial/index.html index 977f7a9c..d4aca09d 100644 --- a/tutorial/index.html +++ b/tutorial/index.html @@ -59,7 +59,7 @@

    Groebner Home -
  • Introductory tutorial +

    • @@ -93,6 +95,7 @@

    Groebner +

    Tutorials

    @@ -173,11 +176,11 @@

    h = (x + 3)^5 -@btime gcd(gcd($f, $g), $h)
      81.782 μs (1669 allocations: 64.62 KiB)
+@btime gcd(gcd($f, $g), $h)
      84.277 μs (1669 allocations: 64.62 KiB)
 3 + x

    With Groebner.jl:

    F = [f, g, h]
-@btime groebner($F)
      151.401 μs (2706 allocations: 160.52 KiB)
+@btime groebner($F)
      152.125 μs (2706 allocations: 160.52 KiB)
 1-element Vector{DynamicPolynomials.Polynomial{DynamicPolynomials.Commutative{DynamicPolynomials.CreationOrder}, MultivariatePolynomials.Graded{MultivariatePolynomials.LexOrder}, Rational{BigInt}}}:
  3//1 + x

    Variable Elimination