pub struct JointPenaltyBundle {
pub specs: Arc<Vec<JointPenaltySpec>>,
pub log_lambdas: Vec<f64>,
}Expand description
Per-evaluation bundle of cross-block penalties paired with their current log-smoothing parameters.
The outer optimizer concatenates joint penalty log λ values onto the
per-block ρ vector; the inner solver receives this bundle via
[crate::families::custom_family::BlockwiseFitOptions::joint_penalties]
and adds the full-width quadratic / matvec / preconditioner / Hessian
contributions to the joint-Newton primitives.
Fields§
§specs: Arc<Vec<JointPenaltySpec>>§log_lambdas: Vec<f64>Implementations§
Source§impl JointPenaltyBundle
impl JointPenaltyBundle
Sourcepub fn new(
specs: Arc<Vec<JointPenaltySpec>>,
log_lambdas: Vec<f64>,
total_compiled: usize,
) -> Result<JointPenaltyBundle, String>
pub fn new( specs: Arc<Vec<JointPenaltySpec>>, log_lambdas: Vec<f64>, total_compiled: usize, ) -> Result<JointPenaltyBundle, String>
Build a bundle, validating the per-penalty log λ count and dimension
agreement against total_compiled.
pub fn len(&self) -> usize
pub fn is_empty(&self) -> bool
Sourcepub fn quadratic(&self, beta: ArrayBase<ViewRepr<&f64>, Dim<[usize; 1]>>) -> f64
pub fn quadratic(&self, beta: ArrayBase<ViewRepr<&f64>, Dim<[usize; 1]>>) -> f64
Total joint-penalty contribution to the objective:
½ Σ_j exp(ρ_j) · βᵀ S_j β.
Sourcepub fn add_apply_into(
&self,
vector: ArrayBase<ViewRepr<&f64>, Dim<[usize; 1]>>,
out: &mut ArrayBase<OwnedRepr<f64>, Dim<[usize; 1]>>,
)
pub fn add_apply_into( &self, vector: ArrayBase<ViewRepr<&f64>, Dim<[usize; 1]>>, out: &mut ArrayBase<OwnedRepr<f64>, Dim<[usize; 1]>>, )
Accumulate Σ_j exp(ρ_j) · S_j · v into out (additive).
Sourcepub fn add_diag(&self, diag: &mut ArrayBase<OwnedRepr<f64>, Dim<[usize; 1]>>)
pub fn add_diag(&self, diag: &mut ArrayBase<OwnedRepr<f64>, Dim<[usize; 1]>>)
Accumulate Σ_j exp(ρ_j) · diag(S_j) into diag (additive).
Trait Implementations§
Source§impl Clone for JointPenaltyBundle
impl Clone for JointPenaltyBundle
Source§fn clone(&self) -> JointPenaltyBundle
fn clone(&self) -> JointPenaltyBundle
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 moreAuto Trait Implementations§
impl Freeze for JointPenaltyBundle
impl RefUnwindSafe for JointPenaltyBundle
impl Send for JointPenaltyBundle
impl Sync for JointPenaltyBundle
impl Unpin for JointPenaltyBundle
impl UnsafeUnpin for JointPenaltyBundle
impl UnwindSafe for JointPenaltyBundle
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> DistributionExt for Twhere
T: ?Sized,
impl<T> DistributionExt for Twhere
T: ?Sized,
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,
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.