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

UTF8 Documentation rework #104

Merged
merged 79 commits into from
Feb 5, 2020
Merged
Changes from 1 commit
Commits
Show all changes
79 commits
Select commit Hold shift + click to select a range
436eb29
update documentation to use more utf8, especially in math.
kellertuer Jan 25, 2020
fade359
update documentation, where this might not be that useful.
kellertuer Jan 25, 2020
8fca61f
Adds a notation page.
kellertuer Jan 25, 2020
ed6a6f1
\circ -> ⚬
kellertuer Jan 25, 2020
5f00666
fixes circ, since I mistakenly took the wrong circ.
kellertuer Jan 25, 2020
8ab0928
refactors a few further M.
kellertuer Jan 25, 2020
ed30878
removes a spurious 𝒩.
kellertuer Jan 26, 2020
103f773
Update docs/src/notation.md
kellertuer Jan 28, 2020
4bbd3da
Update src/manifolds/Hyperbolic.jl
kellertuer Jan 28, 2020
ffdcb35
replaces \gets with ←
kellertuer Jan 28, 2020
9bac84d
Merge branch 'documentation-rework' of github.com:JuliaNLSolvers/Mani…
kellertuer Jan 28, 2020
3cfa995
\dots to …
kellertuer Jan 28, 2020
7aba7f8
Replaces \to with → in docstrings.
kellertuer Jan 28, 2020
b0db476
Replace greek letters.
kellertuer Jan 28, 2020
ab8dc0e
Replaces \in \neq and \colon with their utf8s.
kellertuer Jan 28, 2020
783cebb
Changes lfloor and lfloor to their utf8s.
kellertuer Jan 28, 2020
7427d2a
revert ⨉ back to \times.
kellertuer Jan 28, 2020
adf01f7
revert ◦ back to \circ.
kellertuer Jan 28, 2020
eadf25a
removes double-mentioned functions.
kellertuer Jan 28, 2020
c7e8bbf
Fixes the notations table.
kellertuer Jan 28, 2020
e87d942
Fixes a copy-paste-error.
kellertuer Jan 28, 2020
d8d3c59
removes a few files that I added accidentially.
kellertuer Jan 28, 2020
177363e
move from x to p (to avoid confusion with x and X), revert · to \cdot…
kellertuer Jan 29, 2020
b8d62cc
Reworks/unifies the circle.
kellertuer Jan 29, 2020
06d4058
Finishes the Torus by completeing a docstring, unifies docstringforma…
kellertuer Jan 29, 2020
2b47fda
Merge branch 'master' into documentation-rework
kellertuer Jan 30, 2020
4040b41
update Euclidean docstrings.
kellertuer Jan 30, 2020
0a76a38
Replace \infty with ∞
kellertuer Jan 30, 2020
59ba59b
Starts reworking FixedRank.
kellertuer Jan 30, 2020
2f8a1fa
finishes documentation and variables until end of Hyperbolic manifold.
kellertuer Jan 30, 2020
fa11394
Finishes rework of Metric- and Powermanifold as well as Stiefel
kellertuer Jan 30, 2020
9873a60
Refactor SPD notations, especially LogCholesky now has p,q (X,Y) for …
kellertuer Jan 30, 2020
3474cca
Fixes bugs introduces by renaming Cholsky.
kellertuer Jan 30, 2020
bebdb2d
refactor Sphere & Vector Bundle.
kellertuer Jan 31, 2020
4c904bd
Finishes Symmetric & Rotations, replaces \pi->π.
kellertuer Feb 1, 2020
c5f41a1
rework product manifold.
kellertuer Feb 1, 2020
49e6329
refactor to notation.md
kellertuer Feb 1, 2020
46cbc06
use speaking and longer field names.
kellertuer Feb 1, 2020
f3269de
fixes a typo.
kellertuer Feb 1, 2020
2c46963
Fixes a few more replacement bugs.
kellertuer Feb 1, 2020
ae10f7b
Finally renamex fields `.x` to `.point`
kellertuer Feb 1, 2020
968a942
Fixes further .manifold fields, though I have introduced a bug that I…
kellertuer Feb 1, 2020
57d340c
Fixes two minor typos that were introduced by refactoring.
kellertuer Feb 1, 2020
e463523
fixes two mingled docstrings.
kellertuer Feb 4, 2020
d5cb228
improve capitalization and extend notation.md
kellertuer Feb 4, 2020
6431b7d
Update docs/src/orthonormal_bases.md
kellertuer Feb 4, 2020
7621743
Update src/groups/group.jl
kellertuer Feb 4, 2020
a44bddc
replaces two further math notations by utf8
kellertuer Feb 4, 2020
fc176a6
Merge branch 'documentation-rework' of github.com:JuliaNLSolvers/Mani…
kellertuer Feb 4, 2020
6e8ccb4
Update src/manifolds/CholeskySpace.jl
kellertuer Feb 4, 2020
a514bf2
Update src/manifolds/Circle.jl
kellertuer Feb 4, 2020
78a9b74
Update src/manifolds/ProductManifold.jl
kellertuer Feb 4, 2020
0fc2b70
Update src/manifolds/ProductManifold.jl
kellertuer Feb 4, 2020
3c77b77
Update src/manifolds/ProductManifold.jl
kellertuer Feb 4, 2020
24c8589
Replace wedge and vee by their utf8 representations.
kellertuer Feb 4, 2020
e89dc64
Update src/manifolds/ProductManifold.jl
kellertuer Feb 4, 2020
5ec77b8
Update src/manifolds/Circle.jl
kellertuer Feb 4, 2020
b1614d0
undo \vee since it rendered as a large or, replace `\times` with ×.
kellertuer Feb 4, 2020
4224994
Return from caligraphic UTF8 to $\mathcal ...$
kellertuer Feb 4, 2020
21837c3
replace `\partial` with `∂`.
kellertuer Feb 4, 2020
ddd69b3
Apply suggestions from code review
kellertuer Feb 4, 2020
59be2b2
Replace `\Gamme` with `Γ`.
kellertuer Feb 4, 2020
2a10ef7
update `\dim`.
kellertuer Feb 4, 2020
fcd9977
Merge branch 'documentation-rework' of github.com:JuliaNLSolvers/Mani…
kellertuer Feb 4, 2020
e1c06b0
use `\dim` more consistently throughout the docs of `manifold_dimensi…
kellertuer Feb 4, 2020
07f25b7
rename B.v to B.frame_direction in the DiagonalizingONB.
kellertuer Feb 4, 2020
3f72d23
adds a few test cases, rename B.v to B.frame_direction and unify Met…
kellertuer Feb 4, 2020
8c9cca5
fixes documentation for project tangent on the circle and adds a test.
kellertuer Feb 4, 2020
102c755
unify Metric Manifold to not implement exp/log neither but only exp!/…
kellertuer Feb 4, 2020
0be2cf3
Fixes a typo in MetricManifolds log documentation and explains that f…
kellertuer Feb 4, 2020
d20ab25
change vout to Y, introduce Cartesian product and power to notation, …
kellertuer Feb 5, 2020
92940a7
unifies spacing in math formulae, trace to tr, and adds further terms…
kellertuer Feb 5, 2020
b06cad5
Apply suggestions from code review
kellertuer Feb 5, 2020
741085b
apply the remaining changes from review.
kellertuer Feb 5, 2020
e7bba5c
Finalize notations.md.
kellertuer Feb 5, 2020
64f798f
Merge branch 'documentation-rework' of github.com:JuliaNLSolvers/Mani…
kellertuer Feb 5, 2020
fcb4895
Fixes a final typo.
kellertuer Feb 5, 2020
4e21e0e
unifies usage of \dim.
kellertuer Feb 5, 2020
4bef2c9
updates another docstring.
kellertuer Feb 5, 2020
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
Prev Previous commit
Next Next commit
fixes documentation for project tangent on the circle and adds a test.
kellertuer committed Feb 4, 2020
commit 8c9cca5725db5accf4a6be805c58e644172a0697
1 change: 1 addition & 0 deletions src/manifolds/Circle.jl
Original file line number Diff line number Diff line change
@@ -281,6 +281,7 @@ For the real-valued case this is just the identity.
For the complex valued case `X` is projected onto the line in the complex plane
that is parallel to the tangent to `p` on the unit circle and contains `0`.
"""
project_tangent(::Circle, ::Any, ::Any)
project_tangent(::Circle{ℝ}, p::Real, X::Real) = X
project_tangent(::Circle{ℂ}, p::Number, X::Number) = X - complex_dot(p, X) * p

1 change: 1 addition & 0 deletions test/circle.jl
Original file line number Diff line number Diff line change
@@ -29,6 +29,7 @@ include("utils.jl")
x .+= 2*π
project_point!(M,x)
@test x == MVector(0.0)
@test project_tangent(M,0.0,1.) == 1.
end
types = [Float64, Float32]

2 changes: 2 additions & 0 deletions test/metric.jl
Original file line number Diff line number Diff line change
@@ -282,7 +282,9 @@ end
@test norm(MM2, x, v) === norm(M, x, v)
@test distance(MM2, x, y) === distance(M, x, y)
@test exp!(MM2, y, x, v) === exp!(M, y, x, v)
@test exp(MM2, y, x, v) === exp(M, y, x, v)
@test log!(MM2, v, x, y) === log!(M, v, x, y)
@test log(MM2, v, x, y) === log(M, v, x, y)
@test retract!(MM2, y, x, v) === retract!(M, y, x, v)
@test retract!(MM2, y, x, v, 1) === retract!(M, y, x, v, 1)