diff --git a/README.md b/README.md index 89654a21..0657275c 100644 --- a/README.md +++ b/README.md @@ -3,12 +3,19 @@ [![Build Status](https://travis-ci.org/JuliaManifolds/ManifoldsBase.jl.svg?branch=master)](https://travis-ci.org/JuliaManifolds/ManifoldsBase.jl/) [![codecov.io](http://codecov.io/github/JuliaManifolds/ManifoldsBase.jl/coverage.svg?branch=master)](https://codecov.io/gh/JuliaManifolds/ManifoldsBase.jl/) [![](https://img.shields.io/badge/docs-dev-blue.svg)](https://julianlsolvers.github.io/Manifolds.jl/latest/) - Basic interface for manifolds in Julia. The project [`Manifolds.jl`](https://github.com/JuliaManifolds/Manifolds.jl) is based on this interface and provides a variety of manifolds. +## `DecoratorManifold` + +The decorator manifold enhances a manifold by certain, in most cases implicitly +assumed to have a standard case, properties, see for example the `EmbeddedManifold`. +The decorator acts semi transparently, i.e. `:transparent` for all functions not affected by that +decorator and `:intransparent` otherwise. Another possibility is, that the decorator just +passes to `:parent` in order to fill default values. + ## `DefaultManifold` This interface includes a simple `DefaultManifold`, which is a reduced version @@ -16,6 +23,13 @@ of the [`Euclidean`](https://github.com/JuliaManifolds/Manifolds.jl/blob/master/ manifold from [`Manifolds.jl`](https://github.com/JuliaManifolds/Manifolds.jl), such that the interface functions can be tested. +## Embedded Manifold + +The embedded manifold models the embedding of a manifold into another manifold. +This way a manifold can benefit from existing implementations. +One example is the `TransparentIsometricEmbeddingType` where a manifold uses the metric, +`inner`, from its embedding. + ## `ArrayManifold` The `ArrayManifold` further illustrates how one can also used types to