Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refine documentation #69

Merged
merged 32 commits into from
May 23, 2021
Merged
Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
681814e
add a definition to the retraction documentation.
kellertuer May 16, 2021
e338102
fix a minor typo.
kellertuer May 16, 2021
778c72b
elaborate on the geodesic.
kellertuer May 16, 2021
cd6fa95
move abstract approximate retractions to base.
kellertuer May 16, 2021
d5bd078
Refactor for better docs.
kellertuer May 16, 2021
a395976
fix a comma mistake.
kellertuer May 16, 2021
07d3101
runs fomatter.
kellertuer May 16, 2021
0be7070
refine the code a little.
kellertuer May 16, 2021
d175f2c
bump version.
kellertuer May 16, 2021
50b5129
remove the actual implementation since it requires a dependency on Re…
kellertuer May 16, 2021
ae4fd4a
Update src/exp_log_geo.jl
kellertuer May 17, 2021
4848a19
Apply suggestions from code review
kellertuer May 17, 2021
f8ad1ff
address points from code review.
kellertuer May 17, 2021
f8e1788
Merge branch 'kellertuer/documentation-refinement' of github.com:Juli…
kellertuer May 17, 2021
d1f4c73
remove on unnecessary variable name.
kellertuer May 17, 2021
849391f
refine documentation.
kellertuer May 17, 2021
4f0e3b2
add a retraction test.
kellertuer May 17, 2021
e5962ce
extend documentation.
kellertuer May 17, 2021
e7cc7f7
Apply suggestions from code review
kellertuer May 18, 2021
1aea407
fix a typo and clarify what the differential is.
kellertuer May 18, 2021
75b6dca
Merge branch 'master' into kellertuer/documentation-refinement
kellertuer May 19, 2021
5857fe5
runs formatter.
kellertuer May 19, 2021
0097fdd
remove duplicate definitions.
kellertuer May 19, 2021
989172d
and two further minor adaptions.
kellertuer May 19, 2021
9e60df8
Document what parallel transport is
kellertuer May 21, 2021
397c00c
Merge branch 'master' into kellertuer/documentation-refinement
kellertuer May 21, 2021
63216e7
Remove a warning since it would trigger every time currently – move i…
kellertuer May 22, 2021
5ebbd40
bump version.
kellertuer May 22, 2021
85a07ef
Merge branch 'master' into kellertuer/documentation-refinement
kellertuer May 22, 2021
4e70eea
bump version.
kellertuer May 22, 2021
3f864a7
Apply suggestions from code review
kellertuer May 23, 2021
2f884b1
refine notation.
kellertuer May 23, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Project.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "ManifoldsBase"
uuid = "3362f125-f0bb-47a3-aa74-596ffd7ef2fb"
authors = ["Seth Axen <[email protected]>", "Mateusz Baran <[email protected]>", "Ronny Bergmann <[email protected]>", "Antoine Levitt <[email protected]>"]
version = "0.10.7"
version = "0.10.9"
kellertuer marked this conversation as resolved.
Show resolved Hide resolved

[deps]
LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
Expand Down
15 changes: 15 additions & 0 deletions src/DecoratorManifold.jl
Original file line number Diff line number Diff line change
Expand Up @@ -574,6 +574,21 @@ decorated_manifold(M::Manifold) = M.manifold
m::LogarithmicInverseRetraction,
)

@decorator_transparent_signature inverse_retract(
mateuszbaran marked this conversation as resolved.
Show resolved Hide resolved
M::AbstractDecoratorManifold,
p,
q,
m::NLsolveInverseRetraction,
)

@decorator_transparent_signature inverse_retract!(
M::AbstractDecoratorManifold,
X,
p,
q,
m::NLsolveInverseRetraction,
)

@decorator_transparent_signature isapprox(M::AbstractDecoratorManifold, p, q; kwargs...)
@decorator_transparent_signature isapprox(M::AbstractDecoratorManifold, p, X, Y; kwargs...)

Expand Down
10 changes: 5 additions & 5 deletions src/DefaultManifold.jl
Original file line number Diff line number Diff line change
Expand Up @@ -46,13 +46,13 @@ embed!(::DefaultManifold, Y, p, X) = copyto!(Y, X)

exp!(::DefaultManifold, q, p, X) = (q .= p .+ X)

function get_basis(M::DefaultManifold, p, B::DefaultOrthonormalBasis)
function get_basis(::DefaultManifold, p, B::DefaultOrthonormalBasis)
return CachedBasis(B, [_euclidean_basis_vector(p, i) for i in eachindex(p)])
end
function get_basis(M::DefaultManifold, p, B::DefaultOrthogonalBasis)
function get_basis(::DefaultManifold, p, B::DefaultOrthogonalBasis)
return CachedBasis(B, [_euclidean_basis_vector(p, i) for i in eachindex(p)])
end
function get_basis(M::DefaultManifold, p, B::DefaultBasis)
function get_basis(::DefaultManifold, p, B::DefaultBasis)
return CachedBasis(B, [_euclidean_basis_vector(p, i) for i in eachindex(p)])
end
function get_basis(M::DefaultManifold, p, B::DiagonalizingOrthonormalBasis)
Expand All @@ -61,12 +61,12 @@ function get_basis(M::DefaultManifold, p, B::DiagonalizingOrthonormalBasis)
return CachedBasis(B, DiagonalizingBasisData(B.frame_direction, eigenvalues, vecs))
end

function get_coordinates!(M::DefaultManifold, Y, p, X, B::DefaultOrthonormalBasis)
function get_coordinates!(M::DefaultManifold, Y, ::Any, X, ::DefaultOrthonormalBasis)
kellertuer marked this conversation as resolved.
Show resolved Hide resolved
copyto!(Y, reshape(X, manifold_dimension(M)))
return Y
end

function get_vector!(M::DefaultManifold, Y, p, X, B::DefaultOrthonormalBasis)
function get_vector!(M::DefaultManifold, Y, ::Any, X, ::DefaultOrthonormalBasis)
copyto!(Y, reshape(X, representation_size(M)))
return Y
end
Expand Down
Loading