Hyperrectangle (#720)

* Hyperrectangle

* make qN work

* news and bump version

* docs

* update CI codecov settings

* improve coverage

* tests

* tolerance

* improve coverage

* fix injectivity radius

* fix old forgotten convention

* address review

* manifold with corners

* Add some docs

.github/workflows/ci.yml

@@ -32,5 +32,8 @@ jobs:
       - uses: julia-actions/julia-processcoverage@v1
       - uses: codecov/codecov-action@v4
         with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          file: ./lcov.info
+          name: codecov-umbrella
           fail_ci_if_error: false
         if: ${{ matrix.os =='ubuntu-latest' }}

NEWS.md

@@ -5,7 +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.16] – unreleased
+## [0.9.17] – unreleased
+
+### Added
+
+* `Hyperrectangle` manifold with boundary.
+
+## [0.9.16] – 2024-04-01
 
 ### Changed
 

Project.toml

@@ -1,7 +1,7 @@
 name = "Manifolds"
 uuid = "1cead3c2-87b3-11e9-0ccd-23c62b72b94e"
 authors = ["Seth Axen <seth.axen@gmail.com>", "Mateusz Baran <mateuszbaran89@gmail.com>", "Ronny Bergmann <manopt@ronnybergmann.net>", "Antoine Levitt <antoine.levitt@gmail.com>"]
-version = "0.9.16"
+version = "0.9.17"
 
 [deps]
 Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f"

docs/make.jl

@@ -121,6 +121,7 @@ makedocs(;
                 "Grassmann" => "manifolds/grassmann.md",
                 "Hamiltonian" => "manifolds/hamiltonian.md",
                 "Hyperbolic space" => "manifolds/hyperbolic.md",
+                "Hyperrectangle" => "manifolds/hyperrectangle.md",
                 "Lorentzian manifold" => "manifolds/lorentz.md",
                 "Multinomial doubly stochastic matrices" => "manifolds/multinomialdoublystochastic.md",
                 "Multinomial matrices" => "manifolds/multinomial.md",

docs/src/manifolds/grassmann.md

@@ -22,10 +22,9 @@ Pages = ["manifolds/GrassmannProjector.jl"]
 Order = [:type,:function]
 ```
 
-
 ## Literature
 
 ```@bibliography
 Pages = ["grassmann.md"]
 Canonical=false
-```
+```

docs/src/manifolds/hyperrectangle.md

@@ -0,0 +1,20 @@
+# [Hyperrectangle](@id HyperrectangleSection)
+
+Hyperrectangle is a manifold with corners [Joyce:2010](@cite), and also a subset of the real [Euclidean](@ref Main.Manifolds.Euclidean) manifold.
+It is useful for box-constrained optimization, for example it is implicitly used in the classic L-BFGS-B algorithm.
+
+!!! note
+    This is a manifold with corners. Some parts of its interface specific to this property are experimental and may change without a breaking release.
+
+```@autodocs
+Modules = [Manifolds]
+Pages = ["manifolds/Hyperrectangle.jl"]
+Order = [:type,:function]
+```
+
+## Literature
+
+```@bibliography
+Pages = ["hyperrectangle.md"]
+Canonical=false
+```

docs/src/references.bib

@@ -453,6 +453,15 @@ @article{JourneeBachAbsilSepulchre:2010
     TITLE      = {Low-Rank Optimization on the Cone of Positive Semidefinite Matrices},
     JOURNAL    = {SIAM Journal on Optimization}
 }
+
+@misc{Joyce:2010,
+	TITLE = {On manifolds with corners},
+	DOI = {10.48550/arXiv.0910.3518},
+	AUTHOR = {Joyce, Dominic},
+	YEAR = {2010},
+    EPRINT       = {0910.3518},
+    EPRINTTYPE   = {arXiv}
+}
 #
 # K
 # ----------------------------------------------------------------------------------------

src/Manifolds.jl

@@ -428,6 +428,7 @@ include("manifolds/FlagStiefel.jl")
 include("manifolds/GeneralizedGrassmann.jl")
 include("manifolds/GeneralizedStiefel.jl")
 include("manifolds/Hyperbolic.jl")
+include("manifolds/Hyperrectangle.jl")
 include("manifolds/MultinomialDoublyStochastic.jl")
 include("manifolds/MultinomialSymmetric.jl")
 include("manifolds/MultinomialSymmetricPositiveDefinite.jl")
@@ -645,6 +646,7 @@ export Euclidean,
     HamiltonianMatrices,
     HeisenbergGroup,
     Hyperbolic,
+    Hyperrectangle,
     KendallsPreShapeSpace,
     KendallsShapeSpace,
     Lorentz,

src/manifolds/Euclidean.jl

@@ -407,7 +407,7 @@ where ``I`` is the set of vectors ``k ∈ ℕ^i``, such that for all
 For the special case of ``i ≤ 2``, i.e. matrices and vectors, this simplifies to
 
 ````math
-g_p(X,Y) = X^{\mathrm{H}}Y,
+g_p(X,Y) = \operatorname{tr}(X^{\mathrm{H}}Y),
 ````
 
 where ``⋅^{\mathrm{H}}`` denotes the Hermitian, i.e. complex conjugate transposed.
@@ -745,7 +745,6 @@ end
 
 Compute the Riemann tensor ``R(X,Y)Z`` at point `p` on [`Euclidean`](@ref) manifold `M`.
 Its value is always the zero tangent vector.
-````
 """
 riemann_tensor(M::Euclidean, p, X, Y, Z)
 
@@ -894,13 +893,13 @@ Weingarten(::Euclidean, p, X, V)
 Weingarten!(::Euclidean, Y, p, X, V) = fill!(Y, 0)
 
 """
-    zero_vector(M::Euclidean, x)
+    zero_vector(M::Euclidean, p)
 
-Return the zero vector in the tangent space of `x` on the [`Euclidean`](@ref)
-`M`, which here is just a zero filled array the same size as `x`.
+Return the zero vector in the tangent space of `p` on the [`Euclidean`](@ref)
+`M`, which here is just a zero filled array the same size as `p`.
 """
 zero_vector(::Euclidean, ::Any...)
 zero_vector(::Euclidean{TypeParameter{Tuple{}}}, p::Number) = zero(p)
 zero_vector(::Euclidean{Tuple{}}, p::Number) = zero(p)
 
-zero_vector!(::Euclidean, v, ::Any) = fill!(v, 0)
+zero_vector!(::Euclidean, X, ::Any) = fill!(X, 0)