Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix "docstring oddities" #175

Merged
merged 3 commits into from
Oct 27, 2020
Merged

fix "docstring oddities" #175

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f499929
docstrings: fix spacing before prototypes
rfourquet Oct 27, 2020
2394481
docstrings: add a newline between prototype and description
rfourquet Oct 27, 2020
816bf3e
docstrings: remove ">" character at the start of lines
rfourquet Oct 27, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 36 additions & 24 deletions examples/AffinePlaneCurve.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,9 @@ end
# and show it.

@doc Markdown.doc"""
degree(C::AffinePlaneCurve)
> Given an affine plane curve C, returns the degree of the defining polynomial.
degree(C::AffinePlaneCurve)

Given an affine plane curve C, returns the degree of the defining polynomial.
"""
function Oscar.degree(C::AffinePlaneCurve)
if C.degree >= 0
Expand All @@ -85,8 +86,9 @@ end
# Compute the Jacobian Ideal of C

@doc Markdown.doc"""
jacobi_ideal(C::AffinePlaneCurve)
> Given an affine plane curve C, returns the Jacobian ideal of the defining polynomial.
jacobi_ideal(C::AffinePlaneCurve)

Given an affine plane curve C, returns the Jacobian ideal of the defining polynomial.
"""
function Oscar.jacobi_ideal(C::AffinePlaneCurve)
return jacobi_ideal(C.eq)
Expand All @@ -98,8 +100,9 @@ end
# curve.

@doc Markdown.doc"""
issmooth_point(C::AffinePlaneCurve{S}, P::Point{S}) where S <: FieldElem
> Given an affine plane curve C and a point P, returns an error if the point is not in the zero locus of the defining equation, false if it is a singular point of C, and true if it is a smooth point of the curve.
issmooth_point(C::AffinePlaneCurve{S}, P::Point{S}) where S <: FieldElem

Given an affine plane curve C and a point P, returns an error if the point is not in the zero locus of the defining equation, false if it is a singular point of C, and true if it is a smooth point of the curve.
"""
function issmooth_point(C::AffinePlaneCurve{S}, P::Point{S}) where S <: FieldElem
if P.ambient_dim != 2
Expand All @@ -124,8 +127,9 @@ end
# at the point P.

@doc Markdown.doc"""
tangent(C::AffinePlaneCurve{S}, P::Point{S}) where S <: FieldElem
> Given an affine plane curve C and a point P, if P is a smooth point of C, returns the affine plane curve defined as the tangent of C at P.
tangent(C::AffinePlaneCurve{S}, P::Point{S}) where S <: FieldElem

Given an affine plane curve C and a point P, if P is a smooth point of C, returns the affine plane curve defined as the tangent of C at P.
"""
function tangent(C::AffinePlaneCurve{S}, P::Point{S}) where S <: FieldElem
if P.ambient_dim != 2
Expand All @@ -151,8 +155,9 @@ end
# Union of two affine plane curves (with multiplicity)

@doc Markdown.doc"""
union(C::AffinePlaneCurve{S}, D::AffinePlaneCurve{S}) where S <: FieldElem
> Given two affine plane curves C and D, returns the union of the two curves (with multiplicity).
union(C::AffinePlaneCurve{S}, D::AffinePlaneCurve{S}) where S <: FieldElem

Given two affine plane curves C and D, returns the union of the two curves (with multiplicity).
"""
function Base.union(C::AffinePlaneCurve{S}, D::AffinePlaneCurve{S}) where S <: FieldElem
F = C.eq*D.eq
Expand All @@ -163,8 +168,9 @@ end
# Components of the curve

@doc Markdown.doc"""
curve_components(C::AffinePlaneCurve)
> Given an affine plane curve C, returns a dictionary containing its irreducible components (as affine plane curves) and their multiplicity.
curve_components(C::AffinePlaneCurve)

Given an affine plane curve C, returns a dictionary containing its irreducible components (as affine plane curves) and their multiplicity.
"""
function curve_components(C::AffinePlaneCurve)
if C.components != Dict()
Expand All @@ -181,8 +187,9 @@ end
# TODO: change for a direct irreducibility check when available.

@doc Markdown.doc"""
isirreducible(C::AffinePlaneCurve)
> Given an affine plane curve C, returns true if the curve is irreducible, and false otherwise.
isirreducible(C::AffinePlaneCurve)

Given an affine plane curve C, returns true if the curve is irreducible, and false otherwise.
"""
function Oscar.isirreducible(C::AffinePlaneCurve)
if C.components == Dict()
Expand All @@ -202,8 +209,9 @@ end
# Check reducedness by computing a factorization

@doc Markdown.doc"""
isreduced(C::AffinePlaneCurve)
> Given an affine plane curve C, returns true if the curve is reduced, and false otherwise.
isreduced(C::AffinePlaneCurve)

Given an affine plane curve C, returns true if the curve is reduced, and false otherwise.
"""
function Oscar.isreduced(C::AffinePlaneCurve)
if C.components == Dict()
Expand All @@ -221,8 +229,9 @@ end
# gives the common components of two affine plane curves

