sp-im 0.3.0

Immutable datatypes for no_std use within Substrate
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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169

//! Parallel iterators.
//!
//! These are only available when using the `rayon` feature flag.

use super::*;
use ::rayon::iter::{
  plumbing::{
    bridge,
    Consumer,
    Producer,
    ProducerCallback,
    UnindexedConsumer,
  },
  IndexedParallelIterator,
  IntoParallelRefIterator,
  IntoParallelRefMutIterator,
  ParallelIterator,
};

impl<'a, A> IntoParallelRefIterator<'a> for Vector<A>
where A: Clone + Send + Sync + 'a
{
  type Item = &'a A;
  type Iter = ParIter<'a, A>;

  fn par_iter(&'a self) -> Self::Iter { ParIter { focus: self.focus() } }
}

impl<'a, A> IntoParallelRefMutIterator<'a> for Vector<A>
where A: Clone + Send + Sync + 'a
{
  type Item = &'a mut A;
  type Iter = ParIterMut<'a, A>;

  fn par_iter_mut(&'a mut self) -> Self::Iter {
    ParIterMut { focus: self.focus_mut() }
  }
}

/// A parallel iterator for [`Vector`][Vector].
///
/// [Vector]: ../struct.Vector.html
pub struct ParIter<'a, A>
where A: Clone + Send + Sync {
  focus: Focus<'a, A>,
}

impl<'a, A> ParallelIterator for ParIter<'a, A>
where A: Clone + Send + Sync + 'a
{
  type Item = &'a A;

  fn drive_unindexed<C>(self, consumer: C) -> C::Result
  where C: UnindexedConsumer<Self::Item> {
    bridge(self, consumer)
  }
}

impl<'a, A> IndexedParallelIterator for ParIter<'a, A>
where A: Clone + Send + Sync + 'a
{
  fn drive<C>(self, consumer: C) -> C::Result
  where C: Consumer<Self::Item> {
    bridge(self, consumer)
  }

  fn len(&self) -> usize { self.focus.len() }

  fn with_producer<CB>(self, callback: CB) -> CB::Output
  where CB: ProducerCallback<Self::Item> {
    callback.callback(VectorProducer { focus: self.focus })
  }
}

/// A mutable parallel iterator for [`Vector`][Vector].
///
/// [Vector]: ../struct.Vector.html
pub struct ParIterMut<'a, A>
where A: Clone + Send + Sync {
  focus: FocusMut<'a, A>,
}

impl<'a, A> ParallelIterator for ParIterMut<'a, A>
where A: Clone + Send + Sync + 'a
{
  type Item = &'a mut A;

  fn drive_unindexed<C>(self, consumer: C) -> C::Result
  where C: UnindexedConsumer<Self::Item> {
    bridge(self, consumer)
  }
}

impl<'a, A> IndexedParallelIterator for ParIterMut<'a, A>
where A: Clone + Send + Sync + 'a
{
  fn drive<C>(self, consumer: C) -> C::Result
  where C: Consumer<Self::Item> {
    bridge(self, consumer)
  }

  fn len(&self) -> usize { self.focus.len() }

  fn with_producer<CB>(self, callback: CB) -> CB::Output
  where CB: ProducerCallback<Self::Item> {
    callback.callback(VectorMutProducer { focus: self.focus })
  }
}

struct VectorProducer<'a, A>
where A: Clone + Send + Sync {
  focus: Focus<'a, A>,
}

impl<'a, A> Producer for VectorProducer<'a, A>
where A: Clone + Send + Sync + 'a
{
  type IntoIter = Iter<'a, A>;
  type Item = &'a A;

  fn into_iter(self) -> Self::IntoIter { self.focus.into_iter() }

  fn split_at(self, index: usize) -> (Self, Self) {
    let (left, right) = self.focus.split_at(index);
    (VectorProducer { focus: left }, VectorProducer { focus: right })
  }
}

struct VectorMutProducer<'a, A>
where A: Clone + Send + Sync {
  focus: FocusMut<'a, A>,
}

impl<'a, A> Producer for VectorMutProducer<'a, A>
where A: Clone + Send + Sync + 'a
{
  type IntoIter = IterMut<'a, A>;
  type Item = &'a mut A;

  fn into_iter(self) -> Self::IntoIter { self.focus.into_iter() }

  fn split_at(self, index: usize) -> (Self, Self) {
    let (left, right) = self.focus.split_at(index);
    (VectorMutProducer { focus: left }, VectorMutProducer { focus: right })
  }
}

#[cfg(test)]
mod test {
  use super::super::*;
  use ::rayon::iter::{
    IntoParallelRefIterator,
    IntoParallelRefMutIterator,
    ParallelIterator,
  };

  quickcheck! {
    fn par_iter(input: Vector<i32>) -> bool {
      input.iter().max() == input.par_iter().max()
    }

    fn par_mut_iter(input: Vector<i32>) -> bool {
      let mut vec = input.clone();
      vec.par_iter_mut().for_each(|i| *i = i.overflowing_add(1).0);
      let expected: Vector<i32> = input.clone().into_iter().map(|i| i.overflowing_add(1).0).collect();
      expected == vec
    }
  }
}