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.

Sign up for GitHub

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

Jump to bottom

UTF8 Documentation rework #104

Merged
merged 79 commits into from
Feb 5, 2020
Merged

UTF8 Documentation rework #104

merged 79 commits into from
Feb 5, 2020

Commits on Jan 25, 2020

  1. update documentation to use more utf8, especially in math.

    @kellertuer
    kellertuer committed Jan 25, 2020
    Configuration menu
    Copy the full SHA
    436eb29 View commit details
    Browse the repository at this point in the history

  2. update documentation, where this might not be that useful.

    @kellertuer
    kellertuer committed Jan 25, 2020
    Configuration menu
    Copy the full SHA
    fade359 View commit details
    Browse the repository at this point in the history

  3. Adds a notation page.

    @kellertuer
    kellertuer committed Jan 25, 2020
    Configuration menu
    Copy the full SHA
    8fca61f View commit details
    Browse the repository at this point in the history

  4. \circ -> ⚬

    @kellertuer
    kellertuer committed Jan 25, 2020
    Configuration menu
    Copy the full SHA
    ed6a6f1 View commit details
    Browse the repository at this point in the history

  5. fixes circ, since I mistakenly took the wrong circ.

    @kellertuer
    kellertuer committed Jan 25, 2020
    Configuration menu
    Copy the full SHA
    5f00666 View commit details
    Browse the repository at this point in the history

  6. refactors a few further M.

    @kellertuer
    kellertuer committed Jan 25, 2020
    Configuration menu
    Copy the full SHA
    8ab0928 View commit details
    Browse the repository at this point in the history

Commits on Jan 26, 2020

  1. removes a spurious 𝒩.

    @kellertuer
    kellertuer committed Jan 26, 2020
    Configuration menu
    Copy the full SHA
    ed30878 View commit details
    Browse the repository at this point in the history

Commits on Jan 28, 2020

  1. Update docs/src/notation.md 

    Co-Authored-By: Seth Axen <seth.axen@gmail.com>
    @kellertuer @sethaxen
    kellertuer and sethaxen committed Jan 28, 2020
    Configuration menu
    Copy the full SHA
    103f773 View commit details
    Browse the repository at this point in the history

  2. Update src/manifolds/Hyperbolic.jl 

    Co-Authored-By: Seth Axen <seth.axen@gmail.com>
    @kellertuer @sethaxen
    kellertuer and sethaxen committed Jan 28, 2020
    Configuration menu
    Copy the full SHA
    4bbd3da View commit details
    Browse the repository at this point in the history

  3. replaces \gets with ←

    @kellertuer
    kellertuer committed Jan 28, 2020
    Configuration menu
    Copy the full SHA
    ffdcb35 View commit details
    Browse the repository at this point in the history

  4. Merge branch 'documentation-rework' of github.com:JuliaNLSolvers/Mani… 

    …folds.jl into documentation-rework
    @kellertuer
    kellertuer committed Jan 28, 2020
    Configuration menu
    Copy the full SHA
    9bac84d View commit details
    Browse the repository at this point in the history

  5. \dots to …

    @kellertuer
    kellertuer committed Jan 28, 2020
    Configuration menu
    Copy the full SHA
    3cfa995 View commit details
    Browse the repository at this point in the history

  6. Replaces \to with → in docstrings.

    @kellertuer
    kellertuer committed Jan 28, 2020
    Configuration menu
    Copy the full SHA
    7aba7f8 View commit details
    Browse the repository at this point in the history

  7. Replace greek letters.

    @kellertuer
    kellertuer committed Jan 28, 2020
    Configuration menu
    Copy the full SHA
    b0db476 View commit details
    Browse the repository at this point in the history

  8. Replaces \in \neq and \colon with their utf8s.

    @kellertuer
    kellertuer committed Jan 28, 2020
    Configuration menu
    Copy the full SHA
    ab8dc0e View commit details
    Browse the repository at this point in the history

  9. Changes lfloor and lfloor to their utf8s.

    @kellertuer
    kellertuer committed Jan 28, 2020
    Configuration menu
    Copy the full SHA
    783cebb View commit details
    Browse the repository at this point in the history

  10. revert ⨉ back to \times.

    @kellertuer
    kellertuer committed Jan 28, 2020
    Configuration menu
    Copy the full SHA
    7427d2a View commit details
    Browse the repository at this point in the history

  11. revert ◦ back to \circ.

    @kellertuer
    kellertuer committed Jan 28, 2020
    Configuration menu
    Copy the full SHA
    adf01f7 View commit details
    Browse the repository at this point in the history

  12. removes double-mentioned functions.

    @kellertuer
    kellertuer committed Jan 28, 2020
    Configuration menu
    Copy the full SHA
    eadf25a View commit details
    Browse the repository at this point in the history

  13. Fixes the notations table.

    @kellertuer
    kellertuer committed Jan 28, 2020
    Configuration menu
    Copy the full SHA
    c7e8bbf View commit details
    Browse the repository at this point in the history

  14. Fixes a copy-paste-error.

    @kellertuer
    kellertuer committed Jan 28, 2020
    Configuration menu
    Copy the full SHA
    e87d942 View commit details
    Browse the repository at this point in the history

  15. removes a few files that I added accidentially.

    @kellertuer
    kellertuer committed Jan 28, 2020
    Configuration menu
    Copy the full SHA
    d8d3c59 View commit details
    Browse the repository at this point in the history

