bitvec 1.0.1

Addresses memory by bits, for packed collections and bitfields
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

use rand::random;

use crate::{
	prelude::*,
	slice::BitSliceIndex,
};

#[test]
fn bitand() {
	let a = random::<[u32; 3]>();
	let b = random::<[u32; 3]>();
	let c = [a[0] & b[0], a[1] & b[1], a[2] & b[2]];

	let mut d = a;
	*d.view_bits_mut::<Lsb0>() &= b.view_bits::<Lsb0>();
	assert_eq!(c, d);

	d = a;
	*d.view_bits_mut::<Msb0>() &= b.view_bits::<Msb0>();
	assert_eq!(c, d);

	let d = random::<[u8; 6]>();
	let e = random::<[u16; 3]>();

	let mut f = d;
	*f.view_bits_mut::<Lsb0>() &= e.view_bits::<Msb0>();
	for ((d, e), f) in (d
		.view_bits::<Lsb0>()
		.iter()
		.by_vals()
		.zip(e.view_bits::<Msb0>().iter().by_vals()))
	.zip(f.view_bits::<Lsb0>())
	{
		assert_eq!(d & e, f);
	}
}

#[test]
fn bitor() {
	let a = random::<[u32; 3]>();
	let b = random::<[u32; 3]>();
	let c = [a[0] | b[0], a[1] | b[1], a[2] | b[2]];

	let mut d = a;
	*d.view_bits_mut::<Lsb0>() |= b.view_bits::<Lsb0>();
	assert_eq!(c, d);

	d = a;
	*d.view_bits_mut::<Msb0>() |= b.view_bits::<Msb0>();
	assert_eq!(c, d);

	let d = random::<[u8; 6]>();
	let e = random::<[u16; 3]>();

	let mut f = d;
	*f.view_bits_mut::<Lsb0>() |= e.view_bits::<Msb0>();
	for ((d, e), f) in (d
		.view_bits::<Lsb0>()
		.iter()
		.by_vals()
		.zip(e.view_bits::<Msb0>().iter().by_vals()))
	.zip(f.view_bits::<Lsb0>())
	{
		assert_eq!(d | e, f);
	}
}

#[test]
fn bitxor() {
	let a = random::<[u32; 3]>();
	let b = random::<[u32; 3]>();
	let c = [a[0] ^ b[0], a[1] ^ b[1], a[2] ^ b[2]];

	let mut d = a;
	*d.view_bits_mut::<Lsb0>() ^= b.view_bits::<Lsb0>();
	assert_eq!(c, d);

	d = a;
	*d.view_bits_mut::<Msb0>() ^= b.view_bits::<Msb0>();
	assert_eq!(c, d);

	let d = random::<[u8; 6]>();
	let e = random::<[u16; 3]>();

	let mut f = d;
	*f.view_bits_mut::<Lsb0>() ^= e.view_bits::<Msb0>();
	for ((d, e), f) in (d
		.view_bits::<Lsb0>()
		.iter()
		.by_vals()
		.zip(e.view_bits::<Msb0>().iter().by_vals()))
	.zip(f.view_bits::<Lsb0>())
	{
		assert_eq!(d ^ e, f);
	}
}

#[test]
fn bit_not() {
	let a = random::<[u32; 3]>();
	let mut b = a;
	let _ = !b.view_bits_mut::<Msb0>();
	assert_eq!([!a[0], !a[1], !a[2]], b);

	let mut c = [0u32; 3];
	let d = !&mut c.view_bits_mut::<Lsb0>()[16 .. 80];
	let _ = !&mut d[24 .. 40];
	assert_eq!(c, [0xFF_FF_00_00, 0xFF_00_00_FF, 0x00_00_FF_FF]);
}

#[test]
fn indexing() {
	let bits = bits![mut 0, 1, 0, 0, 1];

	assert!(bits[1]);
	assert!(!bits[2]);
	assert_eq!(bits[1 ..= 2], bits![1, 0]);

	assert!((10 .. 12).get(bits).is_none());
	assert!((10 .. 12).get_mut(bits).is_none());
}

#[test]
#[should_panic = "index 10 out of bounds: 5"]
fn index_mut_usize() {
	let bits = bits![mut 0, 1, 0, 0, 1];
	10.index_mut(bits);
}