Skip to content

Commit

Permalink
Add docstring for reflect, reflect!
Browse files Browse the repository at this point in the history
  • Loading branch information
janikapeters committed Dec 20, 2024
1 parent 5877373 commit a3871cd
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions src/LieTheory/WeightLattice.jl
Original file line number Diff line number Diff line change
Expand Up @@ -463,10 +463,24 @@ function reflect!(w::WeightLatticeElem, s::Int)
return w
end

@doc raw"""
reflect(w::WeightLatticeElem, beta::RootSpaceElem) -> RootSpaceElem
Return the reflection of `w` in the hyperplane orthogonal to root `beta`.
See also: [`reflect!(::WeightLatticeElem, ::RootSpaceElem)`](@ref).
"""
function reflect(w::WeightLatticeElem, beta::RootSpaceElem)
return reflect!(deepcopy(w), beta)
end

@doc raw"""
reflect!(w::WeightLatticeElem, beta::RootSpaceElem) -> RootSpaceElem
Reflect `w` in the hyperplane orthogonal to the root `beta`, and return it.
This is a mutating version of [`reflect(::WeightLatticeElem, ::RootSpaceElem)`](@ref).
"""
function reflect!(w::WeightLatticeElem, beta::RootSpaceElem)
@req root_system(w) === root_system(beta) "Incompatible root systems"
for s in word(reflection(beta))
Expand Down

0 comments on commit a3871cd

Please sign in to comment.