Public documentation

Documentation for Manifolds.jl's public interface. It mainly covers functions that are of interest for extending and using the ProductManifold.

ShapeSpecification(reshapers, manifolds::Manifold...)

A structure for specifying array size and offset information for linear storage of points and tangent vectors on the product manifold of manifolds.

The first argument, reshapers, indicates how a view representing a point in the ProductArray will be reshaped. It can either be an object of type AbstractReshaper that will be applied to all views or a tuple of such objects that will be applied to subsequent manifolds.

Two main reshaping methods are provided by types StaticReshaper that is faster for manifolds represented by small arrays (up to about 100 elements) and ArrayReshaper that is faster for larger arrays.

For example, consider the shape specification for the product of a sphere and group of rotations:

julia> M1 = Sphere(2)

julia> M2 = Manifolds.Rotations(2)

julia> reshaper = Manifolds.StaticReshaper()

julia> shape = Manifolds.ShapeSpecification(reshaper, M1, M2)
Manifolds.ShapeSpecification{(1:3, 4:7),Tuple{Tuple{3},Tuple{2,2}},
  (Manifolds.StaticReshaper(), Manifolds.StaticReshaper()))

TRanges contains ranges in the linear storage that correspond to a specific manifold. Sphere(2) needs three numbers and is first, so it is allocated the first three elements of the linear storage (1:3). Rotations(2) needs four numbers and is second, so the next four numbers are allocated to it (4:7). TSizes describe how the linear storage must be reshaped to correctly represent points. In this case, Sphere(2) expects a three-element vector, so the corresponding size is Tuple{3}. On the other hand, Rotations(2) expects two-by-two matrices, so its size specification is Tuple{2,2}.

submanifold_component(M::Manifold, p, i::Integer)
submanifold_component(M::Manifold, p, ::Val(i)) where {i}
submanifold_component(p, i::Integer)
submanifold_component(p, ::Val(i)) where {i}

Project the product array p on M to its ith component. A new array is returned.

submanifold_components(M::Manifold, p)

Get the projected components of p on the submanifolds of M. The components are returned in a Tuple.

ProductArray(shape::ShapeSpecification, data)

An array-based representation for points and tangent vectors on the product manifold. data contains underlying representation of points arranged according to TRanges and TSizes from shape. Internal views for each specific sub-point are created and stored in parts.


A more general but slower representation of points and tangent vectors on a product manifold.


A product point on a product manifold Sphere(2) × Euclidean(2) might be created as

ProductRepr([1.0, 0.0, 0.0], [2.0, 3.0])

where [1.0, 0.0, 0.0] is the part corresponding to the sphere factor and [2.0, 3.0] is the part corresponding to the euclidean manifold.

prod_point(M::ShapeSpecification, pts...)

Construct a product point from product manifold M based on point pts represented by ProductArray.


To construct a point on the product manifold $S^2 × ℝ^2$ from points on the sphere and in the euclidean space represented by, respectively, [1.0, 0.0, 0.0] and [-3.0, 2.0] you need to construct shape specification first. It describes how linear storage of ProductArray corresponds to array representations expected by Sphere(2) and Euclidean(2).

M1 = Sphere(2)
M2 = Euclidean(2)
reshaper = Manifolds.StaticReshaper()
Mshape = Manifolds.ShapeSpecification(reshaper, M1, M2)

Next, the desired point on the product manifold can be obtained by calling Manifolds.prod_point(Mshape, [1.0, 0.0, 0.0], [-3.0, 2.0]).

make_reshape(reshaper::AbstractReshaper, ::Type{Size}, data) where Size

Reshape array data to size Size using method provided by reshaper.