Skip to content

Commit

Permalink
address comments
Browse files Browse the repository at this point in the history
Call `echelon_form` instead of `rref`,
rename the function accordingly.
(Also `echelon_form` cannot be referenced via `@ref`.)
  • Loading branch information
ThomasBreuer committed Nov 14, 2024
1 parent f2f9993 commit 3331b86
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 12 deletions.
2 changes: 1 addition & 1 deletion docs/src/Groups/action.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ on_sets
permuted
on_indeterminates
on_lines
on_rref_mats
on_echelon_form_mats
on_subgroups
```

Expand Down
20 changes: 10 additions & 10 deletions src/Groups/action.jl
Original file line number Diff line number Diff line change
Expand Up @@ -456,18 +456,18 @@ on_subgroups(x::T, g::GAPGroupElem) where T <: GAPGroup = T(on_subgroups(GapObj(


@doc raw"""
on_rref_mats(m::MatElem{T}, x::MatrixGroupElem) where T <: FinFieldElem
on_echelon_form_mats(m::MatElem{T}, x::MatrixGroupElem) where T <: FinFieldElem
Return the image of `m` under `x`,
where the action is given by first computing the product `m * x`
and then normalizing the result by computing its reduced row echelon form,
see [`rref(M::MatrixElem{T})`](@ref).
and then normalizing the result by computing its reduced row echelon form
with `echelon_form`.
Identifying `m` with the subspace of the natural module for the group of `x`
that is generated by the rows of `m`,
`on_rref_mats` describes the action on subspaces of this natural module.
Note that for computing the orbit and stabilizer of `m` w.r.t. `on_rref_mats`,
`m` must be in reduced row echelon form.
`on_echelon_form_mats` describes the action on subspaces of this natural module.
Note that for computing the orbit and stabilizer of `m` w.r.t.
`on_echelon_form_mats`, `m` must be in reduced row echelon form.
# Examples
```jldoctest
Expand All @@ -482,15 +482,15 @@ julia> m = matrix(embW)
[1 0 0]
[0 0 1]
julia> S, _ = stabilizer(G, m, on_rref_mats); order(S)
julia> S, _ = stabilizer(G, m, on_echelon_form_mats); order(S)
24
julia> orb = orbit(G, on_rref_mats, m); length(orb)
julia> orb = orbit(G, on_echelon_form_mats, m); length(orb)
7
```
"""
function on_rref_mats(m::MatElem{T}, x::MatrixGroupElem) where T <: FinFieldElem
return rref(m * x)[2]
function on_echelon_form_mats(m::MatElem{T}, x::MatrixGroupElem) where T <: FinFieldElem
return echelon_form(m * x)[2]
end

@doc raw"""
Expand Down
2 changes: 1 addition & 1 deletion src/exports.jl
Original file line number Diff line number Diff line change
Expand Up @@ -1172,7 +1172,7 @@ export objective_function
export omega_group
export on_indeterminates
export on_lines
export on_rref_mats
export on_echelon_form_mats
export on_sets
export on_sets_sets
export on_simplicial_complex
Expand Down

0 comments on commit 3331b86

Please sign in to comment.