pub struct TransformSpec {
pub constraint: ConstraintType,
}Expand description
Per-parameter transform specification: constraint type + bijective map.
A TransformSpec pairs a ConstraintType with the forward/inverse
transform functions and log-Jacobian for use inside ADVI.
Fields§
§constraint: ConstraintTypeThe constraint type for this parameter
Implementations§
Source§impl TransformSpec
impl TransformSpec
Sourcepub fn new(constraint: ConstraintType) -> Self
pub fn new(constraint: ConstraintType) -> Self
Create a TransformSpec from a ConstraintType.
Sourcepub fn unconstrained() -> Self
pub fn unconstrained() -> Self
Create an unconstrained (identity) spec.
Sourcepub fn to_unconstrained(&self, theta: f64) -> StatsResult<f64>
pub fn to_unconstrained(&self, theta: f64) -> StatsResult<f64>
Forward transform: constrained θ → unconstrained η.
Returns an error if the value violates the constraint.
Sourcepub fn to_constrained(&self, eta: f64) -> f64
pub fn to_constrained(&self, eta: f64) -> f64
Inverse transform: unconstrained η → constrained θ.
Sourcepub fn log_jacobian_inverse(&self, eta: f64) -> f64
pub fn log_jacobian_inverse(&self, eta: f64) -> f64
Log-absolute-Jacobian of the inverse transform (η → θ), i.e., log|dθ/dη|. Added to log p(θ) when computing the ELBO.
Trait Implementations§
Source§impl Clone for TransformSpec
impl Clone for TransformSpec
Source§fn clone(&self) -> TransformSpec
fn clone(&self) -> TransformSpec
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 TransformSpec
impl Debug for TransformSpec
Source§impl PartialEq for TransformSpec
impl PartialEq for TransformSpec
Source§fn eq(&self, other: &TransformSpec) -> bool
fn eq(&self, other: &TransformSpec) -> bool
Tests for
self and other values to be equal, and is used by ==.impl StructuralPartialEq for TransformSpec
Auto Trait Implementations§
impl Freeze for TransformSpec
impl RefUnwindSafe for TransformSpec
impl Send for TransformSpec
impl Sync for TransformSpec
impl Unpin for TransformSpec
impl UnsafeUnpin for TransformSpec
impl UnwindSafe for TransformSpec
Blanket Implementations§
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> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
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.