mfGeomEuclidean: Euclidean Geometry Class

mfGeomEuclideanR Documentation

Euclidean Geometry Class

Description

Euclidean Geometry Class

Euclidean Geometry Class

Details

An R6 class defining the Euclidean geometry for a single vector. This class is typically not too much of practical interest, as in this case the Family could typically by defined without it. However, it serves as parent for most other geometries.

Super class

manifoldboost::mfGeometry -> mfGeomEuclidean

Methods

Public methods

Inherited methods

Method structure()

method for structuring either objects y, tangent vectors v, or weight vectors weights. Usually the identity, except for complex vectors. FOR COMPLEX VECTORS USE WITH CARE: STILL ORDER DEPENDEND.

Usage
mfGeomEuclidean$structure(y, v, weights, y0_ = private$.y_)
Arguments
y

a numeric vector

v

a numeric vector

weights

a numeric vector

y0_

a numeric/complex vector


Method unstructure()

inverse of $structure. FOR COMPLEX VECTORS USE WITH CARE: STILL ORDER DEPENDEND.

Usage
mfGeomEuclidean$unstructure(y_, v_, weights_, y0_ = private$.y_)
Arguments
y_

a numeric/complex vector

v_

a (tangent) numeric/complex vector

weights_

a numeric vector of the same length as y_ / pole_

y0_

a numeric/complex vector


Method align()

The identity.

Usage
mfGeomEuclidean$align(y_, y0_)
Arguments
y_

a numeric/complex vector

y0_

a numeric/complex vector


Method register()

The identity.

Usage
mfGeomEuclidean$register(y_)
Arguments
y_

a numeric/complex vector


Method exp()

Simple addition.

Usage
mfGeomEuclidean$exp(v_, y0_ = private$.pole_)
Arguments
v_

a (tangent) numeric/complex vector

y0_

a numeric/complex vector


Method log()

Simple substraction.

Usage
mfGeomEuclidean$log(y_, y0_ = private$.pole_)
Arguments
y_

a numeric/complex vector

y0_

a numeric/complex vector


Method transport()

The identity.

Usage
mfGeomEuclidean$transport(v0_, y0_, y1_)
Arguments
v0_

a (tangent) numeric/complex vector

y0_

a numeric/complex vector

y1_

a numeric/complex vector


Method innerprod()

The weighted scalar product.

Usage
mfGeomEuclidean$innerprod(v0_, v1_ = v0_, weights_ = private$.weights_)
Arguments
v0_

a (tangent) numeric/complex vector

v1_

a (tangent) numeric/complex vector

weights_

a numeric vector of the same length as y_ / pole_


Method get_normal()

Always returning NULL.

Usage
mfGeomEuclidean$get_normal(y0_ = private$.pole_)
Arguments
y0_

a numeric/complex vector


Method validate()

Check whether numeric or complex.

Usage
mfGeomEuclidean$validate(y_)
Arguments
y_

a numeric/complex vector


Method clone()

The objects of this class are cloneable with this method.

Usage
mfGeomEuclidean$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.


Almond-S/manifoldboost documentation built on June 23, 2022, 11:06 a.m.