Skip to content

Commit

Permalink
Setup GeneralLinear.
Browse files Browse the repository at this point in the history
  • Loading branch information
kellertuer committed Oct 24, 2024
1 parent 5e7a3b9 commit e276573
Show file tree
Hide file tree
Showing 7 changed files with 23 additions and 3 deletions.
1 change: 1 addition & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ Everything denoted by “formerly” refers to the previous name in [`Manifolds.
* `compose` and `compose!`
* `conjugate` and `conjugate!`
* `diff_apply`, `diff_apply!`, `diff_group_apply`, and `diff_group_apply!` (formerly `apply_diff_[group][!]`)
* `diff_conjugate` and `diff_conjugate!`
* `diff_left_compose`, `diff_left_compose!`, `diff_right_compose`, `diff_right_compose!` (formerly `translate_diff` with different sides)
* `exp(G::LieGroup, g, X)` and `exp!(G::LieGroup, h, g, X)` (formerly `exp_inv` and `exp_inv!`)
* `exp(G::LieGroup, ::Identity, X)` and `exp!(G::LieGroup, h, ::Identity, X)` (formerly `exp_lie` and `exp_lie!`)
Expand Down
1 change: 1 addition & 0 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,7 @@ makedocs(;
],
"Lie groups" => [
"List of Lie Groups" => "groups/index.md",
"General Linear" => "groups/general_linear.md",
"Translation group" => "groups/translation.md",
],
"Contributing to LieGroups.jl" => "contributing.md",
Expand Down
5 changes: 5 additions & 0 deletions docs/src/groups/general_linear.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# The general linear group

```@docs
GeneralLinearGroup
```
1 change: 1 addition & 0 deletions docs/src/groups/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,5 @@

| Group | Manifold | ```` | Comment |
|:------|:---------|:---------:|:------|
| [`GeneralLinearGroup`](@ref) | [`InvertibleMatrices`](@extref `Manifolds.InvertibleMatrices`) | [`*`](@ref MatrixMultiplicationGroupOperation) | |
| [`TranslationGroup`](@ref) | [`Euclidean`](@extref `Manifolds.Euclidean`) | [`+`](@ref AdditionGroupOperation) | |
10 changes: 9 additions & 1 deletion docs/src/interface/operations.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,14 @@ The following sections collect these.

```@autodocs
Modules = [LieGroups]
Pages = ["addition.jl"]
Pages = ["addition_operation.jl"]
Order = [:type, :function]
```

## [Multiplication group operation](@id multiplication-operation-sec)

```@autodocs
Modules = [LieGroups]
Pages = ["multiplication_operation.jl"]
Order = [:type, :function]
```
2 changes: 2 additions & 0 deletions src/LieGroups.jl
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ export LieGroup, LieAlgebra

export AbstractGroupOperation, Identity
export AdditionGroupOperation
export AbstractMultiplicationGroupOperation
export MatrixMultiplicationGroupOperation

export AbstractGroupActionType, AbstractGroupAction
export AbstractLeftGroupActionType, AbstractRightGroupActionType
Expand Down
6 changes: 4 additions & 2 deletions src/groups/general_linear_group.jl
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

@doc """
@doc raw"""
GeneralLinearGroup{𝔽,T}
The general linear group ``\operatorname{GL}(n)`` is the set of all invertible matrices in ``𝔽^{n×n}``
Expand All @@ -13,7 +13,9 @@ Generate the general linear group group on ``𝔽^{n×n}``.
All keyword arguments in `kwargs...` are passed on to [`InvertibleMatrices`](@extref `Manifolds.InvertibleMatrices`).
"""
const GeneralLinearGroup{𝔽,T} = LieGroup{
𝔽,MatrixMultiplicationGroupOperation,Manifolds.InvertibleMatrices{𝔽,T}
𝔽,
MatrixMultiplicationGroupOperation,
Manifolds.InvertibleMatrices{𝔽,T},
}

function GeneralLinearGroup(n::Int...; kwargs...)
Expand Down

0 comments on commit e276573

Please sign in to comment.