# shrinkage::IrlsFit

Shrinkage for Rust · 0.3.0

[Source](<https://github.com/jolars/shrinkage/blob/eeafe449edce19d3c552a03060f681ae3891af74/src/fit/irls.rs>)

```rust
pub struct IrlsFit
```

Original-scale parameters and full-loss KKT diagnostics from [`crate::Irls`](<38d3c0c77c3a369dc72fa82940fe75e00e04888f78613113e69bdc12b1c8d7dd>). 

Predictions are linear predictors, including logits for default binomial models. Objectives and KKT violations use optimization-scale coefficients. A finite KKT tolerance certifies approximate stationarity, not existence of a finite exact optimum for a separated or constant-boundary binomial model. 

<a id="impl-aa3fc49ed935e3a04b43b1bb462a88bb2fc7cf4cb7846ccd98938c187b3fb6d6"></a>

## Inherent implementation

[Source](<https://github.com/jolars/shrinkage/blob/eeafe449edce19d3c552a03060f681ae3891af74/src/fit/irls.rs>)

```rust
impl IrlsFit
```

<a id="method-coefficients-aa3fc49ed935e3a04b43b1bb462a88bb2fc7cf4cb7846ccd98938c187b3fb6d6"></a>

### `coefficients`

```rust
pub fn coefficients(&self) -> &[f64]
```

[Source](<https://github.com/jolars/shrinkage/blob/eeafe449edce19d3c552a03060f681ae3891af74/src/fit/irls.rs>)

Original-scale coefficients in training-column order. 

<a id="method-coordinate_sweeps-aa3fc49ed935e3a04b43b1bb462a88bb2fc7cf4cb7846ccd98938c187b3fb6d6"></a>

### `coordinate_sweeps`

```rust
pub fn coordinate_sweeps(&self) -> usize
```

[Source](<https://github.com/jolars/shrinkage/blob/eeafe449edce19d3c552a03060f681ae3891af74/src/fit/irls.rs>)

Total coordinate sweeps across all quadratic models for this fit. 

<a id="method-intercept-aa3fc49ed935e3a04b43b1bb462a88bb2fc7cf4cb7846ccd98938c187b3fb6d6"></a>

### `intercept`

```rust
pub fn intercept(&self) -> f64
```

[Source](<https://github.com/jolars/shrinkage/blob/eeafe449edce19d3c552a03060f681ae3891af74/src/fit/irls.rs>)

Original-scale intercept, including the correction for centering. 

<a id="method-iterations-aa3fc49ed935e3a04b43b1bb462a88bb2fc7cf4cb7846ccd98938c187b3fb6d6"></a>

### `iterations`

```rust
pub fn iterations(&self) -> usize
```

[Source](<https://github.com/jolars/shrinkage/blob/eeafe449edce19d3c552a03060f681ae3891af74/src/fit/irls.rs>)

Number of accepted outer IRLS steps. 

<a id="method-kkt_violation-aa3fc49ed935e3a04b43b1bb462a88bb2fc7cf4cb7846ccd98938c187b3fb6d6"></a>

### `kkt_violation`

```rust
pub fn kkt_violation(&self) -> f64
```

[Source](<https://github.com/jolars/shrinkage/blob/eeafe449edce19d3c552a03060f681ae3891af74/src/fit/irls.rs>)

Maximum full-loss KKT violation, including the unpenalized intercept. 

<a id="method-objective-aa3fc49ed935e3a04b43b1bb462a88bb2fc7cf4cb7846ccd98938c187b3fb6d6"></a>

### `objective`

```rust
pub fn objective(&self) -> f64
```

[Source](<https://github.com/jolars/shrinkage/blob/eeafe449edce19d3c552a03060f681ae3891af74/src/fit/irls.rs>)

Final primal objective `P(beta_0, beta) = F(beta_0, beta) + R(beta)`. 

<a id="method-predict-aa3fc49ed935e3a04b43b1bb462a88bb2fc7cf4cb7846ccd98938c187b3fb6d6"></a>

### `predict`

```rust
pub fn predict<M: RawColumns<f64> + ?Sized>(
    &self,
    x: &M
) -> Result<Vec<f64>, FitError>
```

[Source](<https://github.com/jolars/shrinkage/blob/eeafe449edce19d3c552a03060f681ae3891af74/src/fit/irls.rs>)

Predict linear predictors using original-scale parameters and raw columns. 

<a id="method-predict-aa3fc49ed935e3a04b43b1bb462a88bb2fc7cf4cb7846ccd98938c187b3fb6d6-documentation-errors"></a>

#### Errors

Reject feature-count mismatches, invalid entries, or nonfinite arithmetic. 

<a id="method-preprocessing-aa3fc49ed935e3a04b43b1bb462a88bb2fc7cf4cb7846ccd98938c187b3fb6d6"></a>

### `preprocessing`

```rust
pub fn preprocessing(&self) -> &Preprocessing
```

[Source](<https://github.com/jolars/shrinkage/blob/eeafe449edce19d3c552a03060f681ae3891af74/src/fit/irls.rs>)

Training normalization reused by this fit. 

<a id="method-stopping_criterion-aa3fc49ed935e3a04b43b1bb462a88bb2fc7cf4cb7846ccd98938c187b3fb6d6"></a>

### `stopping_criterion`

```rust
pub fn stopping_criterion(&self) -> StoppingCriterion
```

[Source](<https://github.com/jolars/shrinkage/blob/eeafe449edce19d3c552a03060f681ae3891af74/src/fit/irls.rs>)

The absolute KKT stopping criterion used for this fit. 

<a id="method-stopping_threshold-aa3fc49ed935e3a04b43b1bb462a88bb2fc7cf4cb7846ccd98938c187b3fb6d6"></a>

### `stopping_threshold`

```rust
pub fn stopping_threshold(&self) -> f64
```

[Source](<https://github.com/jolars/shrinkage/blob/eeafe449edce19d3c552a03060f681ae3891af74/src/fit/irls.rs>)

Absolute KKT threshold. 

<a id="method-stopping_value-aa3fc49ed935e3a04b43b1bb462a88bb2fc7cf4cb7846ccd98938c187b3fb6d6"></a>

### `stopping_value`

```rust
pub fn stopping_value(&self) -> f64
```

[Source](<https://github.com/jolars/shrinkage/blob/eeafe449edce19d3c552a03060f681ae3891af74/src/fit/irls.rs>)

Final full-loss KKT violation. 

<a id="method-termination-aa3fc49ed935e3a04b43b1bb462a88bb2fc7cf4cb7846ccd98938c187b3fb6d6"></a>

### `termination`

```rust
pub fn termination(&self) -> Termination
```

[Source](<https://github.com/jolars/shrinkage/blob/eeafe449edce19d3c552a03060f681ae3891af74/src/fit/irls.rs>)

Whether a full KKT check passed or the outer iteration budget expired. 

<a id="method-working_set_diagnostics-aa3fc49ed935e3a04b43b1bb462a88bb2fc7cf4cb7846ccd98938c187b3fb6d6"></a>

### `working_set_diagnostics`

```rust
pub fn working_set_diagnostics(&self) -> &shrinkage::WorkingSetDiagnostics
```

[Source](<https://github.com/jolars/shrinkage/blob/eeafe449edce19d3c552a03060f681ae3891af74/src/fit/irls.rs>)

Work performed by heuristic feature selection, separate from safe screening. 

<a id="impl-27a645154e09a3bc75dc0090869e0fd4e34ad6907f8d84dc61e39017ca1ba7e3"></a>

## Implementation of Clone

[Source](<https://github.com/jolars/shrinkage/blob/eeafe449edce19d3c552a03060f681ae3891af74/src/fit/irls.rs>)

```rust
impl Clone for IrlsFit
```

<a id="method-clone-27a645154e09a3bc75dc0090869e0fd4e34ad6907f8d84dc61e39017ca1ba7e3"></a>

### `clone`

```rust
fn clone(&self) -> Self
```

[Source](<https://github.com/jolars/shrinkage/blob/eeafe449edce19d3c552a03060f681ae3891af74/src/fit/irls.rs>)

<a id="impl-8a6962a57a0c734a42999c68d4a9566fe30ac970ec45e7afc2d80c9c2547a429"></a>

## Implementation of Debug

[Source](<https://github.com/jolars/shrinkage/blob/eeafe449edce19d3c552a03060f681ae3891af74/src/fit/irls.rs>)

```rust
impl Debug for IrlsFit
```

<a id="method-fmt-8a6962a57a0c734a42999c68d4a9566fe30ac970ec45e7afc2d80c9c2547a429"></a>

### `fmt`

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

[Source](<https://github.com/jolars/shrinkage/blob/eeafe449edce19d3c552a03060f681ae3891af74/src/fit/irls.rs>)

<a id="impl-e1f0ce1aaaa5ad76e38b6351edca10cb71b19b004469567e5f6c587df1136f7f"></a>

## [Implementation of ValidationFit](<5d173ce7dcb2d06e349b61bf9258286c35ff88ac41d7933ce0fe0553c3337dce>)

[Source](<https://github.com/jolars/shrinkage/blob/eeafe449edce19d3c552a03060f681ae3891af74/src/cross_validation.rs>)

```rust
impl ValidationFit for shrinkage::IrlsFit
```

<a id="method-predict-e1f0ce1aaaa5ad76e38b6351edca10cb71b19b004469567e5f6c587df1136f7f"></a>

### `predict`

```rust
fn predict<M: RawColumns<f64> + ?Sized>(
    &self,
    design: &M
) -> Result<Vec<f64>, FitError>
```

[Source](<https://github.com/jolars/shrinkage/blob/eeafe449edce19d3c552a03060f681ae3891af74/src/cross_validation.rs>)

<a id="method-termination-e1f0ce1aaaa5ad76e38b6351edca10cb71b19b004469567e5f6c587df1136f7f"></a>

### `termination`

```rust
fn termination(&self) -> Termination
```

[Source](<https://github.com/jolars/shrinkage/blob/eeafe449edce19d3c552a03060f681ae3891af74/src/cross_validation.rs>)

<a id="impl-6f228f4001657ab5314d1bac09946e47dfb5117862fd173d99c166b02ff2e70e"></a>

## Implementation of Freeze

```rust
impl Freeze for IrlsFit
```

<a id="impl-6e5cf4f68aa8b0f0b6dfe81ce8b9a67d499f1e9ec6393c600d069205a3f73b24"></a>

## Implementation of RefUnwindSafe

```rust
impl RefUnwindSafe for IrlsFit
```

<a id="impl-05ff6904c6dbc532ad9c38ea1cd39826d13d3b0480ee3a913a912d7b79f5c747"></a>

## Implementation of Send

```rust
impl Send for IrlsFit
```

<a id="impl-3aacdfcea74b688227a9cf1769ec27eb2856053d83f93092a57c991a0e16d236"></a>

## Implementation of Sync

```rust
impl Sync for IrlsFit
```

<a id="impl-29c69b118cb2b16790da3a13d437338051f4db0c7f4908f0c6fedf50240276dd"></a>

## Implementation of Unpin

```rust
impl Unpin for IrlsFit
```

<a id="impl-3e5afc8fca5a6358b512f3861822661a3520bc25bed4a005bb72139d2c937827"></a>

## Implementation of UnsafeUnpin

```rust
impl UnsafeUnpin for IrlsFit
```

<a id="impl-c6fbe6bd2526f8e755df70e20db7c2d9136ee0e5bad812a7b1449cfbe2d89982"></a>

## Implementation of UnwindSafe

```rust
impl UnwindSafe for IrlsFit
```

<a id="impl-1e5682dc18e03c648aa9b125290c107c1e8d96ce8a179a8532e4057da4daf0cd"></a>

## Implementation of Any

```rust
impl<T> Any for T where T: 'static + ?Sized
```

<a id="impl-6c0b25c2c92cdb117802d9c0a4c70afc9a8bfb0da875bc6e66191e2349fcdf3f"></a>

## Implementation of Borrow

```rust
impl<T> Borrow<T> for T where T: ?Sized
```

<a id="impl-796e80d926348273a22b04d8e84f510693b11c06ec57c3c3e2e8c1524094a85c"></a>

## Implementation of BorrowMut

```rust
impl<T> BorrowMut<T> for T where T: ?Sized
```

<a id="impl-8360e4092e7ec4a05a26dd304cd739398f0cacc50c8d08dd5be0223d1a08d02e"></a>

## Implementation of ByRef

```rust
impl<T> ByRef<T> for T
```

<a id="impl-dbb1293b7b5dd80c4d9a98cfdd6843dc7470224c0b1387731cd418da07046d7b"></a>

## Implementation of CastableFrom

```rust
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT where ST: ?Sized, DT: ?Sized
```

<a id="impl-97b65e7dfc44b5ecaa495a3a19fe737914a1e9f8532200cf8f46191314e7d777"></a>

## Implementation of CastableFrom

```rust
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT where ST: ?Sized, DT: ?Sized
```

<a id="impl-86d7da2bfd1140cc1675dfe6a975e6a2762338ab32731152da0723858ef3aa81"></a>

## Implementation of CloneToUninit

```rust
impl<T> CloneToUninit for T where T: Clone
```

<a id="impl-c22bdd3b1b677b66eb32d1c182cc1410c7f0c46491dd74e6a659647c238d19ec"></a>

## Implementation of From

```rust
impl<T> From<T> for T
```

<a id="impl-5adf6ca1830f30fbbac655ab8ff394d254954df7ededc7cc833c72fdc87d6f00"></a>

## Implementation of Imply

```rust
impl<T, U> Imply<T> for U where T: ?Sized, U: ?Sized
```

<a id="impl-85eec431edd188129f88290bbcb748e4d2fdc97f7efef3c162b8c252286ffec0"></a>

## Implementation of Into

```rust
impl<T, U> Into<U> for T where U: From<T>
```

<a id="impl-c40268dd59dd3329202d3c0544c62372e98ff3baa8ec442ec00752e024ec1d06"></a>

## Implementation of IntoEither

```rust
impl<T> IntoEither for T
```

<a id="impl-5655b1ef858b34a584cb80104f040c8a4063ced0d281311a0833ed12aefde86e"></a>

## Implementation of Pointable

```rust
impl<T> Pointable for T
```

<a id="impl-8cc2aa01198fc9fa44f08b889f62988d70d2a7f4f0f11f4666d4c08bdaddb22a"></a>

## Implementation of Read

```rust
impl<T> Read<Exclusive, BecauseExclusive> for T where T: ?Sized
```

<a id="impl-5ea09131039c62dd92b119d480a35c7e2b33d2b81dccf0b849f6b1f19f4bda24"></a>

## Implementation of Same

```rust
impl<T> Same for T
```

<a id="impl-7ee6ff38d6674f5edfe4734359062c2a67a572cff5899a89704764822b931c7f"></a>

## Implementation of SupersetOf

```rust
impl<SS, SP> SupersetOf<SS> for SP where SS: SubsetOf<SP>
```

<a id="impl-a8ef6e94191301c3685488478f4905086c47137bac2d606ea4d09631d5472b06"></a>

## Implementation of ToOwned

```rust
impl<T> ToOwned for T where T: Clone
```

<a id="impl-83960135d00d98080c95a08867729696e36811280c2dd9cf34c1b4fe21c81e18"></a>

## Implementation of TryFrom

```rust
impl<T, U> TryFrom<U> for T where U: Into<T>
```

<a id="impl-1cc495bcaa5112ffb304e7f0de674feca391fd97f47bec86033a9225b72ac05c"></a>

## Implementation of TryInto

```rust
impl<T, U> TryInto<U> for T where U: TryFrom<T>
```