Struct SiteView

pub struct SiteView<'a, const N: usize> { /* private fields */ }

A view of a single site of SAF likelihoods for N populations.

Implementations

impl<'a, const N: usize> SiteView<'a, N>

pub fn new(values: &'a [f32], shape: [usize; N]) -> Result<Self, ShapeError<N>>

Returns a new SAF site view;

The number of provided values must be equal to the sum of shapes. See the Site documentation for details on the storage order.

Examples

use winsfs_core::saf::SiteView;
let slice = &[0.0, 0.1, 0.2, 1.0, 1.2];
let shape = [3, 2];
let site = SiteView::new(slice, shape).unwrap();
assert_eq!(site.split(), [&[0.0, 0.1, 0.2][..], &[1.0, 1.2][..]]);

A ShapeError is thrown if the shape does not fit the number of values:

use winsfs_core::saf::SiteView;
let slice = &[0.0, 0.1, 0.2, 1.0, 1.2];
let wrong_shape = [6, 2];
assert!(SiteView::new(slice, wrong_shape).is_err());

pub fn as_slice(&self) -> &[f32]

Returns the values of the site as a flat slice.

See the Site documentation for details on the storage order.

pub fn iter(&self) -> Iter<'_, f32>

Returns an iterator over all values in the site.

See the Site documentation for details on the storage order.

pub fn shape(&self) -> [usize; N]

Returns the shape of the site.

pub fn split(&self) -> [&[f32]; N]

Returns an array of slices corresponding to the sites in each population.

Trait Implementations

impl<'a, const N: usize> AsSiteView<N> for SiteView<'a, N>

fn as_site_view(&self) -> <Self as Lifetime<'_>>::Item

Returns a SAF site view of self.

impl<'a, const N: usize> Clone for SiteView<'a, N>

fn clone(&self) -> SiteView<'a, N>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a, const N: usize> Debug for SiteView<'a, N>

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

Formats the value using the given formatter.

impl<'a, 'b, const N: usize> Lifetime<'a> for SiteView<'b, N>

type Item = SiteView<'a, N>

The inner item, the lifetime of which should be tied to Self.

impl<'a, const N: usize> PartialEq for SiteView<'a, N>

fn eq(&self, other: &SiteView<'a, N>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, const N: usize> Copy for SiteView<'a, N>

impl<'a, const N: usize> StructuralPartialEq for SiteView<'a, N>