round_pipers 0.2.0

A way to pipe ndarrays using circular buffers
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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124

use crate::error::Result;
use crate::iterator_common::ChunkGuard;
use crate::pipe_common::PipeState;
use ndarray::{ArrayView, ArrayView1, ArrayViewMut, Dim, Dimension, StrideShape};
use uuid::Uuid;

pub trait Readable<A, D: SizedDimension + Dimension, M: Clone> {
    fn read<R>(
        &self,
        n_to_read: usize,
        n_to_consume: usize,
        f: impl FnOnce(ArrayView<A, D::Larger>, PipeState) -> R,
    ) -> Result<R>
    where
        D::LargerSize: Into<StrideShape<D::Larger>> + Clone,
        D::CurrentSize: Clone;

    fn get_metadata(&self) -> Option<M>;
}

pub trait Writable<A, D: SizedDimension + Dimension, M: Clone> {
    fn write<R>(
        &self,
        n_to_write: usize,
        f: impl FnOnce(ArrayViewMut<A, D::Larger>, PipeState) -> R,
    ) -> Result<R>
    where
        D::LargerSize: Into<StrideShape<D::Larger>> + Clone,
        D::CurrentSize: Clone;

    fn set_metadata(&self, metadata: &M);
}

/// Trait for types that can provide chunks of data for iteration
/// This allows both circular buffer pipes and read-only pipes to work with the same iterator API
pub trait ChunkSource<A, D: SizedDimension + Dimension, M: Clone> {
    /// Read a chunk of data for iteration, returning a ChunkGuard that manages consumption
    fn read_chunk_for_iterator<'a>(
        &'a self,
        reader_id: Uuid,
        n_to_read: usize,
        n_to_consume: usize,
    ) -> Result<ChunkGuard<'a, A, D, M>>
    where
        D::LargerSize: Into<StrideShape<D::Larger>> + Clone,
        D::CurrentSize: Clone;

    /// Get the current read pointer for a reader
    fn get_reader_ptr(&self, reader_id: Uuid) -> Option<usize>;

    /// Advance the read pointer for a reader
    fn advance_reader_ptr(&self, reader_id: Uuid, n_to_consume: usize);

    /// Get metadata
    fn get_metadata(&self) -> Option<M>;
}

pub trait SizedDimension {
    type LargerSize;
    type CurrentSize;
    fn get_larger_array_size(nel: usize, size: Self::CurrentSize) -> Self::LargerSize;
    fn from_array_view(view: ArrayView1<usize>) -> Self::CurrentSize;
}

//Boy I should macro-ify these, and think about support for dynamic arrays.
impl SizedDimension for Dim<[usize; 0]> {
    type CurrentSize = ();
    type LargerSize = usize;
    fn get_larger_array_size(nel: usize, _size: Self::CurrentSize) -> Self::LargerSize {
        nel
    }
    fn from_array_view(_view: ArrayView1<usize>) -> Self::CurrentSize {}
}

impl SizedDimension for Dim<[usize; 1]> {
    type CurrentSize = usize;
    type LargerSize = (usize, usize);
    fn get_larger_array_size(nel: usize, size: Self::CurrentSize) -> Self::LargerSize {
        (nel, size)
    }
    fn from_array_view(view: ArrayView1<usize>) -> Self::CurrentSize {
        view[0]
    }
}
impl SizedDimension for Dim<[usize; 2]> {
    type CurrentSize = (usize, usize);
    type LargerSize = (usize, usize, usize);
    fn get_larger_array_size(nel: usize, size: Self::CurrentSize) -> Self::LargerSize {
        (nel, size.1, size.0)
    }
    fn from_array_view(view: ArrayView1<usize>) -> Self::CurrentSize {
        (view[1], view[0])
    }
}
impl SizedDimension for Dim<[usize; 3]> {
    type CurrentSize = (usize, usize, usize);
    type LargerSize = (usize, usize, usize, usize);
    fn get_larger_array_size(nel: usize, size: Self::CurrentSize) -> Self::LargerSize {
        (nel, size.2, size.1, size.0)
    }
    fn from_array_view(view: ArrayView1<usize>) -> Self::CurrentSize {
        (view[2], view[1], view[0])
    }
}
impl SizedDimension for Dim<[usize; 4]> {
    type CurrentSize = (usize, usize, usize, usize);
    type LargerSize = (usize, usize, usize, usize, usize);
    fn get_larger_array_size(nel: usize, size: Self::CurrentSize) -> Self::LargerSize {
        (nel, size.3, size.2, size.1, size.0)
    }
    fn from_array_view(view: ArrayView1<usize>) -> Self::CurrentSize {
        (view[3], view[2], view[1], view[0])
    }
}
impl SizedDimension for Dim<[usize; 5]> {
    type CurrentSize = (usize, usize, usize, usize, usize);
    type LargerSize = (usize, usize, usize, usize, usize, usize);
    fn get_larger_array_size(nel: usize, size: Self::CurrentSize) -> Self::LargerSize {
        (nel, size.4, size.3, size.2, size.1, size.0)
    }
    fn from_array_view(view: ArrayView1<usize>) -> Self::CurrentSize {
        (view[4], view[3], view[2], view[1], view[0])
    }
}