pub struct UnbalancedOtConfig {
pub epsilon: f64,
pub tau: f64,
pub regularization: UnbalancedRegularization,
pub max_iter: usize,
pub tol: f64,
pub log_domain: bool,
}Expand description
Configuration for unbalanced Sinkhorn OT.
Fields§
§epsilon: f64Entropic regularization strength ε > 0. Default: 0.1.
tau: f64Marginal relaxation strength τ > 0. Default: 1.0.
As τ → ∞ the problem approaches balanced OT. Small τ allows large deviations from the input marginals.
regularization: UnbalancedRegularizationMarginal penalty type.
max_iter: usizeMaximum number of Sinkhorn iterations. Default: 1000.
tol: f64Convergence tolerance (on the marginal error). Default: 1e-6.
log_domain: boolWhether to apply log-domain stabilization (recommended for small ε).
Default: true.
Trait Implementations§
Source§impl Clone for UnbalancedOtConfig
impl Clone for UnbalancedOtConfig
Source§fn clone(&self) -> UnbalancedOtConfig
fn clone(&self) -> UnbalancedOtConfig
Returns a duplicate of the value. Read more
1.0.0 · 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 UnbalancedOtConfig
impl Debug for UnbalancedOtConfig
Auto Trait Implementations§
impl Freeze for UnbalancedOtConfig
impl RefUnwindSafe for UnbalancedOtConfig
impl Send for UnbalancedOtConfig
impl Sync for UnbalancedOtConfig
impl Unpin for UnbalancedOtConfig
impl UnsafeUnpin for UnbalancedOtConfig
impl UnwindSafe for UnbalancedOtConfig
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
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
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
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.