Commits on Jan 29, 2020

  1. move from x to p (to avoid confusion with x and X), revert · to \cdot… 

    … since spaing is off; refactor CholeskySpace.
    @kellertuer
    kellertuer committed Jan 29, 2020
    Configuration menu
    Copy the full SHA
    177363e View commit details
    Browse the repository at this point in the history

  2. Reworks/unifies the circle.

    @kellertuer
    kellertuer committed Jan 29, 2020
    Configuration menu
    Copy the full SHA
    b8d62cc View commit details
    Browse the repository at this point in the history

  3. Finishes the Torus by completeing a docstring, unifies docstringforma… 

    …t to use `@doc raw"""` (see Julia Documentation) for docstrings that contain math ($,\ and others.)
    @kellertuer
    kellertuer committed Jan 29, 2020
    Configuration menu
    Copy the full SHA
    06d4058 View commit details
    Browse the repository at this point in the history

Commits on Jan 30, 2020

  1. Merge branch 'master' into documentation-rework 

    # Conflicts:
#	src/manifolds/Circle.jl
#	src/manifolds/Grassmann.jl
#	src/manifolds/Hyperbolic.jl
#	src/manifolds/MetricManifold.jl
#	src/manifolds/Rotations.jl
#	src/manifolds/Stiefel.jl
#	src/manifolds/Symmetric.jl
#	src/manifolds/SymmetricPositiveDefinite.jl
#	src/manifolds/Torus.jl
#	src/statistics.jl
    @kellertuer
    kellertuer committed Jan 30, 2020
    Configuration menu
    Copy the full SHA
    2b47fda View commit details
    Browse the repository at this point in the history

  2. update Euclidean docstrings.

    @kellertuer
    kellertuer committed Jan 30, 2020
    Configuration menu
    Copy the full SHA
    4040b41 View commit details
    Browse the repository at this point in the history

  3. Replace \infty with ∞

    @kellertuer
    kellertuer committed Jan 30, 2020
    Configuration menu
    Copy the full SHA
    0a76a38 View commit details
    Browse the repository at this point in the history

  4. Starts reworking FixedRank.

    @kellertuer
    kellertuer committed Jan 30, 2020
    Configuration menu
    Copy the full SHA
    59ba59b View commit details
    Browse the repository at this point in the history

  5. finishes documentation and variables until end of Hyperbolic manifold.

    @kellertuer
    kellertuer committed Jan 30, 2020
    Configuration menu
    Copy the full SHA
    2f8a1fa View commit details
    Browse the repository at this point in the history

  6. Finishes rework of Metric- and Powermanifold as well as Stiefel

    @kellertuer
    kellertuer committed Jan 30, 2020
    Configuration menu
    Copy the full SHA
    fa11394 View commit details
    Browse the repository at this point in the history

  7. Refactor SPD notations, especially LogCholesky now has p,q (X,Y) for … 

    …SPD points (vectors) and x,y (V,W) for Cholesky points (vectors)., which is hopefully better readable.
    @kellertuer
    kellertuer committed Jan 30, 2020
    Configuration menu
    Copy the full SHA
    9873a60 View commit details
    Browse the repository at this point in the history

  8. Fixes bugs introduces by renaming Cholsky.

    @kellertuer
    kellertuer committed Jan 30, 2020
    Configuration menu
    Copy the full SHA
    3474cca View commit details
    Browse the repository at this point in the history

