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 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392
//! This module implements a quad vector to store a sequence with values in the range [0..3],
//! i.e., two bits symbols.
//!
//! This implementation uses a vector of `DataLine`. Each `DataLine` is an array of fourĀ `u128`
//! and stores (up to) 256 symbols. As each `DataLine` is 512 bits it fits in a cache line.
//! The use of `DataLine` in our setting is particulary conveninet because a vector of `DataLine` is aligned.
//! This way, we load just one cache line everytime we access a `DataLine`.
use crate::{AccessQuad, RankQuad, SpaceUsage}; // Traits
use num_traits::int::PrimInt;
use num_traits::AsPrimitive;
use serde::{Deserialize, Serialize};
// A quad vector is made of `DataLine`s. Each line consists of
// four u128, so each `DataLine` is 512 bits and fits in a cache line.
// This way, it is easier to force the alignment to 64 bytes.
//
// We support `access`, `rank`, and `select queries for each line.
#[derive(Copy, Clone, Default, Eq, PartialEq, Serialize, Deserialize, Debug)]
#[repr(C, align(64))]
struct DataLine {
words: [u128; 4],
}
impl DataLine {
const MASK: u128 = 3;
const REPEATEDSYMB: [u128; 2] = [
u128::MAX, // !bit repeated
0,
];
#[inline(always)]
fn normalize(&self, symbol: u8) -> (u128, u128) {
let mask_high = Self::REPEATEDSYMB[(symbol >> 1) as usize];
let mask_low = Self::REPEATEDSYMB[(symbol & 1) as usize];
let word_high_0 = self.words[0] ^ mask_high;
let word_low_0 = self.words[2] ^ mask_low;
let word_high_1 = self.words[1] ^ mask_high;
let word_low_1 = self.words[3] ^ mask_low;
(word_high_0 & word_low_0, word_high_1 & word_low_1)
}
// Set the position `i` to `symbol`
#[inline]
fn set_symbol(&mut self, symbol: u8, i: u8) {
// The higher bit is placed in the first two words,
// the lower bit is placed in the second two words.
let word_id_high = i >> 7;
let word_id_low = word_id_high + 2;
let cur_shift = i & 127;
let symbol = (symbol as u128) & Self::MASK;
self.words[word_id_high as usize] |= (symbol >> 1) << cur_shift;
self.words[word_id_low as usize] |= (symbol & 1) << cur_shift;
}
}
impl AccessQuad for DataLine {
#[inline(always)]
fn get(&self, i: usize) -> Option<u8> {
assert!(i < 256);
// SAFETY: bounds already checked
Some(unsafe { self.get_unchecked(i) })
}
#[inline(always)]
unsafe fn get_unchecked(&self, i: usize) -> u8 {
let word_id_high = i >> 7;
let word_id_low = word_id_high + 2;
let cur_shift = i & 127;
let word_high = unsafe { *self.words.get_unchecked(word_id_high) };
let word_low = unsafe { *self.words.get_unchecked(word_id_low) };
((word_high >> (cur_shift) & 1) << 1 | (word_low >> cur_shift) & 1) as u8
}
}
impl RankQuad for DataLine {
#[inline(always)]
fn rank(&self, symbol: u8, i: usize) -> Option<usize> {
if symbol >= 4 || i > 256 {
return None;
}
// SAFETY: checks above guarantee correctness
Some(unsafe { self.rank_unchecked(symbol, i) })
}
#[inline(always)]
unsafe fn rank_unchecked(&self, symbol: u8, i: usize) -> usize {
debug_assert!(symbol <= 3, "Only the four symbols in [0, 3] are possible.");
debug_assert!(i <= 256, "Only positions up to 256 are possible");
let (word_0, word_1) = self.normalize(symbol);
let last_word = i >> 7;
let offset = i & 127; // offset within the last word
let mask_full = u128::MAX;
let mask_offset = (1_u128 << offset) - 1;
let mask = if last_word == 0 {
mask_offset
} else {
mask_full
};
let mut rank = (word_0 & mask).count_ones();
let mask = if last_word == 1 {
mask_offset
} else {
mask_full * (last_word == 2) as u128
};
rank += (word_1 & mask).count_ones();
rank as usize
}
}
// The trait SelectQuad is not implemented because RSSupport needs to it by hand :-)
impl SpaceUsage for DataLine {
fn space_usage_byte(&self) -> usize {
64
}
}
#[derive(Clone, Default, Eq, PartialEq, Serialize, Deserialize, Debug)]
pub struct QVector {
data: Box<[DataLine]>,
position: usize,
}
impl QVector {
/// Check if the vector is empty.
///
/// # Examples
/// ```
/// use qwt::QVector;
///
/// let qv = QVector::default();
/// assert!(qv.is_empty());
/// ```
pub fn is_empty(&self) -> bool {
self.position == 0
}
/// Return the number of symbols in the quaternary vector.
///
/// # Examples
/// ```
/// use qwt::QVector;
///
/// let qv: QVector = [0, 1, 2, 3].into_iter().cycle().take(10).collect();
/// assert_eq!(qv.len(), 10);
/// ```
pub fn len(&self) -> usize {
self.position >> 1
}
/// Return an iterator over the values in the quad vector.
///
/// # Examples
///
/// ```
/// use qwt::QVector;
///
/// let qv: QVector = [0, 1, 2, 3].into_iter().cycle().take(100).collect();;
///
/// for (i, v) in qv.iter().enumerate() {
/// assert_eq!((i%4) as u8, v);
/// }
/// ```
pub fn iter(&self) -> QVectorIterator<&QVector> {
QVectorIterator { i: 0, qv: self }
}
}
impl AccessQuad for QVector {
/// Access the `i`th value in the quaternary vector.
///
/// # Safety
/// Calling this method with an out-of-bounds index is undefined behavior.
///
/// # Examples
/// ```
/// use qwt::{QVector, AccessQuad};
///
/// let qv: QVector = [0, 1, 2, 3].into_iter().cycle().take(10).collect();
/// unsafe {
/// assert_eq!(qv.get_unchecked(8), 0);
/// }
/// ```
#[inline(always)]
unsafe fn get_unchecked(&self, i: usize) -> u8 {
debug_assert!(i < self.position / 2);
let line = i >> 8;
let pos_in_last_line = i & 255;
let line = self.data.get_unchecked(line);
line.get_unchecked(pos_in_last_line)
}
/// Access the `i`th value in the quaternary vector
/// or `None` if `i` is out of bounds.
///
/// # Examples
/// ```
/// use qwt::QVector;
/// use qwt::AccessQuad;
///
/// let qv: QVector = [0, 1, 2, 3].into_iter().cycle().take(10).collect();
///
/// assert_eq!(qv.get(8), Some(0));
/// assert_eq!(qv.get(10), None);
/// ```
#[inline(always)]
fn get(&self, i: usize) -> Option<u8> {
if i >= self.position >> 1 {
return None;
}
// SAFETY: Check before guarantees to be not out of bound
unsafe { Some(self.get_unchecked(i)) }
}
}
impl SpaceUsage for QVector {
fn space_usage_byte(&self) -> usize {
self.data.space_usage_byte() + 8
}
}
impl AsRef<QVector> for QVector {
fn as_ref(&self) -> &QVector {
self
}
}
pub struct QVectorIterator<QV: AsRef<QVector>> {
i: usize,
qv: QV,
}
impl<QV: AsRef<QVector>> Iterator for QVectorIterator<QV> {
type Item = u8;
fn next(&mut self) -> Option<Self::Item> {
// TODO: this may be faster without calling get.
let qv = self.qv.as_ref();
self.i += 1;
qv.get(self.i - 1)
}
}
impl IntoIterator for QVector {
type IntoIter = QVectorIterator<QVector>;
type Item = u8;
fn into_iter(self) -> Self::IntoIter {
QVectorIterator { i: 0, qv: self }
}
}
impl<'a> IntoIterator for &'a QVector {
type IntoIter = QVectorIterator<&'a QVector>;
type Item = u8;
fn into_iter(self) -> Self::IntoIter {
self.iter()
}
}
impl<T> FromIterator<T> for QVector
where
T: PrimInt + AsPrimitive<u8>,
{
fn from_iter<I>(iter: I) -> Self
where
I: IntoIterator<Item = T>,
{
let mut qvb = QVectorBuilder::default();
qvb.extend(iter);
qvb.build()
}
}
/// Builder struct to build a `qvector` by pushing symbol by symbol.
/// The main reasons for this builder are
/// - we want to force `qvector` to be immutable. So, we don't want any method that
/// could change it;
/// - we want to save space when symbols are produced one after the other and store
/// them using 2 bits each.
#[derive(Clone, Default, Eq, PartialEq)]
pub struct QVectorBuilder {
data: Vec<DataLine>,
position: usize,
}
impl QVectorBuilder {
const N_BITS_WORD: usize = 128 * 4;
/// Build the `qvector`.
pub fn build(self) -> QVector {
QVector {
data: self.data.into_boxed_slice(),
position: self.position,
}
}
/// Create a new empty dynamic quad vector.
pub fn new() -> Self {
Self::default()
}
/// Creates an empty dynamic quad vector with the capacity of `n` quad symbols.
///
/// # Panics
/// Panics if the new capacity exceeds `isize::MAX` bytes.
pub fn with_capacity(n: usize) -> Self {
let capacity = (2 * n + Self::N_BITS_WORD - 1) / Self::N_BITS_WORD;
Self {
data: Vec::with_capacity(capacity),
position: 0,
}
}
/// Appends the (last 2 bits of the) value `symbol` at the end
/// of the quad vector.
///
/// It does not check if the value `symbol` fits is actually in [0..3].
/// The value is truncated to the two least significant bits.
///
/// # Panics
/// Panics if the new capacity exceeds `isize::MAX` bytes.
pub fn push(&mut self, symbol: u8) {
let pos_in_last_line = (self.position / 2) & 255;
if pos_in_last_line == 0 {
// no more space in the current line
self.data.push(DataLine::default());
}
self.data
.last_mut()
.unwrap()
.set_symbol(symbol, pos_in_last_line as u8);
self.position += 2;
}
}
impl<T> FromIterator<T> for QVectorBuilder
where
T: PrimInt + AsPrimitive<u8>,
{
fn from_iter<I>(iter: I) -> Self
where
I: IntoIterator<Item = T>,
{
let mut qvb = QVectorBuilder::default();
qvb.extend(iter);
qvb
}
}
impl<T> Extend<T> for QVectorBuilder
where
T: PrimInt + AsPrimitive<u8>,
{
fn extend<I>(&mut self, iter: I)
where
I: IntoIterator<Item = T>,
{
for value in iter {
//debug_assert!((0..4).contains(&value));
self.push(value.as_());
}
}
}
pub mod rs_qvector;
#[cfg(test)]
mod tests;