Skip to content

Commit

Permalink
Merge pull request #84 from ederc/dimension-doc
Browse files Browse the repository at this point in the history 
Preparing v0.7.1
  • Loading branch information
@ederc
ederc authored Oct 4, 2024
2 parents dcfd8a9 + 8784b05 commit f31ae89
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 2 deletions.
2 changes: 1 addition & 1 deletion Project.toml
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "AlgebraicSolving"
uuid = "66b61cbe-0446-4d5d-9090-1ff510639f9d"
authors = ["ederc <ederc@mathematik.uni-kl.de>", "Mohab Safey El Din <Mohab.Safey@lip6.fr", "Rafael Mohr <rafael.mohr@lip6.fr>"]
version = "0.7.0"
version = "0.7.1"

[deps]
LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
Expand Down
1 change: 1 addition & 0 deletions docs/make.jl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ makedocs(
"types.md",
"Algorithms" => ["groebner-bases.md",
"normal-forms.md",
"dimension.md",
"solvers.md"],
"Examples" => "katsura.md"
]
Expand Down
31 changes: 31 additions & 0 deletions docs/src/dimension.md
View file
Original file line number Diff line number Diff line change
@@ -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
```

2 changes: 1 addition & 1 deletion src/algorithms/dimension.jl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

2 comments on commit f31ae89

@ederc
Copy link
Collaborator Author

@ederc ederc commented on f31ae89 Oct 4, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/116568

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.7.1 -m "<description of version>" f31ae89cde4e34fa23455e65a9e0bb6fc7e0c893
git push origin v0.7.1

Please sign in to comment.