Commits on Jan 31, 2020

  1. refactor Sphere & Vector Bundle.

    @kellertuer
    kellertuer committed Jan 31, 2020
    Configuration menu
    Copy the full SHA
    bebdb2d View commit details
    Browse the repository at this point in the history

Commits on Feb 1, 2020

  1. Finishes Symmetric & Rotations, replaces \pi->π.

    @kellertuer
    kellertuer committed Feb 1, 2020
    Configuration menu
    Copy the full SHA
    4c904bd View commit details
    Browse the repository at this point in the history

  2. rework product manifold.

    @kellertuer
    kellertuer committed Feb 1, 2020
    Configuration menu
    Copy the full SHA
    c5f41a1 View commit details
    Browse the repository at this point in the history

  3. refactor to notation.md

    @kellertuer
    kellertuer committed Feb 1, 2020
    Configuration menu
    Copy the full SHA
    49e6329 View commit details
    Browse the repository at this point in the history

  4. use speaking and longer field names.

    @kellertuer
    kellertuer committed Feb 1, 2020
    Configuration menu
    Copy the full SHA
    46cbc06 View commit details
    Browse the repository at this point in the history

  5. fixes a typo.

    @kellertuer
    kellertuer committed Feb 1, 2020
    Configuration menu
    Copy the full SHA
    f3269de View commit details
    Browse the repository at this point in the history

  6. Fixes a few more replacement bugs.

    @kellertuer
    kellertuer committed Feb 1, 2020
    Configuration menu
    Copy the full SHA
    2c46963 View commit details
    Browse the repository at this point in the history

  7. Finally renamex fields .x to .point

    @kellertuer
    kellertuer committed Feb 1, 2020
    Configuration menu
    Copy the full SHA
    ae10f7b View commit details
    Browse the repository at this point in the history

  8. Fixes further .manifold fields, though I have introduced a bug that I… 

    … can't reengineer currently within semidrect groups. That has still to be found.
    @kellertuer
    kellertuer committed Feb 1, 2020
    Configuration menu
    Copy the full SHA
    968a942 View commit details
    Browse the repository at this point in the history

  9. Fixes two minor typos that were introduced by refactoring.

    @kellertuer
    kellertuer committed Feb 1, 2020
    Configuration menu
    Copy the full SHA
    57d340c View commit details
    Browse the repository at this point in the history

