Struct Site 

pub struct Site<const N: usize> { /* private fields */ }

A single site of SAF likelihoods for N populations.

Internally, the site is stored as a contiguous block of memory, with all values from the first population first, then the second, and so on. Site::shape gives the number of values for each population.

Implementations

impl<const N: usize> Site<N>

pub fn as_mut_slice(&mut self) -> &mut [f32]

Returns a mutable reference to the values of the SAF site as a flat slice.

See the Site documentation for details on the storage order.

pub fn iter_mut(&mut self) -> IterMut<'_, f32>

Returns an iterator over all values in the site.

See the Site documentation for details on the storage order.

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

Returns a new SAF site.

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::Site;
let vec = vec![0.0, 0.1, 0.2, 1.0, 1.2];
let shape = [3, 2];
let site = Site::new(vec, 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::Site;
let vec = vec![0.0, 0.1, 0.2, 1.0, 1.2];
let wrong_shape = [6, 2];
assert!(Site::new(vec, wrong_shape).is_err());

pub fn view(&self) -> SiteView<'_, N>

Returns a view of the entire site.

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 &'a Site<N>

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

Returns a SAF site view of self.

impl<const N: usize> AsSiteView<N> for Site<N>

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

Returns a SAF site view of self.

impl<const N: usize> Clone for Site<N>

fn clone(&self) -> Site<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const N: usize> Debug for Site<N>

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

Formats the value using the given formatter.

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

type Item = SiteView<'a, N>

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

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

type Item = SiteView<'a, N>

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

impl<const N: usize> PartialEq for Site<N>

fn eq(&self, other: &Site<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<const D: usize> StreamEmSite<D> for Site<D>

fn from_shape(shape: [usize; D]) -> Self

Creates a new site from its shape.

impl<const N: usize> StructuralPartialEq for Site<N>