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 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525
use std::{fmt::{Debug, Display}, ops::{BitAnd, BitOr, BitXor}};
/// 位图类,根据访问的位看是否被占用
/// 解决经典的是否被占用的问题,但是相对占用大小会较大
///
/// # Examples
///
/// ```
/// use algorithm::BitMap;
/// fn main() {
/// let mut map = BitMap::new(10240);
/// map.add_many(&vec![1, 2, 3, 4, 10]);
/// assert!(map.contains(&1));
/// assert!(!map.contains(&5));
/// assert!(map.contains(&10));
/// map.add_range(7, 16);
/// assert!(!map.contains(&6));
/// assert!(map.contains(&7));
/// assert!(map.contains(&16));
/// assert!(!map.contains(&17));
/// }
/// ```
pub struct BitMap {
entries: Vec<u8>,
cap: usize,
len: usize,
max_key: usize,
min_key: usize,
}
impl BitMap {
pub fn new(cap: usize) -> Self {
let len = cap / 8 + if cap % 8 == 0 { 0 } else { 1 };
Self {
entries: vec![0; len],
cap,
len: 0,
max_key: 0,
min_key: 0,
}
}
pub fn capacity(&self) -> usize {
self.cap
}
pub fn len(&self) -> usize {
self.len
}
pub fn is_empty(&self) -> bool { self.len == 0 }
pub fn clear(&mut self) {
self.entries.fill(0);
self.len = 0;
}
/// 添加新的元素
/// # Examples
///
/// ```
/// use algorithm::BitMap;
/// fn main() {
/// let mut map = BitMap::new(10240);
/// map.add(1);
/// assert!(map.contains(&1));
/// assert!(map.len() == 1);
/// }
/// ```
pub fn add(&mut self, val: usize) -> bool {
let pos = val / 8;
let mask = 1 << val % 8;
let mut success = false;
if self.entries[pos] & mask == 0 {
self.len += 1;
self.max_key = self.max_key.max(val);
self.min_key = self.min_key.min(val);
success = true;
}
self.entries[pos] = self.entries[pos] | mask;
success
}
/// 添加许多新的元素
/// # Examples
///
/// ```
/// use algorithm::BitMap;
/// fn main() {
/// let mut map = BitMap::new(10240);
/// map.add_many(&vec![1, 2, 3, 4, 10]);
/// assert!(map.contains(&1));
/// assert!(map.contains(&10));
/// assert!(map.len() == 5);
/// }
/// ```
pub fn add_many(&mut self, val: &[usize]) {
for v in val {
self.add(*v);
}
}
/// 添加范围内的元素(包含头与结果),批量添加增加效率
/// # Examples
///
/// ```
/// use algorithm::BitMap;
/// fn main() {
/// let mut map = BitMap::new(10240);
/// map.add_range(7, 16);
/// assert!(!map.contains(&6));
/// assert!(map.contains(&7));
/// assert!(map.contains(&16));
/// assert!(!map.contains(&17));
/// assert!(map.len() == 10);
/// }
/// ```
pub fn add_range(&mut self, start: usize, end: usize) {
for pos in start..end.min((start / 8 + 1) * 8) {
self.add(pos);
}
for pos in (start / 8 + 1)..end / 8 {
self.len += 8 - self.entries[pos].count_ones() as usize;
self.entries[pos] = u8::MAX;
}
for pos in start.max((end / 8) * 8)..=end {
self.add(pos);
}
self.min_key = self.min_key.min(start);
self.max_key = self.max_key.max(end);
}
/// 删除元素
/// # Examples
///
/// ```
/// use algorithm::BitMap;
/// fn main() {
/// let mut map = BitMap::new(10240);
/// map.add_range(7, 16);
/// assert!(map.len() == 10);
/// assert!(map.contains(&7));
/// assert!(map.remove(7));
/// assert!(!map.contains(&7));
/// assert!(map.len() == 9);
/// }
/// ```
pub fn remove(&mut self, val: usize) -> bool {
let pos = val / 8;
let mask = 1 << val % 8;
let mut success = false;
if self.entries[pos] & mask != 0 {
self.len -= 1;
success = true;
}
self.entries[pos] = self.entries[pos] & (u8::MAX - mask);
success
}
/// 删除列表中元素
/// # Examples
///
/// ```
/// use algorithm::BitMap;
/// fn main() {
/// let mut map = BitMap::new(10240);
/// map.add_range(7, 16);
/// assert!(map.len() == 10);
/// assert!(map.contains(&7));
/// assert!(map.remove(7));
/// assert!(!map.contains(&7));
/// assert!(map.len() == 9);
/// }
/// ```
pub fn remove_many(&mut self, val: &[usize]) {
for v in val {
self.remove(*v);
}
}
/// 删除范围元素(包含头与尾)
/// # Examples
///
/// ```
/// use algorithm::BitMap;
/// fn main() {
/// let mut map = BitMap::new(10240);
/// map.add_range(7, 16);
/// assert!(map.len() == 10);
/// map.remove_range(7, 15);
/// assert!(map.len() == 1);
/// assert!(map.contains(&16));
/// }
/// ```
pub fn remove_range(&mut self, start: usize, end: usize) {
for pos in start..end.min((start / 8 + 1) * 8) {
self.remove(pos);
}
for pos in (start / 8 + 1)..end / 8 {
self.len -= self.entries[pos].count_ones() as usize;
self.entries[pos] = 0;
}
for pos in start.max((end / 8) * 8)..=end {
self.remove(pos);
}
}
/// 醒看是否包含
/// # Examples
///
/// ```
/// use algorithm::BitMap;
/// fn main() {
/// let mut map = BitMap::new(10240);
/// map.add(7);
/// assert!(map.contains(&7));
/// }
/// ```
pub fn contains(&self, val: &usize) -> bool {
let pos = val / 8;
(self.entries[pos] & (1 << val % 8)) != 0
}
/// 迭代器,通过遍历进行循环,如果位图的容量非常大,可能效率相当低
/// # Examples
///
/// ```
/// use algorithm::BitMap;
/// fn main() {
/// let mut map = BitMap::new(10240);
/// map.add(7);
/// map.add_range(9, 12);
/// map.add_many(&vec![20, 100, 300]);
/// assert!(map.iter().collect::<Vec<_>>() == vec![7, 9, 10, 11, 12, 20, 100, 300]);
/// }
/// ```
pub fn iter(&self) -> Iter<'_> {
Iter {
base: self,
len: self.len,
val: self.min_key,
}
}
/// 是否保留,通过遍历进行循环,如果位图的容量非常大,可能效率相当低
/// # Examples
///
/// ```
/// use algorithm::BitMap;
/// fn main() {
/// let mut map = BitMap::new(10240);
/// map.add_range(9, 16);
/// map.retain(|v| v % 2 == 0);
/// assert!(map.iter().collect::<Vec<_>>() == vec![10, 12, 14, 16]);
/// }
/// ```
pub fn retain<F>(&mut self, mut f: F)
where
F: FnMut(&usize) -> bool,
{
let mut oper = self.len;
for i in self.min_key..=self.max_key {
if oper == 0 {
break;
}
if self.contains(&i) {
oper -= 1;
if !f(&i) {
self.remove(i);
}
}
}
}
/// 是否为子位图
/// # Examples
///
/// ```
/// use algorithm::BitMap;
/// fn main() {
/// let mut map = BitMap::new(10240);
/// map.add_range(9, 16);
/// let mut sub_map = BitMap::new(10240);
/// sub_map.add_range(9, 12);
/// assert!(map.contains_sub(&sub_map));
/// }
/// ```
pub fn contains_sub(&self, other: &BitMap) -> bool {
other.iter().all(|k| self.contains(&k))
}
/// 取两个位图间的交集
/// # Examples
///
/// ```
/// use algorithm::BitMap;
/// fn main() {
/// let mut map = BitMap::new(10240);
/// map.add_range(9, 16);
/// let mut sub_map = BitMap::new(10240);
/// sub_map.add_range(7, 12);
/// let map = map.intersect(&sub_map);
/// assert!(map.iter().collect::<Vec<_>>() == vec![9, 10, 11, 12]);
/// }
/// ```
pub fn intersect(&self, other: &BitMap) -> BitMap {
let mut map = BitMap::new(other.cap.max(self.cap));
let min = self.min_key.max(other.min_key);
let max = self.max_key.min(other.max_key);
for i in min..=max {
if self.contains(&i) && other.contains(&i) {
map.add(i);
}
}
map
}
/// 取两个位图间的并集
/// # Examples
///
/// ```
/// use algorithm::BitMap;
/// fn main() {
/// let mut map = BitMap::new(10240);
/// map.add_range(9, 16);
/// let mut sub_map = BitMap::new(10240);
/// sub_map.add_range(7, 12);
/// let map = map.union(&sub_map);
/// assert!(map.iter().collect::<Vec<_>>() == vec![7, 8, 9, 10, 11, 12, 13, 14, 15, 16]);
/// }
/// ```
pub fn union(&self, other: &BitMap) -> BitMap {
let mut map = BitMap::new(other.cap.max(self.cap));
let min = self.min_key.min(other.min_key);
let max = self.max_key.max(other.max_key);
for i in min..=max {
if self.contains(&i) || other.contains(&i) {
map.add(i);
}
}
map
}
/// 取两个位图间的异或并集
/// # Examples
///
/// ```
/// use algorithm::BitMap;
/// fn main() {
/// let mut map = BitMap::new(10240);
/// map.add_range(9, 16);
/// let mut sub_map = BitMap::new(10240);
/// sub_map.add_range(7, 12);
/// let map = map.union_xor(&sub_map);
/// assert_eq!(map.iter().collect::<Vec<_>>(), vec![7, 8, 13, 14, 15, 16]);
/// }
/// ```
pub fn union_xor(&self, other: &BitMap) -> BitMap {
let mut map = BitMap::new(other.cap.max(self.cap));
let min = self.min_key.min(other.min_key);
let max = self.max_key.max(other.max_key);
for i in min..=max {
if self.contains(&i) ^ other.contains(&i) {
map.add(i);
}
}
map
}
}
impl BitAnd for &BitMap {
type Output=BitMap;
fn bitand(self, rhs: Self) -> Self::Output {
self.intersect(rhs)
}
}
impl BitOr for &BitMap {
type Output=BitMap;
fn bitor(self, rhs: Self) -> Self::Output {
self.union(rhs)
}
}
impl BitXor for &BitMap {
type Output=BitMap;
fn bitxor(self, rhs: Self) -> Self::Output {
self.union_xor(rhs)
}
}
impl Clone for BitMap {
fn clone(&self) -> Self {
Self {
entries: self.entries.clone(),
cap: self.cap,
len: self.len,
max_key: self.max_key,
min_key: self.min_key,
}
}
}
impl FromIterator<usize> for BitMap {
fn from_iter<T: IntoIterator<Item=usize>>(iter: T) -> BitMap {
let vec = iter.into_iter().collect::<Vec<_>>();
let mut cap = 1024;
for v in &vec {
cap = cap.max(*v);
}
let mut map = BitMap::new(cap);
map.extend(vec);
map
}
}
impl PartialEq for BitMap {
fn eq(&self, other: &Self) -> bool {
if self.len() != other.len() {
return false;
}
self.iter().all(|k| other.contains(&k))
}
}
impl Eq for BitMap {}
impl Extend<usize> for BitMap {
fn extend<T: IntoIterator<Item=usize>>(&mut self, iter: T) {
let iter = iter.into_iter();
for v in iter {
self.add(v);
}
}
}
pub struct Iter<'a> {
base: &'a BitMap,
len: usize,
val: usize,
}
impl<'a> Iterator for Iter<'a> {
type Item = usize;
fn next(&mut self) -> Option<Self::Item> {
if self.len == 0 {
return None;
}
for i in self.val..=self.base.max_key {
if self.base.contains(&i) {
self.len -= 1;
self.val = i + 1;
return Some(i);
}
}
unreachable!()
}
fn size_hint(&self) -> (usize, Option<usize>) {
(self.len, Some(self.len))
}
}
impl<'a> DoubleEndedIterator for Iter<'a> {
fn next_back(&mut self) -> Option<Self::Item> {
if self.len == 0 {
return None;
}
for i in (0..=(self.base.max_key - self.val)).rev() {
if self.base.contains(&i) {
self.len -= 1;
self.val = self.base.max_key - i;
return Some(i);
}
}
unreachable!()
}
}
impl Display for BitMap {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.write_fmt(format_args!("len:{}-val:{{", self.len))?;
let mut iter = self.iter();
if let Some(v) = iter.next() {
f.write_str(&v.to_string())?;
}
let mut sum = 1;
while let Some(v) = iter.next() {
f.write_fmt(format_args!(",{}", v))?;
sum += 1;
if sum > 0x100000 {
break;
}
}
f.write_str("}")
}
}
impl Debug for BitMap {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.write_str(&format!("{}", self))
}
}
#[cfg(test)]
mod tests {
use super::BitMap;
#[test]
fn test_display() {
let mut m = BitMap::new(10240);
m.add_many(&vec![1, 3, 9]);
assert_eq!(format!("{}", m), "len:3-val:{1,3,9}".to_string());
}
}