Merge pull request #84 from ederc/dimension-doc

Preparing v0.7.1

Author: ederc

Project.toml

@@ -1,7 +1,7 @@
 name = "AlgebraicSolving"
 uuid = "66b61cbe-0446-4d5d-9090-1ff510639f9d"
 authors = ["ederc <[email protected]>", "Mohab Safey El Din <[email protected]", "Rafael Mohr <[email protected]>"]
-version = "0.7.0"
+version = "0.7.1"
 
 [deps]
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"

docs/make.jl

@@ -21,6 +21,7 @@ makedocs(
         "types.md",
         "Algorithms" => ["groebner-bases.md",
                          "normal-forms.md",
+                         "dimension.md",
                          "solvers.md"],
         "Examples" => "katsura.md"
         ]

docs/src/dimension.md

@@ -0,0 +1,31 @@
+```@meta
+CurrentModule = AlgebraicSolving
+DocTestSetup = quote
+  using AlgebraicSolving
+end
+```
+
+```@setup algebraicsolving
+using AlgebraicSolving
+```
+
+```@contents
+Pages = ["dimension.md"]
+```
+
+# Krull dimension of an ideal
+
+## Introduction
+
+AlgebraicSolving allows to compute the Krull dimension for the ideal spanned
+by given input generators over finite fields of characteristic smaller
+$2^{31}$ and over the rationals.
+
+The underlying engine is provided by msolve.
+
+## Functionality
+
+```@docs
+    dimension(I::Ideal{T}) where T <: MPolyRingElem
+```
+

src/algorithms/dimension.jl

@@ -3,7 +3,7 @@
 
 Compute the Krull dimension of a given polynomial ideal `I`.
 
-**Note**: This requires a Gröbner basis of `I`. 
+**Note**: This requires a Gröbner basis of `I`, which is computed internally if not alraedy known.
 
 # Examples
 ```jldoctest