Deprecate Symplectic in favour of SynplecticMatrices (cf. #701 Point 1)

NEWS.md

@@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.9.x] – 2024-01-18
+
+* Introduce the manifold of `HamiltonianMatrices` and a wrapper for `Hamiltonian` matrices
+* introduce `rand(:HamiltonianMatrices)`
+* Rename (deprecate) `Symplectic` to `SimplecticMatrices` in order to have a `Symplectic` wrapper for such matrices as well
+* Rename (deprecate) `SymplecticMatrix` to `SymplecticElement` to cclarify that it is the special matrix ``J_{2n}`` and not an arbitrary symplectic matrix.
+
 ## [0.9.11] – 2023-12-27
 
 ### Fixed

docs/make.jl

@@ -133,7 +133,7 @@ makedocs(;
                 "Symmetric positive definite" => "manifolds/symmetricpositivedefinite.md",
                 "SPD, fixed determinant" => "manifolds/spdfixeddeterminant.md",
                 "Symmetric positive semidefinite fixed rank" => "manifolds/symmetricpsdfixedrank.md",
-                "Symplectic" => "manifolds/symplectic.md",
+                "Symplectic matrices" => "manifolds/symplectic.md",
                 "Symplectic Stiefel" => "manifolds/symplecticstiefel.md",
                 "Torus" => "manifolds/torus.md",
                 "Tucker" => "manifolds/tucker.md",

docs/src/manifolds/symplectic.md

@@ -1,6 +1,6 @@
-# Symplectic
+# Symplectic matrices
 
-The [`Symplectic`](@ref) manifold, denoted $\operatorname{Sp}(2n, \mathbb{F})$, is a closed, embedded, submanifold of
+The [`SymplecticMatrices`](@ref) manifold, denoted $\operatorname{Sp}(2n, \mathbb{F})$, is a closed, embedded, submanifold of
 $\mathbb{F}^{2n \times 2n}$ that represents transformations into symplectic subspaces which keep the
 canonical symplectic form over $\mathbb{F}^{2n \times 2n }$ invariant under the standard embedding inner product.
 The canonical symplectic form is a non-degenerate bilinear and skew symmetric map

docs/src/manifolds/symplecticstiefel.md

@@ -20,7 +20,7 @@ Specifically given an element $p \in \operatorname{SpSt}(2n, 2k)$ we require tha
     \omega_{2n} (p x, p y) = x^T(p^TQ_{2n}p)y = x^TQ_{2k}y = \omega_{2k}(x, y) \;\forall\; x, y \in \mathbb{F}^{2k},
 ````
 leading to the requirement on $p$ that $p^TQ_{2n}p = Q_{2k}$.
-In the case that $k = n$, this manifold reduces to the [`Symplectic`](@ref) manifold, which is also known as the symplectic group.
+In the case that $k = n$, this manifold reduces to the [`SymplecticMatrices`](@ref) manifold, which is also known as the symplectic group.
 
 ```@autodocs
 Modules = [Manifolds]

src/Manifolds.jl

@@ -658,7 +658,7 @@ export Euclidean,
     SymmetricPositiveDefinite,
     SPDFixedDeterminant,
     SymmetricPositiveSemidefiniteFixedRank,
-    Symplectic,
+    SymplecticMatrices,
     SymplecticStiefel,
     SymplecticMatrix,
     Torus,

src/deprecated.jl

@@ -4,3 +4,6 @@
     f,
 )
 @deprecate ExtrinsicEstimation() ExtrinsicEstimation(EfficientEstimator())
+
+Base.@deprecate_binding Symplectic SymplecticMatrices
+#Base.@deprecate_binding SynplecticMatrix SymplecticElement