# shrinkage::HybridFit Shrinkage for Rust · 0.3.0 [Source]() ```rust pub struct HybridFit ``` Original-scale parameters and full-space hybrid diagnostics. Cluster labels and values refer to optimization-scale coefficients. Clustered lasso orders blocks by value; chain fused lasso orders contiguous segments by feature and retains zero-weight edges as segment boundaries. SLOPE orders equal-magnitude blocks decreasingly and retains individual signs in [`Self::coefficient_signs`](<4cfe41c15bbeb98348e19c60ae6240bfb650cf4d7fe4c2c32a660c298508b022#method-coefficient_signs-fd21dcf484ddec7051fa72f82ff6c79ac8b3807b8f3d432379bceaae43eefcbe>). Scaling can change equalities among the reported original-scale parameters. Gap Safe certificates refer to the original loss and full design. A sweep that leaves all blocks unchanged does not certify convergence; check [`Self::termination`](<4cfe41c15bbeb98348e19c60ae6240bfb650cf4d7fe4c2c32a660c298508b022#method-termination-fd21dcf484ddec7051fa72f82ff6c79ac8b3807b8f3d432379bceaae43eefcbe>) and the full mapping. ## Inherent implementation [Source]() ```rust impl HybridFit ``` ### `backtracks` ```rust pub fn backtracks(&self) -> usize ``` [Source]() Number of rejected trials followed by a curvature doubling. ### `cluster_labels` ```rust pub fn cluster_labels(&self) -> &[usize] ``` [Source]() Cluster label of each feature, indexing [`Self::cluster_values`](<4cfe41c15bbeb98348e19c60ae6240bfb650cf4d7fe4c2c32a660c298508b022#method-cluster_values-fd21dcf484ddec7051fa72f82ff6c79ac8b3807b8f3d432379bceaae43eefcbe>). ### `cluster_values` ```rust pub fn cluster_values(&self) -> &[f64] ``` [Source]() Optimization-scale block values, with positive zeros. Clustered lasso returns strictly increasing values. Chain fused lasso returns signed segment values in feature order, which may repeat. SLOPE returns strictly decreasing nonnegative magnitudes, with zero last when present. For SLOPE, coefficient `j` on the optimization scale equals `coefficient_signs()[j] * cluster_values()[cluster_labels()[j]]`. Equal original-scale values need not share a label when training scales differ. ### `coefficient_signs` ```rust pub fn coefficient_signs(&self) -> &[f64] ``` [Source]() Optimization-scale coefficient signs in feature order: -1, 0, or 1. Both signed zeros have sign zero. Signs are recorded before coefficient back-transformation; SLOPE clusters may contain both nonzero signs. ### `coefficients` ```rust pub fn coefficients(&self) -> &[f64] ``` [Source]() Original-scale coefficients in training-column order. ### `coordinate_sweeps` ```rust pub fn coordinate_sweeps(&self) -> usize ``` [Source]() Number of cluster-coordinate sweeps over the current working set. ### `diagnostic_checks` ```rust pub fn diagnostic_checks(&self) -> usize ``` [Source]() Number of refreshed inner diagnostic checks. Logistic checks use the fixed-zero quadratic subproblem; original-loss checks also run initially and after every accepted outer step. ### `dual_certificate` ```rust pub fn dual_certificate(&self) -> Option<&[f64]> ``` [Source]() Original-space feasible dual vector from the latest certificate check. Screening-disabled fits do not construct a certificate. ### `dual_objective` ```rust pub fn dual_objective(&self) -> Option ``` [Source]() Dual objective `D(theta)`, when a certificate is available. ### `duality_gap` ```rust pub fn duality_gap(&self) -> Option ``` [Source]() Duality gap `G(beta_0, beta, theta) = P(beta_0, beta) - D(theta)`. This diagnostic does not replace the full mapping stopping rule. ### `intercept` ```rust pub fn intercept(&self) -> f64 ``` [Source]() Original-scale intercept, including the centering correction. ### `iterations` ```rust pub fn iterations(&self) -> usize ``` [Source]() Total committed PG transitions plus coordinate sweeps over the current working set. ### `objective` ```rust pub fn objective(&self) -> f64 ``` [Source]() Final primal objective `P(beta_0, beta) = F(beta_0, beta) + R(beta)`. ### `outer_backtracks` ```rust pub fn outer_backtracks(&self) -> usize ``` [Source]() Rejected logistic trials followed by a step halving. Zero for Gaussian. ### `outer_iterations` ```rust pub fn outer_iterations(&self) -> usize ``` [Source]() Accepted logistic IRLS steps. Zero for Gaussian fits. ### `pg_steps` ```rust pub fn pg_steps(&self) -> usize ``` [Source]() Number of committed PG transitions, excluding diagnostic proxes. ### `predict` ```rust pub fn predict + ?Sized>( &self, x: &M ) -> Result, FitError> ``` [Source]() Predict linear predictors with original-scale parameters without fitting preprocessing. Binomial predictions are logits. #### Errors Reject mismatched dimensions, invalid entries, or nonfinite arithmetic. ### `preprocessing` ```rust pub fn preprocessing(&self) -> &Preprocessing ``` [Source]() Training normalization retained for interpreting optimization values. ### `screening_diagnostics` ```rust pub fn screening_diagnostics(&self) -> &shrinkage::ScreeningDiagnostics ``` [Source]() Work and certified zero restrictions in the original feature space. ### `step_policy` ```rust pub fn step_policy(&self) -> HybridStep ``` [Source]() Curvature policy selected for this fit. ### `step_size` ```rust pub fn step_size(&self) -> f64 ``` [Source]() Step used by final full-space diagnostics. Gaussian fits use the final PG curvature; logistic fits use a fixed global logistic curvature bound. ### `stopping_criterion` ```rust pub fn stopping_criterion(&self) -> StoppingCriterion ``` [Source]() Selected full-space convergence criterion. ### `stopping_threshold` ```rust pub fn stopping_threshold(&self) -> f64 ``` [Source]() Absolute mapping threshold used to certify convergence. ### `stopping_value` ```rust pub fn stopping_value(&self) -> f64 ``` [Source]() Full mapping infinity norm, including the free-intercept derivative, evaluated for the original loss at the returned parameters using [`Self::step_size`](<4cfe41c15bbeb98348e19c60ae6240bfb650cf4d7fe4c2c32a660c298508b022#method-step_size-fd21dcf484ddec7051fa72f82ff6c79ac8b3807b8f3d432379bceaae43eefcbe>). Logistic surrogate checks never certify convergence. ### `termination` ```rust pub fn termination(&self) -> Termination ``` [Source]() Whether the full mapping passed or the iteration budget expired. ### `working_set_diagnostics` ```rust pub fn working_set_diagnostics(&self) -> &shrinkage::WorkingSetDiagnostics ``` [Source]() Work performed by heuristic feature selection, separate from safe screening. ## Implementation of Clone [Source]() ```rust impl Clone for HybridFit ``` ### `clone` ```rust fn clone(&self) -> Self ``` [Source]() ## Implementation of Debug [Source]() ```rust impl Debug for HybridFit ``` ### `fmt` ```rust fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result ``` [Source]() ## [Implementation of ValidationFit](<5d173ce7dcb2d06e349b61bf9258286c35ff88ac41d7933ce0fe0553c3337dce>) [Source]() ```rust impl ValidationFit for shrinkage::HybridFit ``` ### `predict` ```rust fn predict + ?Sized>( &self, design: &M ) -> Result, FitError> ``` [Source]() ### `termination` ```rust fn termination(&self) -> Termination ``` [Source]() ## Implementation of Freeze ```rust impl Freeze for HybridFit ``` ## Implementation of RefUnwindSafe ```rust impl RefUnwindSafe for HybridFit ``` ## Implementation of Send ```rust impl Send for HybridFit ``` ## Implementation of Sync ```rust impl Sync for HybridFit ``` ## Implementation of Unpin ```rust impl Unpin for HybridFit ``` ## Implementation of UnsafeUnpin ```rust impl UnsafeUnpin for HybridFit ``` ## Implementation of UnwindSafe ```rust impl UnwindSafe for HybridFit ``` ## Implementation of Any ```rust impl Any for T where T: 'static + ?Sized ``` ## Implementation of Borrow ```rust impl Borrow for T where T: ?Sized ``` ## Implementation of BorrowMut ```rust impl BorrowMut for T where T: ?Sized ``` ## Implementation of ByRef ```rust impl ByRef for T ``` ## Implementation of CastableFrom ```rust impl CastableFrom for DT where ST: ?Sized, DT: ?Sized ``` ## Implementation of CastableFrom ```rust impl CastableFrom for DT where ST: ?Sized, DT: ?Sized ``` ## Implementation of CloneToUninit ```rust impl CloneToUninit for T where T: Clone ``` ## Implementation of From ```rust impl From for T ``` ## Implementation of Imply ```rust impl Imply for U where T: ?Sized, U: ?Sized ``` ## Implementation of Into ```rust impl Into for T where U: From ``` ## Implementation of IntoEither ```rust impl IntoEither for T ``` ## Implementation of Pointable ```rust impl Pointable for T ``` ## Implementation of Read ```rust impl Read for T where T: ?Sized ``` ## Implementation of Same ```rust impl Same for T ``` ## Implementation of SupersetOf ```rust impl SupersetOf for SP where SS: SubsetOf ``` ## Implementation of ToOwned ```rust impl ToOwned for T where T: Clone ``` ## Implementation of TryFrom ```rust impl TryFrom for T where U: Into ``` ## Implementation of TryInto ```rust impl TryInto for T where U: TryFrom ```