pub struct SpdManifold { /* private fields */ }Implementations§
Trait Implementations§
Source§impl Clone for SpdManifold
impl Clone for SpdManifold
Source§fn clone(&self) -> SpdManifold
fn clone(&self) -> SpdManifold
Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for SpdManifold
impl Debug for SpdManifold
impl Eq for SpdManifold
Source§impl PartialEq for SpdManifold
impl PartialEq for SpdManifold
Source§fn eq(&self, other: &SpdManifold) -> bool
fn eq(&self, other: &SpdManifold) -> bool
Tests for
self and other values to be equal, and is used by ==.Source§impl RiemannianManifold for SpdManifold
impl RiemannianManifold for SpdManifold
Source§fn tangent_basis(
&self,
point: ArrayView1<'_, f64>,
) -> GeometryResult<Array2<f64>>
fn tangent_basis( &self, point: ArrayView1<'_, f64>, ) -> GeometryResult<Array2<f64>>
Basis of the symmetric tangent space, orthonormal under the
affine-invariant metric ⟨U,V⟩_P = tr(P⁻¹U P⁻¹V) (i.e. Qᵀ W Q = I
with W = metric_tensor(point) = P⁻¹ ⊗ P⁻¹). The hand-rolled
Frobenius-orthonormal basis used previously is orthonormal only under the
embedded tr(UV) inner product, which is not the SPD metric off the
identity point, so it produced a basis that did not satisfy Qᵀ W Q = I.
We Gram–Schmidt the projected symmetric standard basis under W instead.
fn dim(&self) -> usize
fn ambient_dim(&self) -> usize
fn exp_map( &self, point: ArrayView1<'_, f64>, tangent_vec: ArrayView1<'_, f64>, ) -> GeometryResult<Array1<f64>>
fn log_map( &self, p_from: ArrayView1<'_, f64>, p_to: ArrayView1<'_, f64>, ) -> GeometryResult<Array1<f64>>
fn parallel_transport( &self, point_along: ArrayView2<'_, f64>, vec: ArrayView1<'_, f64>, ) -> GeometryResult<Array1<f64>>
fn metric_tensor( &self, point: ArrayView1<'_, f64>, ) -> GeometryResult<Array2<f64>>
fn christoffel_symbols( &self, point: ArrayView1<'_, f64>, ) -> GeometryResult<Vec<Array2<f64>>>
fn sectional_curvature( &self, point: ArrayView1<'_, f64>, tangent_pair: (ArrayView1<'_, f64>, ArrayView1<'_, f64>), ) -> GeometryResult<f64>
fn project_tangent( &self, point: ArrayView1<'_, f64>, vec: ArrayView1<'_, f64>, ) -> GeometryResult<Array1<f64>>
Source§fn exp_map_vjp(
&self,
point: ArrayView1<'_, f64>,
tangent_vec: ArrayView1<'_, f64>,
grad_output: ArrayView1<'_, f64>,
) -> GeometryResult<(Array1<f64>, Array1<f64>)>
fn exp_map_vjp( &self, point: ArrayView1<'_, f64>, tangent_vec: ArrayView1<'_, f64>, grad_output: ArrayView1<'_, f64>, ) -> GeometryResult<(Array1<f64>, Array1<f64>)>
Vector–Jacobian product of the ambient map
exp_p(v). Read morefn retract( &self, point: ArrayView1<'_, f64>, tangent_vec: ArrayView1<'_, f64>, ) -> GeometryResult<Array1<f64>>
impl StructuralPartialEq for SpdManifold
Auto Trait Implementations§
impl Freeze for SpdManifold
impl RefUnwindSafe for SpdManifold
impl Send for SpdManifold
impl Sync for SpdManifold
impl Unpin for SpdManifold
impl UnsafeUnpin for SpdManifold
impl UnwindSafe for SpdManifold
Blanket Implementations§
impl<T> Allocation for T
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> DistributionExt for Twhere
T: ?Sized,
impl<T> DistributionExt for Twhere
T: ?Sized,
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Compare self to
key and return true if they are equal.impl<T, U> Imply<T> for U
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Pointable for T
impl<T> Pointable for T
impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
impl<T> Scalar for T
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self is actually part of its subset T (and can be converted to it).Source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.