@doc Markdown.doc"""
common_components(C::AffinePlaneCurve{S}, D::AffinePlaneCurve{S}) where S <: FieldElem(C::AffinePlaneCurve)
> Given two affine plane curves C and D, returns the affine plane curve consisting of the common components, or an error if they do not have a common component.
common_components(C::AffinePlaneCurve{S}, D::AffinePlaneCurve{S}) where S <: FieldElem(C::AffinePlaneCurve)

Given two affine plane curves C and D, returns the affine plane curve consisting of the common components, or an error if they do not have a common component.
"""
function common_components(C::AffinePlaneCurve{S}, D::AffinePlaneCurve{S}) where S <: FieldElem
G = gcd(C.eq, D.eq)
Expand All @@ -240,8 +249,9 @@ end
# of intersection points. Some might be contained in the common component too.

@doc Markdown.doc"""
curve_intersect(C::AffinePlaneCurve{S}, D::AffinePlaneCurve{S}) where S <: FieldElem
> Given two affine plane curves C and D defined by F and G, returns a list whose first element is the affine plane curve defined by the gcd of F and G, the second element is the list of the remaining intersection points when the common components are removed from C and D.
curve_intersect(C::AffinePlaneCurve{S}, D::AffinePlaneCurve{S}) where S <: FieldElem

Given two affine plane curves C and D defined by F and G, returns a list whose first element is the affine plane curve defined by the gcd of F and G, the second element is the list of the remaining intersection points when the common components are removed from C and D.
"""
function curve_intersect(C::AffinePlaneCurve{S}, D::AffinePlaneCurve{S}) where S <: FieldElem
G = gcd(C.eq, D.eq)
Expand Down Expand Up @@ -312,8 +322,9 @@ end
# Might change depending on the futur changes on VarietyModule.

@doc Markdown.doc"""
intersect( C::AffinePlaneCurve{S}, D::AffinePlaneCurve{S}) where S <: FieldElem
> Given two affine plane curves C and D, returns the variety defined by the intersection of the two curves
intersect( C::AffinePlaneCurve{S}, D::AffinePlaneCurve{S}) where S <: FieldElem

Given two affine plane curves C and D, returns the variety defined by the intersection of the two curves
"""
function Oscar.intersect(C::AffinePlaneCurve{S}, D::AffinePlaneCurve{S}) where S <: FieldElem
I = ideal(parent(C.eq), [C.eq, D.eq])
Expand All @@ -327,8 +338,9 @@ end
# curve. The points might also be contained in the components.

@doc Markdown.doc"""
curve_singular_locus( C::AffinePlaneCurve)
> Given an affine plane curve C, returns a list whose first element is the affine plane curve consisting of the singular components of C (if any), and the second element is the list of the isolated singular points (which may be contained in the singular component). The singular component might not contain any point over the considered field.
curve_singular_locus( C::AffinePlaneCurve)

Given an affine plane curve C, returns a list whose first element is the affine plane curve consisting of the singular components of C (if any), and the second element is the list of the isolated singular points (which may be contained in the singular component). The singular component might not contain any point over the considered field.
"""
function curve_singular_locus(C::AffinePlaneCurve)
F = C.eq
Expand Down
6 changes: 3 additions & 3 deletions examples/PrimDec.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ export primary_decomposition
# basering has characteristic 0
#OUTPUT: Primary decomposition of I with associated primes in a list
@doc Markdown.doc""" decomp(I::Oscar.ideal; usefglm::Bool)
> Computes the primary decomposition of an Ideal $I$ over a basefield of characteristig 0 that has a global ordering,
> via GTZ. Returns the primary decomposition with associated primes in a list. If the additional boolean 'usefglm' is
> set to 'true' then the FGLM - algorithm is used in zero-dimensional computations.
Computes the primary decomposition of an Ideal $I$ over a basefield of characteristig 0 that has a global ordering,
via GTZ. Returns the primary decomposition with associated primes in a list. If the additional boolean 'usefglm' is
set to 'true' then the FGLM - algorithm is used in zero-dimensional computations.
"""
function primary_decomposition(I::Oscar.MPolyIdeal; usefglm::Bool = false)
Oscar.singular_assure(I)
Expand Down
6 changes: 3 additions & 3 deletions examples/ZeroDec.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@

#Implementation of Algorithm 4.2.7
@doc Markdown.doc""" zerodecomp(I::Singular.sideal, outputReduced::Bool = false)
> Computes the primary decomposition of a zero-dimensional Ideal $I$ over a basefield of characteristig 0 that has a global ordering,
> via GTZ. Returns the primary decomposition with associated primes in a list. If $outputReduced$ is set to true, calculates a reduced Gröbner
> before returning the primary decomposition.
Computes the primary decomposition of a zero-dimensional Ideal $I$ over a basefield of characteristig 0 that has a global ordering,
via GTZ. Returns the primary decomposition with associated primes in a list. If $outputReduced$ is set to true, calculates a reduced Gröbner
before returning the primary decomposition.
"""
#REQUIRES: INPUT sideal I, Optional: Whether the output should be put in completely reduced Gröbner bases. Default is to not reduce.
# I is zero-dimensional (Krull dimension)
Expand Down
Loading