sfs-core 0.1.0

Core implementation of tools for working with site frequency spectra
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

//! Array views.

use super::{
    shape::{RemovedAxis, Strides},
    Array, Shape,
};

mod iter;
pub use iter::Iter;

/// A view of an array along a particular axis.
///
/// See [`Array::get_axis`], [`Array::index_axis`], and [`Array::iter_axis`] for methods to obtain
/// axis views.
#[derive(Debug, PartialEq)]
pub struct View<'a, T> {
    data: &'a [T], // first element is first element in view
    shape: RemovedAxis<'a, Shape>,
    strides: RemovedAxis<'a, Strides>,
}

impl<'a, T> Clone for View<'a, T> {
    fn clone(&self) -> Self {
        *self
    }
}

impl<'a, T> Copy for View<'a, T> {}

impl<'a, T> View<'a, T> {
    /// Returns the number of dimensions of the view.
    pub fn dimensions(&self) -> usize {
        self.shape.len()
    }

    /// Returns an iterator over the elements in the view in row-major order.
    pub fn iter(&self) -> Iter<'_, T> {
        Iter::new(*self)
    }

    pub(crate) fn new_unchecked(
        data: &'a [T],
        shape: RemovedAxis<'a, Shape>,
        strides: RemovedAxis<'a, Strides>,
    ) -> Self {
        Self {
            data,
            shape,
            strides,
        }
    }

    /// Returns an owned array corresponding to the view.
    pub fn to_array(&self) -> Array<T>
    where
        T: Clone,
    {
        let data = Vec::from_iter(self.iter().cloned());
        let shape = Shape(self.shape.iter().copied().collect());

        Array::new_unchecked(data, shape)
    }
}