Skip to content

Commit e335e42

Browse files
committed
fixes docu for normal form
1 parent f270379 commit e335e42

File tree

2 files changed

+19
-10
lines changed

2 files changed

+19
-10
lines changed

docs/src/normal-forms.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,19 +17,28 @@ Pages = ["normal-forms.md"]
1717

1818
## Introduction
1919

20-
AlgebraicSolving allows to compute normal forms of a finite array of polynomials w.r.t.
21-
some given ideal over finite
22-
fields of characteristic smaller $2^{31}$ w.r.t. the degree reverse
23-
lexicographical monomial order.
20+
AlgebraicSolving allows to compute normal forms of a polynomial resp. a finite
21+
array of polynomials w.r.t. some given ideal over a finite field of
22+
characteristic smaller $2^{31}$ w.r.t. the degree reverse lexicographical
23+
monomial order.
2424

2525
**Note:** It therefore might first compute a Gröbner bases for the ideal.
2626
## Functionality
2727

2828
```@docs
2929
normal_form(
30-
F::Vector{T} where T <: MPolyRingElem,
31-
I::Ideal{T} where T <: MPolyRingElem;
30+
f::T,
31+
I::Ideal{T};
3232
nr_thrds::Int=1,
3333
info_level::Int=0
34-
)
34+
) where T <: MPolyRingElem
35+
```
36+
37+
```@docs
38+
normal_form(
39+
F::Vector{T},
40+
I::Ideal{T};
41+
nr_thrds::Int=1,
42+
info_level::Int=0
43+
) where T <: MPolyRingElem
3544
```

src/algorithms/normal-forms.jl

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ export normal_form
44

55
@doc Markdown.doc"""
66
normal_form(
7-
F::Vector{T} where T <: MPolyRingElem,
8-
I::Ideal{T} where T <: MPolyRingElem;
7+
f::T,
8+
I::Ideal{T};
99
nr_thrds::Int=1,
1010
info_level::Int=0
11-
)
11+
) where T <: MPolyRingElem
1212
1313
Compute the normal forms of the elements of `F` w.r.t. a degree reverse
1414
lexicographical Gröbner basis of `I`.

0 commit comments

Comments
 (0)