Skip to content

Commit 9906efa

Browse files
authored
Explain what inner is supposed to do (#241)
* Explain what `inner` is supposed to do * improve text
1 parent 328f91a commit 9906efa

2 files changed

Lines changed: 13 additions & 1 deletion

File tree

NEWS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1010
### Added
1111

1212
* Reference to `embed_project` in `project` documentation.
13+
* Expanded docs of `inner`.
1314

1415
## [2.0.1] 17/10/2025
1516

src/ManifoldsBase.jl

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -686,7 +686,18 @@ injectivity_radius_exp(M::AbstractManifold) = injectivity_radius(M)
686686
inner(M::AbstractManifold, p, X, Y)
687687
688688
Compute the inner product of tangent vectors `X` and `Y` at point `p` from the
689-
[`AbstractManifold`](@ref) `M`.
689+
[`AbstractManifold`](@ref) `M`. The result type varies by the exact type of `M`:
690+
691+
1. On a [Riemannian manifold](https://en.wikipedia.org/wiki/Riemannian_manifold)
692+
the result is a real number.
693+
2. On an [almost complex manifold](https://en.wikipedia.org/wiki/Almost_complex_manifold)
694+
the result is a complex number.
695+
3. On an [almost quaternionic manifold](https://en.wikipedia.org/wiki/Quaternionic_manifold#Almost_quaternionic_structure)
696+
the result is a quaternion.
697+
4. On a [CR manifold](https://en.wikipedia.org/wiki/CR_manifold) the result may be either
698+
real or complex, depending on the particular manifold.
699+
700+
In cases 2, 3 and 4 the Riemannian inner product can be obtained by taking the real part.
690701
"""
691702
inner(M::AbstractManifold, p, X, Y)
692703

0 commit comments

Comments
 (0)