Commits on Feb 4, 2020

  1. fixes two mingled docstrings.

    @kellertuer
    kellertuer committed Feb 4, 2020
    Configuration menu
    Copy the full SHA
    e463523 View commit details
    Browse the repository at this point in the history

  2. improve capitalization and extend notation.md

    @kellertuer
    kellertuer committed Feb 4, 2020
    Configuration menu
    Copy the full SHA
    d5cb228 View commit details
    Browse the repository at this point in the history

  3. Update docs/src/orthonormal_bases.md 

    Co-Authored-By: Seth Axen <seth.axen@gmail.com>
    @kellertuer @sethaxen
    kellertuer and sethaxen committed Feb 4, 2020
    Configuration menu
    Copy the full SHA
    6431b7d View commit details
    Browse the repository at this point in the history

  4. Update src/groups/group.jl 

    Co-Authored-By: Seth Axen <seth.axen@gmail.com>
    @kellertuer @sethaxen
    kellertuer and sethaxen committed Feb 4, 2020
    Configuration menu
    Copy the full SHA
    7621743 View commit details
    Browse the repository at this point in the history

  5. replaces two further math notations by utf8

    @kellertuer
    kellertuer committed Feb 4, 2020
    Configuration menu
    Copy the full SHA
    a44bddc View commit details
    Browse the repository at this point in the history

  6. Merge branch 'documentation-rework' of github.com:JuliaNLSolvers/Mani… 

    …folds.jl into documentation-rework
    @kellertuer
    kellertuer committed Feb 4, 2020
    Configuration menu
    Copy the full SHA
    fc176a6 View commit details
    Browse the repository at this point in the history

  7. Update src/manifolds/CholeskySpace.jl 

    Co-Authored-By: Seth Axen <seth.axen@gmail.com>
    @kellertuer @sethaxen
    kellertuer and sethaxen committed Feb 4, 2020
    Configuration menu
    Copy the full SHA
    6e8ccb4 View commit details
    Browse the repository at this point in the history

  8. Update src/manifolds/Circle.jl 

    Co-Authored-By: Seth Axen <seth.axen@gmail.com>
    @kellertuer @sethaxen
    kellertuer and sethaxen committed Feb 4, 2020
    Configuration menu
    Copy the full SHA
    a514bf2 View commit details
    Browse the repository at this point in the history

  9. Update src/manifolds/ProductManifold.jl 

    Co-Authored-By: Seth Axen <seth.axen@gmail.com>
    @kellertuer @sethaxen
    kellertuer and sethaxen committed Feb 4, 2020
    Configuration menu
    Copy the full SHA
    78a9b74 View commit details
    Browse the repository at this point in the history

  10. Update src/manifolds/ProductManifold.jl 

    Co-Authored-By: Seth Axen <seth.axen@gmail.com>
    @kellertuer @sethaxen
    kellertuer and sethaxen committed Feb 4, 2020
    Configuration menu
    Copy the full SHA
    0fc2b70 View commit details
    Browse the repository at this point in the history

  11. Update src/manifolds/ProductManifold.jl 

    Co-Authored-By: Seth Axen <seth.axen@gmail.com>
    @kellertuer @sethaxen
    kellertuer and sethaxen committed Feb 4, 2020
    Configuration menu
    Copy the full SHA
    3c77b77 View commit details
    Browse the repository at this point in the history

  12. Replace wedge and vee by their utf8 representations.

    @kellertuer
    kellertuer committed Feb 4, 2020
    Configuration menu
    Copy the full SHA
    24c8589 View commit details
    Browse the repository at this point in the history

  13. Update src/manifolds/ProductManifold.jl 

    Co-Authored-By: Seth Axen <seth.axen@gmail.com>
    @kellertuer @sethaxen
    kellertuer and sethaxen committed Feb 4, 2020
    Configuration menu
    Copy the full SHA
    e89dc64 View commit details
    Browse the repository at this point in the history

  14. Update src/manifolds/Circle.jl 

    Co-Authored-By: Seth Axen <seth.axen@gmail.com>
    @kellertuer @sethaxen
    kellertuer and sethaxen committed Feb 4, 2020
    Configuration menu
    Copy the full SHA
    5ec77b8 View commit details
    Browse the repository at this point in the history

  15. undo \vee since it rendered as a large or, replace \times with ×.

    @kellertuer
    kellertuer committed Feb 4, 2020
    Configuration menu
    Copy the full SHA
    b1614d0 View commit details
    Browse the repository at this point in the history

  16. Return from caligraphic UTF8 to $\mathcal ...$

    @kellertuer
    kellertuer committed Feb 4, 2020
    Configuration menu
    Copy the full SHA
    4224994 View commit details
    Browse the repository at this point in the history

  17. replace \partial with ∂.

    @kellertuer
    kellertuer committed Feb 4, 2020
    Configuration menu
    Copy the full SHA
    21837c3 View commit details
    Browse the repository at this point in the history

  18. Apply suggestions from code review 

    Co-Authored-By: Seth Axen <seth.axen@gmail.com>
    @kellertuer @sethaxen
    kellertuer and sethaxen committed Feb 4, 2020
    Configuration menu
    Copy the full SHA
    ddd69b3 View commit details
    Browse the repository at this point in the history

  19. Replace \Gamme with Γ.

    @kellertuer
    kellertuer committed Feb 4, 2020
    Configuration menu
    Copy the full SHA
    59be2b2 View commit details
    Browse the repository at this point in the history

  20. update \dim.

    @kellertuer
    kellertuer committed Feb 4, 2020
    Configuration menu
    Copy the full SHA
    2a10ef7 View commit details
    Browse the repository at this point in the history

  21. Merge branch 'documentation-rework' of github.com:JuliaNLSolvers/Mani… 

    …folds.jl into documentation-rework
    @kellertuer
    kellertuer committed Feb 4, 2020
    Configuration menu
    Copy the full SHA
    fcd9977 View commit details
    Browse the repository at this point in the history

  22. use \dim more consistently throughout the docs of `manifold_dimensi… 

    …on`.
    @kellertuer
    kellertuer committed Feb 4, 2020
    Configuration menu
    Copy the full SHA
    e1c06b0 View commit details
    Browse the repository at this point in the history

  23. rename B.v to B.frame_direction in the DiagonalizingONB.

    @kellertuer
    kellertuer committed Feb 4, 2020
    Configuration menu
    Copy the full SHA
    07f25b7 View commit details
    Browse the repository at this point in the history

  24. adds a few test cases, rename B.v to B.frame_direction and unify Metr… 

    …icManifold to pass down only the mutating version of exp, since we do the same for log.
    @kellertuer
    kellertuer committed Feb 4, 2020
    Configuration menu
    Copy the full SHA
    3f72d23 View commit details
    Browse the repository at this point in the history

  25. fixes documentation for project tangent on the circle and adds a test.

    @kellertuer
    kellertuer committed Feb 4, 2020
    Configuration menu
    Copy the full SHA
    8c9cca5 View commit details
    Browse the repository at this point in the history

  26. unify Metric Manifold to not implement exp/log neither but only exp!/… 

    …log!
    @kellertuer
    kellertuer committed Feb 4, 2020
    Configuration menu
    Copy the full SHA
    102c755 View commit details
    Browse the repository at this point in the history

  27. Fixes a typo in MetricManifolds log documentation and explains that f… 

    …or other than the default metric one has to provide an implementation.
    @kellertuer
    kellertuer committed Feb 4, 2020
    Configuration menu
    Copy the full SHA
    0be2cf3 View commit details
    Browse the repository at this point in the history

