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 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220
use std::fmt::{Debug, Write};
use std::iter::FromIterator;
use std::ops::{Index, IndexMut, Range};
/// A type behaving like a sequence over the type `Item`.
pub trait Sequence<Item, Subsequence: Sequence<Item, Subsequence> + ?Sized>:
Index<usize, Output = Item> + Index<Range<usize>, Output = Subsequence>
{
/// The iterator type of the sequence.
type Iterator<'a>: DoubleEndedIterator<Item = &'a Item>
where
Self: 'a,
Item: 'a;
/// Returns a prefix with length `len` of this sequence.
/// Panics if `len >= self.len()`.
fn prefix(&self, len: usize) -> &Subsequence {
debug_assert!(len < self.len());
&self[0..len]
}
/// Returns a suffix with length `len` of this sequence.
/// Panics if `len >= self.len()`.
fn suffix(&self, len: usize) -> &Subsequence {
debug_assert!(len < self.len());
&self[self.len() - len..self.len()]
}
/// Returns an iterator over the sequence.
fn iter(&self) -> Self::Iterator<'_>;
/// Returns the length of the sequence.
fn len(&self) -> usize;
/// Returns true if the sequence is empty.
fn is_empty(&self) -> bool {
self.len() == 0
}
/// Returns the first item of the sequence.
fn first(&self) -> Option<&Item> {
self.iter().next()
}
/// Returns the last item of the sequence.
fn last(&self) -> Option<&Item> {
self.iter().last()
}
/// Returns true if this is a proper subsequence of the given sequence.
/// Proper means that the sequences are not equal.
fn is_proper_subsequence_of(&self, other: &Self) -> bool
where
Item: Eq,
{
if self.len() >= other.len() {
return false;
}
for start_index in 0..=other.len() - self.len() {
let mut found_subsequence = true;
for index in 0..self.len() {
if self[index] != other[start_index + index] {
found_subsequence = false;
break;
}
}
if found_subsequence {
return true;
}
}
false
}
/// Returns true if this sequence contains the given item.
fn contains(&self, item: &Item) -> bool
where
Item: Eq,
{
self.iter().any(|i| item == i)
}
/// Returns an iterator over this sequence merged before the given other sequence under the assumption that the sequences can be merged this way.
/// A merge is possible if a non-empty suffix of this sequence equals a non-empty prefix of the other sequence.
///
/// The method panics if this sequence does not contain the first item of the other sequence or the other sequence is empty.
/// The method does not fail if the sequences are not mergeable for other reasons.
fn forward_merge_iter_assume_mergeable<'a>(
&'a self,
suffix: &'a Self,
) -> std::iter::Chain<Self::Iterator<'a>, std::iter::Skip<Self::Iterator<'a>>>
where
Item: Eq,
{
let first_item_index = self
.iter()
.enumerate()
.filter(|(_, i)| *i == suffix.first().expect("The given sequence is empty."))
.map(|(i, _)| i)
.next()
.expect("This sequence does not contain the first item of the given sequence.");
self.iter()
.chain(suffix.iter().skip(self.len() - first_item_index))
}
/// Returns an iterator over this sequence merged after the given other sequence under the assumption that the sequences can be merged this way.
/// A merge is possible if a non-empty prefix of this sequence equals a non-empty suffix of the other sequence.
///
/// The method panics if the other sequence does not contain the first item of this sequence or this sequence is empty.
/// The method does not fail if the sequences are not mergeable for other reasons.
fn backward_merge_iter_assume_mergeable<'a>(
&'a self,
suffix: &'a Self,
) -> std::iter::Chain<Self::Iterator<'a>, std::iter::Skip<Self::Iterator<'a>>>
where
Item: Eq,
{
suffix.forward_merge_iter_assume_mergeable(self)
}
/// Converts the sequence to a string using the debug formatting of the items.
///
/// ```rust
/// use traitsequence::interface::Sequence;
///
/// let sequence = [0, 2, 1];
/// debug_assert_eq!(sequence.to_debug_string(), "[0, 2, 1]".to_string());
///
/// let sequence = ["a", "c", "b"];
/// debug_assert_eq!(sequence.to_debug_string(), "[\"a\", \"c\", \"b\"]".to_string());
/// ```
fn to_debug_string(&self) -> String
where
Item: Debug,
{
let mut result = String::new();
write!(result, "[").unwrap();
let mut once = true;
for item in self.iter() {
if once {
once = false;
} else {
write!(result, ", ").unwrap();
}
write!(result, "{:?}", item).unwrap();
}
write!(result, "]").unwrap();
result
}
}
/// A type behaving like a mutable sequence over the type `Item`.
/// That is, its items can be mutated, but the sequence it self can not.
/// For a sequence where items can be appended, rearranged etc. see [EditableSequence].
pub trait SequenceMut<Item, Subsequence: SequenceMut<Item, Subsequence> + ?Sized>:
Sequence<Item, Subsequence>
+ IndexMut<usize, Output = Item>
+ IndexMut<Range<usize>, Output = Subsequence>
{
/// The mutable iterator type of the sequence.
type IteratorMut<'a>: Iterator<Item = &'a mut Item>
where
Self: 'a,
Item: 'a;
/// Returns a mutable iterator over the sequence.
fn iter_mut(&mut self) -> Self::IteratorMut<'_>;
}
/// A type behaving like an owned sequence over the type `Item`.
/// Currently this only means the sequence is `Sized`.
pub trait OwnedSequence<Item, Subsequence: Sequence<Item, Subsequence> + ?Sized>:
Sequence<Item, Subsequence> + Sized
{
}
/// A type behaving like an cloneable sequence over the type `Item`.
/// Currently this only means the sequence is `ToOwned`.
pub trait CloneableSequence<Item: Clone, Subsequence: CloneableSequence<Item, Subsequence> + ?Sized>:
ToOwned
{
}
/// A type behaving like a sequence over the type `Item` that can be edited.
/// This sequences items can not necessarily be mutated themselves, but they can be rearranged or new items can be appended etc.
/// For a sequence where the items themselves can be mutated, see [SequenceMut].
pub trait EditableSequence<Item, Subsequence: Sequence<Item, Subsequence> + ?Sized>:
Sequence<Item, Subsequence> + Extend<Item> + IntoIterator<Item = Item> + FromIterator<Item>
{
/// See [Vec::split_off].
fn split_off(&mut self, at: usize) -> Self;
/// Extend this sequence from a sequence of compatible items.
fn extend_into<
ExtensionItem: Into<Item>,
ExtensionSource: IntoIterator<Item = ExtensionItem>,
>(
&mut self,
extension: ExtensionSource,
) {
self.extend(extension.into_iter().map(Into::into));
}
}
#[cfg(test)]
mod tests {
use crate::interface::Sequence;
#[test]
fn test_merge_sequences_simple() {
let s1 = vec![0, 1, 2, 3, 4, 5];
let s2 = vec![3, 4, 5, 6, 7, 8];
let merged: Vec<_> = s1
.forward_merge_iter_assume_mergeable(&s2)
.copied()
.collect();
debug_assert_eq!(merged, vec![0, 1, 2, 3, 4, 5, 6, 7, 8]);
}
}