Fixes Douglas Rachford Tests (#35)

* fixes DR tests.
* switch to new formatter style and a style file.
* fix random_point for SPD and increase code coverage.
* fixes proxes to new manifolds.
* fix the SPD example.

Author: kellertuer

.JuliaFormatter.toml

@@ -0,0 +1 @@
+style = "blue"

.github/workflows/format.yml

@@ -17,15 +17,7 @@ jobs:
       - name: Install JuliaFormatter and format
         run: |
           julia  -e 'using Pkg; Pkg.add(PackageSpec(name="JuliaFormatter"))'
-          julia  -e 'using JuliaFormatter; format(
-              ".",
-              short_to_long_function_def = true,
-              always_for_in = true,
-              whitespace_ops_in_indices = true,
-              pipe_to_function_call = true,
-              import_to_using = true,
-              always_use_return = true,
-          )'
+          julia  -e 'using JuliaFormatter; format(".")'
       - name: Check format
         run: |
           julia -e '

Project.toml

@@ -1,7 +1,7 @@
 name = "Manopt"
 uuid = "0fc0a36d-df90-57f3-8f93-d78a9fc72bb5"
 authors = ["Ronny Bergmann <manopt@ronnybergmann.net>"]
-version = "0.2.6"
+version = "0.2.7"
 
 [deps]
 ColorSchemes = "35d6a980-a343-548e-a6ea-1d62b119f2f4"
@@ -23,7 +23,7 @@ TestImages = "5e47fb64-e119-507b-a336-dd2b206d9990"
 ColorSchemes = "3.5.0"
 ColorTypes = "0.9.1, 0.10"
 Colors = "0.11.2, 0.12"
-Manifolds = "0.4"
+Manifolds = "0.4.1"
 ManifoldsBase = "0.9"
 StaticArrays = "0.12"
 TestImages = "1.0.0"

docs/Project.toml

@@ -14,5 +14,5 @@ Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
 
 [compat]
 Documenter = "0.24"
-Manifolds = "0.4"
+Manifolds = "0.4.1"
 ManifoldsBase = "0.9"

docs/make.jl

@@ -4,8 +4,9 @@ using Manopt, Documenter, Literate
 tutorialsInputPath = joinpath(@__DIR__, "..", "src/tutorials")
 tutorialsRelativePath = "tutorials/"
 tutorialsOutputPath = joinpath(@__DIR__, "src/" * tutorialsRelativePath)
