Add relations(::FPModule); redirect rels through relations

docs/src/module.md

@@ -65,6 +65,7 @@ Return a Julia array of the generators of the module $M$.
 
 ```julia
 rels(M::FPModule{T}) where T <: RingElement
+relations(M::FPModule{T}) where T <: RingElement
 ```
 
 Return a Julia vector of all the relations between the generators of `M`. Each

docs/src/module_interface.md

@@ -89,6 +89,7 @@ Return a Julia array of the generators of the module $M$.
 
 ```julia
 rels(M::MyModule{T}) where T <: RingElement
+relations(M::MyModule{T}) where T <: RingElement
 ```
 
 Return a Julia vector of all the relations between the generators of `M`. Each

src/exports.jl

@@ -505,6 +505,7 @@ export rational_function_field
 export reduce!
 export rel_series
 export rel_series_type
+export relations
 export rels
 export rem!
 export remove

src/generic/FreeModule.jl

@@ -24,7 +24,7 @@ elem_type(::Type{FreeModule{T}}) where T <: NCRingElement = FreeModuleElem{T}
 
 parent(m::FreeModuleElem{T}) where T <: NCRingElement = m.parent
 
-function rels(M::FreeModule{T}) where T <: RingElement
+function relations(M::FreeModule{T}) where T <: RingElement
    # there are no relations in a free module
    return Vector{dense_matrix_type(T)}(undef, 0)
 end

src/generic/InvariantFactorDecomposition.jl

@@ -32,7 +32,7 @@ end
 
 invariant_factors(N::SNFModule{T}) where T <: RingElement = N.invariant_factors
 
-function rels(N::SNFModule{T}) where T <: RingElement
+function relations(N::SNFModule{T}) where T <: RingElement
    T1 = dense_matrix_type(T)
    R = base_ring(N)
    invs = invariant_factors(N)

src/generic/Module.jl

@@ -17,13 +17,22 @@
 end
 
 @doc raw"""
-    rels(M::AbstractAlgebra.FPModule{T}) where T <: RingElement
+    relations(M::AbstractAlgebra.FPModule{T}) where T <: RingElement
 
 Return a vector of all the relations between generators of the given
 module, where each relation is given as row matrix. The relation matrix
 whose rows are the returned relations will be in reduced form (hnf/rref).
+
+This has a short alias `rels(M)`.
+"""
+relations(M::AbstractAlgebra.FPModule{T}) where T <: RingElement = M.rels::Vector{dense_matrix_type(T)}
+
+@doc raw"""
+    rels(M::AbstractAlgebra.FPModule{T}) where T <: RingElement
+
+Alias for `relations(M)`.
 """
-rels(M::AbstractAlgebra.FPModule{T}) where T <: RingElement = M.rels::Vector{dense_matrix_type(T)}
+rels(M::AbstractAlgebra.FPModule{T}) where T <: RingElement = relations(M)
 
 @doc raw"""
     is_compatible(M::AbstractAlgebra.FPModule{T}, N::AbstractAlgebra.FPModule{T}) where T <: RingElement

src/generic/exports.jl

@@ -102,6 +102,7 @@ export prime
 export push_term!
 export reduce!
 export rel_series_type
+export relations
 export rels
 export rescale!
 export retraction_map