Skip to content

Commit

Permalink
Typos.
Browse files Browse the repository at this point in the history
A final commit for today.
  • Loading branch information
kellertuer committed Oct 17, 2024
1 parent ae96b81 commit a9dfa34
Show file tree
Hide file tree
Showing 6 changed files with 35 additions and 23 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:
runs-on: ${{ matrix.os }}
strategy:
matrix:
julia-version: ["1.6", "1.10", "~1.11.0-0"]
julia-version: ["1.6", "1.10", "1.11"]
os: [ubuntu-latest, macOS-latest]
steps:
- uses: actions/checkout@v4
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/documenter.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ jobs:
version: "1.4.551"
- uses: julia-actions/setup-julia@latest
with:
version: "1.10"
version: "1.11"
- name: Julia Cache
uses: julia-actions/cache@v2
- name: Cache Quarto
Expand Down
9 changes: 5 additions & 4 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -118,10 +118,11 @@ makedocs(;
"Home" => "index.md",
"About" => "about.md",
(tutorials_in_menu ? [tutorials_menu] : [])...,
"An Interface for ..." => [
"A Lie group and algebra" => "interface/group.md",
"A group operation" => "interface/operations.md",
"A group action" => "interface/actions.md",
"Interfaces" => [
"Lie group" => "interface/group.md",
"Lie algebra" => "interface/algebra.md",
"Group operation" => "interface/operations.md",
"Group action" => "interface/actions.md",
],
"Lie groups" => [
"List of Lie Groups" => "groups/index.md",
Expand Down
20 changes: 20 additions & 0 deletions docs/src/interface/algebra.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# The interface for Lie algebras

```@docs
LieAlgebra
```

## Functions on Lie algebras

```@autodocs
Modules = [LieGroups]
Pages = ["src/Lie_algebra/Lie_algebra_interface.jl"]
Order = [:function]
```

## Literature

```@bibliography
Pages = ["group.md"]
Canonical=false
```
11 changes: 1 addition & 10 deletions docs/src/interface/group.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# The interface for Lie Groups and Lie algebras
# The interface for Lie Groups

```@docs
LieGroup
LieAlgebra
```

## Functions on Lie groups
Expand All @@ -13,14 +12,6 @@ Pages = ["src/interface.jl"]
Order = [:function]
```

## Functions on Lie algebras

```@autodocs
Modules = [LieGroups]
Pages = ["src/Lie_algebra/Lie_algebra_interface.jl"]
Order = [:function]
```

## Literature

```@bibliography
Expand Down
14 changes: 7 additions & 7 deletions src/group_operations/addition.jl
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ _doc_diff_conjugate_add = """
diff_conjugate((G::LieGroup{𝔽,AdditionGroupOperation}, Y, g, h, X))
diff_conjugate!(G::LieGroup{𝔽,AdditionGroupOperation}, Y, g, h, X)
Compute the differential of the conjutage ````c_g(h) = g$(_math(:))h$(_math(:))g^{-1} = g+h-g = h``,
which simplifies for [`AdditionGroupOperation`] to`` D(c_g(h))[X] = X``.
Compute the differential of the conjutage ``c_g(h) = g$(_math(:))h$(_math(:))g^{-1} = g+h-g = h``,
which simplifies for [`AdditionGroupOperation`](@ref) to`` D(c_g(h))[X] = X``.
"""

@doc "$(_doc_diff_conjugate_add)"
Expand All @@ -63,8 +63,8 @@ _doc_diff_inv_add = """
diff_inv(G::LieGroup{𝔽,AdditionGroupOperation}, g, X)
diff_inv!(G::LieGroup{𝔽,AdditionGroupOperation}, Y, g, X)
Compute the differential of the inverse operation ``ι_{$(_math(:G))}(g) = g^-1`` = -g``,
which simplifies for [`AdditionGroupOperation`] to ```Dι_{$(_math(:G))}(g)[X] = -X```
Compute the differential of the inverse operation ``ι_{$(_math(:G))}(g) = g^-1 = -g``,
which simplifies for [`AdditionGroupOperation`](@ref) to ``Dι_{$(_math(:G))}(g)[X] = -X``
"""

@doc "$(_doc_diff_inv_add)"
Expand All @@ -80,7 +80,7 @@ _doc_diff_left_compose_add = """
diff_left_compose!(G::LieGroup{𝔽,AdditionGroupOperation}, Y, g, h, X)
Compute the differential of the left group multiplication ``λ_g(h) = g$(_math(:))h``,
which simplifies for [`AdditionGroupOperation`] to ``Dλ_g(h)[X] = X``.
which simplifies for [`AdditionGroupOperation`](@ref) to ``Dλ_g(h)[X] = X``.
"""

@doc "$(_doc_diff_left_compose_add)"
Expand All @@ -96,7 +96,7 @@ _doc_diff_right_compose_add = """
diff_right_compose!(G::LieGroup{𝔽,AdditionGroupOperation}, Y, h, g, X)
Compute the differential of the right group multiplication ``ρ_g(h) = h$(_math(:))g``,
which simplifies for [`AdditionGroupOperation`] to ``Dρ_g(h)[X] = X``.
which simplifies for [`AdditionGroupOperation`](@ref) to ``Dρ_g(h)[X] = X``.
"""

@doc "$(_doc_diff_right_compose_add)"
Expand Down Expand Up @@ -171,7 +171,7 @@ _doc_lie_bracket_add = """
Compute the Lie bracket ``[⋅,⋅]: $(_math(:𝔤))×$(_math(:𝔤))$(_math(:𝔤))``,
which for the for the [`AdditionGroupOperation`](@ref) simplifies to the
correspondin$(_link(:zero_vector)).
corresponding $(_link(:zero_vector)).
The computation can be done in-place of `Z`.
"""

Expand Down

0 comments on commit a9dfa34

Please sign in to comment.