# shrinkage::CoefficientLayout

Shrinkage for Rust · 0.3.0

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

```rust
pub struct CoefficientLayout
```

A feature-by-response coefficient matrix stored in response-major order. 

Each response owns a contiguous vector of feature coefficients. Entry `(feature, response)` has index `response * nfeatures + feature`. Intercepts are separate and never appear in this layout. This CPU layout is provisional. 

<a id="impl-5222adba01ad98d120d848fd5d72519414864fba2820d2489dcc7ecc7ef2803a"></a>

## Inherent implementation

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

```rust
impl CoefficientLayout
```

<a id="method-index-5222adba01ad98d120d848fd5d72519414864fba2820d2489dcc7ecc7ef2803a"></a>

### `index`

```rust
pub fn index(self, feature: usize, response: usize) -> Option<usize>
```

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

Flat index of a feature and response, or `None` for an invalid axis index. 

<a id="method-is_empty-5222adba01ad98d120d848fd5d72519414864fba2820d2489dcc7ecc7ef2803a"></a>

### `is_empty`

```rust
pub fn is_empty(self) -> bool
```

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

Whether there are no feature coefficients. 

<a id="method-len-5222adba01ad98d120d848fd5d72519414864fba2820d2489dcc7ecc7ef2803a"></a>

### `len`

```rust
pub fn len(self) -> usize
```

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

Number of coefficient entries, excluding intercepts. 

<a id="method-new-5222adba01ad98d120d848fd5d72519414864fba2820d2489dcc7ecc7ef2803a"></a>

### `new`

```rust
pub fn new(nfeatures: usize, nresponses: usize) -> Result<Self, FitError>
```

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

Specify both axes, allowing zero features but requiring a response. 

<a id="method-new-5222adba01ad98d120d848fd5d72519414864fba2820d2489dcc7ecc7ef2803a-documentation-errors"></a>

#### Errors

Reject zero responses or a coefficient count that overflows `usize`. 

<a id="method-nfeatures-5222adba01ad98d120d848fd5d72519414864fba2820d2489dcc7ecc7ef2803a"></a>

### `nfeatures`

```rust
pub fn nfeatures(self) -> usize
```

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

Number of training features. 

<a id="method-nresponses-5222adba01ad98d120d848fd5d72519414864fba2820d2489dcc7ecc7ef2803a"></a>

### `nresponses`

```rust
pub fn nresponses(self) -> usize
```

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

Number of responses. 

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

## Implementation of Clone

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

```rust
impl Clone for CoefficientLayout
```

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

### `clone`

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

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

<a id="impl-4fe94b981735696ee10cb58a3ab5577a7b4a492d4533200de1d9eb768882a4b1"></a>

## Implementation of Copy

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

```rust
impl Copy for CoefficientLayout
```

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

## Implementation of Debug

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

```rust
impl Debug for CoefficientLayout
```

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

### `fmt`

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

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

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

## Implementation of Eq

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

```rust
impl Eq for CoefficientLayout
```

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

## Implementation of PartialEq

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

```rust
impl PartialEq for CoefficientLayout
```

<a id="method-eq-b6637266cc886290807dab577d38a21f637982d725909fc1a334c350fe42f34e"></a>

### `eq`

```rust
fn eq(&self, other: &Self) -> bool
```

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

<a id="impl-4c0c2df4ba4842a52b00ab4439a7bab21fd6b428a5a6e71ba4cd9078206d4bad"></a>

## Implementation of StructuralPartialEq

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

```rust
impl StructuralPartialEq for CoefficientLayout
```

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

## Implementation of Freeze

```rust
impl Freeze for CoefficientLayout
```

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

## Implementation of RefUnwindSafe

```rust
impl RefUnwindSafe for CoefficientLayout
```

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

## Implementation of Send

```rust
impl Send for CoefficientLayout
```

<a id="impl-04397ff4da16064cdec811a1e9a1d69fe0aaee96a2a81e456aa429aec64ab21e"></a>

## Implementation of Sync

```rust
impl Sync for CoefficientLayout
```

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

## Implementation of Unpin

```rust
impl Unpin for CoefficientLayout
```

<a id="impl-94e656cc12c877215f37916fe9d5bc0764105326702239b0346ac93e0208e2e9"></a>

## Implementation of UnsafeUnpin

```rust
impl UnsafeUnpin for CoefficientLayout
```

<a id="impl-595d2a61ac3a869c897a977de76866af213d3c1d3ab6fd51190fb476e8fa2381"></a>

## Implementation of UnwindSafe

```rust
impl UnwindSafe for CoefficientLayout
```

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

## Implementation of Any

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

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

## Implementation of Boilerplate

```rust
impl<T> Boilerplate for T where T: Copy + Send + Sync + Debug + PartialEq + 'static
```

<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-d82ade77f1f9b6253ee49e007ed46a4df3334a6069d1fdef6fd67634c6a19d9a"></a>

## Implementation of Equivalent

```rust
impl<Q, K> Equivalent<K> for Q where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized
```

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

## Implementation of Equivalent

```rust
impl<Q, K> Equivalent<K> for Q where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized
```

<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-e7c74775fb3ccca97dde289783210508c61e4f404318b19c70c2c185f535f063"></a>

## Implementation of Scalar

```rust
impl<T> Scalar for T where T: 'static + Clone + PartialEq + Debug
```

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