-tutorials =
-    ["MeanAndMedian", "BezierCurves", "GradientOfSecondOrderDifference", "JacobiFields"]
+tutorials = [
+    "MeanAndMedian", "BezierCurves", "GradientOfSecondOrderDifference", "JacobiFields"
+]
 menuEntries = [
     "get Started: Optimize!",
     "work with Bézier curves",
@@ -20,17 +21,17 @@ for (i, tutorial) in enumerate(tutorials)
     Literate.markdown(
         sourceFile,
         tutorialsOutputPath;
-        name = tutorial,
+        name=tutorial,
         # codefence = "```julia" => "```",
-        credit = false,
+        credit=false,
     )
     push!(TutorialMenu, menuEntries[i] => joinpath(tutorialsRelativePath, tutorial * ".md"))
 end
-makedocs(
-    format = Documenter.HTML(prettyurls = false),
-    modules = [Manopt],
-    sitename = "Manopt.jl",
-    pages = [
+makedocs(;
+    format=Documenter.HTML(; prettyurls=false),
+    modules=[Manopt],
+    sitename="Manopt.jl",
+    pages=[
         "Home" => "index.md",
         "About" => "about.md",
         "How to..." => TutorialMenu,
@@ -67,4 +68,4 @@ makedocs(
         "Function Index" => "list.md",
     ],
 )
-deploydocs(repo = "github.com/JuliaManifolds/Manopt.jl", push_preview = true)
+deploydocs(; repo="github.com/JuliaManifolds/Manopt.jl", push_preview=true)

docs/src/plans/index.md

@@ -54,7 +54,7 @@ update_storage!
 
 ```@autodocs
 Modules = [Manopt]
-Pages = ["plans/debugOptions.jl"]
+Pages = ["plans/debug_options.jl"]
 Order = [:type, :function]
 ```
 
@@ -66,7 +66,7 @@ Further specific [`DebugAction`](@ref)s can be found at the specific Options.
 
 ```@autodocs
 Modules = [Manopt]
-Pages = ["plans/recordOptions.jl"]
+Pages = ["plans/record_options.jl"]
 Order = [:type, :function]
 Private = false
 ```

docs/src/solvers/index.md

@@ -38,7 +38,7 @@ StoppingCriterionSet
 
 ```@autodocs
 Modules = [Manopt]
-Pages = ["plans/stoppingCriterion.jl"]
+Pages = ["plans/stopping_criterion.jl"]
 Order = [:type]
 ```
 

examples/Minimize_Acceleration/R3_Bezier.jl

@@ -14,8 +14,8 @@ This example appeared in Sec. 5.2, second example, of
 using Manopt, Manifolds, Colors, ColorSchemes, Makie
 λ = 50.0
 
-curve_samples = [range(0, 3, length = 1601)...] # sample curve for the gradient
-curve_samples_plot = [range(0, 3, length = 1601)...] # sample curve for asy exports
+curve_samples = [range(0, 3; length=1601)...] # sample curve for the gradient
+curve_samples_plot = [range(0, 3; length=1601)...] # sample curve for asy exports
 
 experimentFolder = "examples/Minimize_Acceleration/R3_Bezier/"
 experimentName = "Bezier_R3_Approximation"
@@ -51,12 +51,7 @@ pB = get_bezier_points(M, B, :differentiable)
 N = PowerManifold(M, NestedPowerRepresentation(), length(pB))
 function F(pB)
     return cost_L2_acceleration_bezier(
-        M,
-        pB,
-        get_bezier_degrees(M, B),
-        curve_samples,
-        λ,
-        dataP,
+        M, pB, get_bezier_degrees(M, B), curve_samples, λ, dataP
     )
 end
 ∇F(pB) = ∇L2_acceleration_bezier(M, pB, get_bezier_degrees(M, B), curve_samples, λ, dataP)
@@ -66,13 +61,13 @@ pB_opt = gradient_descent(
     F,
     ∇F,
     x0;
-    stepsize = ArmijoLinesearch(1.0, ExponentialRetraction(), 0.5, 0.0001), # use Armijo lineSearch
-    stopping_criterion = StopWhenAny(
+    stepsize=ArmijoLinesearch(1.0, ExponentialRetraction(), 0.5, 0.0001), # use Armijo lineSearch
+    stopping_criterion=StopWhenAny(
         StopWhenChangeLess(10.0^(-16)),
         StopWhenGradientNormLess(10.0^-9),
         StopAfterIteration(300),
     ),
-    debug = [
+    debug=[
         :Stop,
         :Iteration,
         " | ",
@@ -96,15 +91,15 @@ scatter!(
     scene,
     [p0[1], p1[1], p2[1], p3[1]],
     [p0[2], p1[2], p2[2], p3[2]],
-    [p0[3], p1[3], p2[3], p3[3]],
-    color = pColor,
+    [p0[3], p1[3], p2[3], p3[3]];
+    color=pColor,
 )
 
-lines!(scene, resPmat[1, :], resPmat[2, :], resPmat[3, :], color = ξColor, linewidth = 1.5)
+lines!(scene, resPmat[1, :], resPmat[2, :], resPmat[3, :]; color=ξColor, linewidth=1.5)
 scatter!(
     scene,
     [res_cp[1][1], res_cp[2][1], res_cp[3][1], res_cp[4][1]],
     [res_cp[1][2], res_cp[2][2], res_cp[3][2], res_cp[4][2]],
-    [res_cp[1][3], res_cp[2][3], res_cp[3][3], res_cp[4][3]],
-    color = dColor,
+    [res_cp[1][3], res_cp[2][3], res_cp[3][3], res_cp[4][3]];
+    color=dColor,
 )

examples/Minimize_Acceleration/S2_Bezier_Approximation.jl

@@ -15,8 +15,8 @@ using Manopt, Manifolds, Colors, ColorSchemes
 asyExport = true #export data and results to asyExport
 λ = 10.0
 
-curve_samples = [range(0, 3, length = 101)...] # sample curve for the gradient
-curve_samples_plot = [range(0, 3, length = 201)...] # sample curve for asy exports
+curve_samples = [range(0, 3; length=101)...] # sample curve for the gradient
+curve_samples_plot = [range(0, 3; length=201)...] # sample curve for asy exports
 
 experimentFolder = "examples/Minimize_Acceleration/S2_Bezier/"
 experimentName = "Bezier_Approximation"
@@ -39,36 +39,29 @@ dataP = get_bezier_junctions(M, B)
 if asyExport
     asymptote_export_S2_signals(
         experimentFolder * experimentName * "-orig.asy";
-        curves = [cP],
-        points = [get_bezier_junctions(M, B), get_bezier_inner_points(M, B)],
-        tVectors = [[
+        curves=[cP],
+        points=[get_bezier_junctions(M, B), get_bezier_inner_points(M, B)],
+        tVectors=[[
             Tuple(a)
             for
             a in
             zip(get_bezier_junctions(M, B, true), get_bezier_junction_tangent_vectors(M, B))
         ]],
-        colors = Dict(
-            :curves => [curveColor],
-            :points => [dColor, bColor],
-            :tvectors => [ξColor],
+        colors=Dict(
+            :curves => [curveColor], :points => [dColor, bColor], :tvectors => [ξColor]
         ),
-        cameraPosition = cameraPosition,
-        arrowHeadSize = 10.0,
-        lineWidths = [1.5, 1.5],
-        dotSize = 4.0,
+        cameraPosition=cameraPosition,
+        arrowHeadSize=10.0,
+        lineWidths=[1.5, 1.5],
+        dotSize=4.0,
     )
-    render_asymptote(experimentFolder * experimentName * "-orig.asy"; render = 4)
+    render_asymptote(experimentFolder * experimentName * "-orig.asy"; render=4)
 end
 pB = get_bezier_points(M, B, :differentiable)
 N = PowerManifold(M, NestedPowerRepresentation(), length(pB))
 function F(pB)
     return cost_L2_acceleration_bezier(
-        M,
-        pB,
-        get_bezier_degrees(M, B),
-        curve_samples,
-        λ,
-        dataP,
+        M, pB, get_bezier_degrees(M, B), curve_samples, λ, dataP
     )
 end
 ∇F(pB) = ∇L2_acceleration_bezier(M, pB, get_bezier_degrees(M, B), curve_samples, λ, dataP)
@@ -78,13 +71,13 @@ pB_opt = gradient_descent(
     F,
     ∇F,
     x0;
-    stepsize = ArmijoLinesearch(1.0, ExponentialRetraction(), 0.5, 0.001), # use Armijo lineSearch
-    stopping_criterion = StopWhenAny(
+    stepsize=ArmijoLinesearch(1.0, ExponentialRetraction(), 0.5, 0.001), # use Armijo lineSearch
+    stopping_criterion=StopWhenAny(
         StopWhenChangeLess(10.0^(-5)),
         StopWhenGradientNormLess(10.0^-7),
         StopAfterIteration(300),
     ),
-    debug = [
+    debug=[
         :Stop,
         :Iteration,
         " | ",
@@ -105,25 +98,25 @@ res_curve = de_casteljau(M, B_opt, curve_samples_plot)
 if asyExport
     asymptote_export_S2_signals(
         experimentFolder * experimentName * "-result.asy";
-        curves = [res_curve, cP],
-        points = [get_bezier_junctions(M, B_opt), get_bezier_inner_points(M, B_opt)],
-        tVectors = [[
+        curves=[res_curve, cP],
+        points=[get_bezier_junctions(M, B_opt), get_bezier_inner_points(M, B_opt)],
+        tVectors=[[
             Tuple(a)
             for
             a in zip(
                 get_bezier_junctions(M, B_opt, true),
                 get_bezier_junction_tangent_vectors(M, B_opt),
             )
         ]],
-        colors = Dict(
+        colors=Dict(
             :curves => [curveColor, pColor],
             :points => [dColor, bColor],
             :tvectors => [ξColor],
         ),
-        cameraPosition = cameraPosition,
-        arrowHeadSize = 10.0,
-        lineWidths = [1.5, 0.75, 1.5],
-        dotSize = 4.0,
+        cameraPosition=cameraPosition,
+        arrowHeadSize=10.0,
+        lineWidths=[1.5, 0.75, 1.5],
+        dotSize=4.0,
     )
-    render_asymptote(experimentFolder * experimentName * "-result.asy"; render = 4)
+    render_asymptote(experimentFolder * experimentName * "-result.asy"; render=4)
 end

examples/Minimize_Acceleration/S2_Bezier_Approximation_lambda_video.jl

@@ -18,11 +18,11 @@ render_detail = 2
 asy_export = true
 asy_export_summary = true
 render_video = true
-λRange = collect(range(10.0, 0.0, length = 1001))[1:(end - 1)] #exclude zero.
-colors = RGBA.(get.(Ref(viridis), range(0.0, 1.0, length = length(λRange))))
+λRange = collect(range(10.0, 0.0; length=1001))[1:(end - 1)] #exclude zero.
+colors = RGBA.(get.(Ref(viridis), range(0.0, 1.0; length=length(λRange))))
 
-curve_samples = [range(0, 3, length = 101)...] # sample curve for the gradient
-curve_samples_plot = [range(0, 3, length = 201)...] # sample curve for asy exports
+curve_samples = [range(0, 3; length=101)...] # sample curve for the gradient
+curve_samples_plot = [range(0, 3; length=201)...] # sample curve for asy exports
 
 experimentFolder = "examples/Minimize_Acceleration/S2_Bezier/video/"
 experimentName = "Bezier_Approximation_video"
@@ -48,12 +48,11 @@ for i in eachindex(λRange)
         F,
         ∇F,
         x0;
-        stepsize = ArmijoLinesearch(1.0, ExponentialRetraction(), 0.5, 0.001),
-        stopping_criterion = StopWhenAny(
-            StopWhenChangeLess(5 * 10.0^(-6)),
-            StopAfterIteration(15000),
+        stepsize=ArmijoLinesearch(1.0, ExponentialRetraction(), 0.5, 0.001),
+        stopping_criterion=StopWhenAny(
+            StopWhenChangeLess(5 * 10.0^(-6)), StopAfterIteration(15000)
         ),
-        debug = [
+        debug=[
             :Stop,
             "$(λ) ",
             :Iteration,
@@ -79,33 +78,31 @@ if asy_export
         B_opt = get_bezier_segments(M, results[i], degs, :differentiable)
         asymptote_export_S2_signals(
             experimentFolder * experimentName * "-$(@sprintf "%04.0f" i)-result.asy";
-            curves = [resulting_curves[i], cP],
-            points = [get_bezier_junctions(M, B_opt), get_bezier_inner_points(M, B_opt)],
-            colors = Dict(
-                :curves => [colors[i], curveColor],
-                :points => [colors[i], colors[i]],
+            curves=[resulting_curves[i], cP],
+            points=[get_bezier_junctions(M, B_opt), get_bezier_inner_points(M, B_opt)],
+            colors=Dict(
+                :curves => [colors[i], curveColor], :points => [colors[i], colors[i]]
             ),
-            cameraPosition = cameraPosition,
-            lineWidths = [1.0, 0.5],
-            dotSize = 2.0,
+            cameraPosition=cameraPosition,
+            lineWidths=[1.0, 0.5],
+            dotSize=2.0,
         )
         render_asymptote(
             experimentFolder * experimentName * "-$(@sprintf "%04.0f" i)-result.asy";
-            render = render_detail,
+            render=render_detail,
         )
     end
 end
 if asy_export_summary
     asymptote_export_S2_signals(
         experimentFolder * experimentName * "-Summary-result.asy";
-        curves = [cP, resulting_curves...],
-        colors = Dict(:curves => [curveColor, colors...]),
-        cameraPosition = cameraPosition,
-        lineWidths = [0.75, [1.5 for i in eachindex(λRange)]...],
+        curves=[cP, resulting_curves...],
+        colors=Dict(:curves => [curveColor, colors...]),
+        cameraPosition=cameraPosition,
+        lineWidths=[0.75, [1.5 for i in eachindex(λRange)]...],
     )
     render_asymptote(
-        experimentFolder * experimentName * "-Summary-result.asy";
-        render = render_detail,
+        experimentFolder * experimentName * "-Summary-result.asy"; render=render_detail
     )
 end
 if render_video