Commits on Feb 5, 2020

  1. change vout to Y, introduce Cartesian product and power to notation, … 

    …correct emanating.
    @kellertuer
    kellertuer committed Feb 5, 2020
    Configuration menu
    Copy the full SHA
    d20ab25 View commit details
    Browse the repository at this point in the history

  2. unifies spacing in math formulae, trace to tr, and adds further terms… 

    … to the notations table.
    @kellertuer
    kellertuer committed Feb 5, 2020
    Configuration menu
    Copy the full SHA
    92940a7 View commit details
    Browse the repository at this point in the history

  3. Apply suggestions from code review 

    Co-Authored-By: Seth Axen <seth.axen@gmail.com>
    @kellertuer @sethaxen
    kellertuer and sethaxen committed Feb 5, 2020
    Configuration menu
    Copy the full SHA
    b06cad5 View commit details
    Browse the repository at this point in the history

  4. apply the remaining changes from review.

    @kellertuer
    kellertuer committed Feb 5, 2020
    Configuration menu
    Copy the full SHA
    741085b View commit details
    Browse the repository at this point in the history

  5. Finalize notations.md.

    @kellertuer
    kellertuer committed Feb 5, 2020
    Configuration menu
    Copy the full SHA
    e7bba5c View commit details
    Browse the repository at this point in the history

  6. Merge branch 'documentation-rework' of github.com:JuliaNLSolvers/Mani… 

    …folds.jl into documentation-rework

# Conflicts:
#	src/manifolds/Sphere.jl
#	src/manifolds/Stiefel.jl
    @kellertuer
    kellertuer committed Feb 5, 2020
    Configuration menu
    Copy the full SHA
    64f798f View commit details
    Browse the repository at this point in the history

  7. Fixes a final typo.

    @kellertuer
    kellertuer committed Feb 5, 2020
    Configuration menu
    Copy the full SHA
    fcb4895 View commit details
    Browse the repository at this point in the history

  8. unifies usage of \dim.

    @kellertuer
    kellertuer committed Feb 5, 2020
    Configuration menu
    Copy the full SHA
    4e21e0e View commit details
    Browse the repository at this point in the history

  9. updates another docstring.

    @kellertuer
    kellertuer committed Feb 5, 2020
    Configuration menu
    Copy the full SHA
    4bef2c9 View commit details
    Browse the repository at this point in the history