Struct PeriodicTransform 

pub struct PeriodicTransform<T = f64, B = NalgebraProvider>
where
    T: RealScalar,
    B: LinearAlgebra<T>,
{ /* private fields */ }

Component-wise periodic coordinate transform for optimization.

Periodic coordinates are represented internally on the real line and canonically wrapped into half-open external intervals. This repeated lift is not a proper target for MCMC sampling.

Implementations

impl<T, B> PeriodicTransform<T, B>

where T: RealScalar, B: LinearAlgebra<T>,

pub fn new<I>(intervals: I) -> GaneshResult<Self>

where I: IntoIterator<Item = Option<(T, T)>>,

Construct from one optional periodic interval per coordinate.

None leaves a coordinate unchanged. Periodic intervals are canonicalized to [lower, upper).

Errors

Returns a configuration error for an empty list, no periodic coordinates, non-finite endpoints, or intervals whose endpoints are not ordered.

pub fn intervals(&self) -> &[Option<(T, T)>]

Return the optional periodic interval for each coordinate.

Trait Implementations

impl<T, B> Clone for PeriodicTransform<T, B>

where T: RealScalar + Clone, B: LinearAlgebra<T> + Clone,

fn clone(&self) -> PeriodicTransform<T, B>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T, B> Debug for PeriodicTransform<T, B>

where T: RealScalar + Debug, B: LinearAlgebra<T> + Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T, B> Transform<T, B> for PeriodicTransform<T, B>

where T: RealScalar, B: LinearAlgebra<T>,

fn to_external(&self, internal: &Vector<T, B>) -> Vector<T, B>

Convert internal coordinates to user-facing external coordinates.

fn to_internal(&self, external: &Vector<T, B>) -> Vector<T, B>

Convert external coordinates to internal coordinates.

fn to_external_jacobian(&self, internal: &Vector<T, B>) -> Matrix<T, B>

Jacobian of to_external at internal.

fn to_external_component_hessian( &self, _component: usize, internal: &Vector<T, B>, ) -> Matrix<T, B>

Hessian of external component component at internal.

fn then<X>(self, outer: X) -> TransformChain<Self, X>

where Self: Sized, X: Transform<T, B>,

Apply this transform first and outer second.

fn parameter_bounds(&self) -> Option<&[ScalarBound<T>]>

Return user-facing parameter bounds when this transform represents bounds.

fn pullback_gradient( &self, internal: &Vector<T, B>, external_gradient: &Vector<T, B>, ) -> Vector<T, B>

Pull an external-space gradient back to internal coordinates.

fn pullback_hessian( &self, internal: &Vector<T, B>, external_gradient: &Vector<T, B>, external_hessian: &Matrix<T, B>, ) -> Matrix<T, B>

Pull an external-space Hessian back to internal coordinates.