# shrinkage::MultivariateFit

Shrinkage for Rust · 0.3.0

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

```rust
pub struct MultivariateFit
```

Original-scale feature-by-response coefficients and one intercept per response. 

Coefficients use [`CoefficientLayout`](<62149afd3598115cd84b1d082cb6c3684abff0b85239710acbface17a12565fe>)'s response-major storage. The objective and stopping diagnostics refer to the complete joint optimization-scale problem, including all responses. No dual certificate is reported. 

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

## Inherent implementation

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

```rust
impl MultivariateFit
```

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

### `coefficients`

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

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

Original-scale coefficients in response-major order. 

<a id="method-coefficients_for_response-b4fb8a4f964c68556039f4794ff3be8dfc12315ae7e60fd50a5dc78125e397cb"></a>

### `coefficients_for_response`

```rust
pub fn coefficients_for_response(&self, response: usize) -> Option<&[f64]>
```

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

Original-scale feature coefficients for one response. 

<a id="method-intercepts-b4fb8a4f964c68556039f4794ff3be8dfc12315ae7e60fd50a5dc78125e397cb"></a>

### `intercepts`

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

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

Original-scale intercepts, including each response's centering correction. 

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

### `iterations`

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

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

Number of accepted joint proximal updates. 

<a id="method-layout-b4fb8a4f964c68556039f4794ff3be8dfc12315ae7e60fd50a5dc78125e397cb"></a>

### `layout`

```rust
pub fn layout(&self) -> CoefficientLayout
```

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

Explicit feature and response dimensions of the fitted coefficients. 

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

### `objective`

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

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

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

<a id="method-predict-b4fb8a4f964c68556039f4794ff3be8dfc12315ae7e60fd50a5dc78125e397cb"></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/multivariate.rs>)

Predict response columns from raw training-order features. 

Entry `(observation, response)` has index `response * x.nrows() + observation`. Prediction uses fitted parameters without estimating new statistics. Empty prediction batches return an empty vector. 

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

#### Errors

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

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

### `preprocessing`

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

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

Shared training-feature normalization metadata. 

<a id="method-step_size-b4fb8a4f964c68556039f4794ff3be8dfc12315ae7e60fd50a5dc78125e397cb"></a>

### `step_size`

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

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

Step that passed the final smooth quadratic-bound check. 

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

### `stopping_criterion`

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

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

Criterion selected for the joint fit. 

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

### `stopping_threshold`

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

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

Absolute mapping threshold used to certify convergence. 

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

### `stopping_value`

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

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

Infinity norm of the complete coefficient mapping and all free-intercept derivatives, evaluated at the returned parameters. 

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

### `termination`

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

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

Whether the joint fit converged or exhausted its iteration budget. 

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

## Implementation of Clone

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

```rust
impl Clone for MultivariateFit
```

<a id="method-clone-bcf7006bb91292d062a9488dcc5d21d96921596dbe6059a95b3fa9264e3268d2"></a>

### `clone`

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

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

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

## Implementation of Debug

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

```rust
impl Debug for MultivariateFit
```

<a id="method-fmt-a64c46ea5ef1569dc271fdb1b8cbd537bbcda21b6bffa6b5616b8f1f2d58d2fa"></a>

### `fmt`

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

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

<a id="impl-9c2d93d1a1eb0dd18a2b314973fb911d7d95857f8a1aa4c344be0d8bced91a58"></a>

## Implementation of Freeze

```rust
impl Freeze for MultivariateFit
```

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

## Implementation of RefUnwindSafe

```rust
impl RefUnwindSafe for MultivariateFit
```

<a id="impl-2da1c40ec5a702aefc0dca85287e9853e595a6d55e281a7d54d47841046ac45f"></a>

## Implementation of Send

```rust
impl Send for MultivariateFit
```

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

## Implementation of Sync

```rust
impl Sync for MultivariateFit
```

<a id="impl-2d36025f78d0cee0417bd1a13958d28e751990de2e0142a50490259baca5cb7e"></a>

## Implementation of Unpin

```rust
impl Unpin for MultivariateFit
```

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

## Implementation of UnsafeUnpin

```rust
impl UnsafeUnpin for MultivariateFit
```

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

## Implementation of UnwindSafe

```rust
impl UnwindSafe for MultivariateFit
```

<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>
```
