oxihuman-core 0.1.2

Core data structures, algorithms, and asset management for OxiHuman
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

// Copyright (C) 2026 COOLJAPAN OU (Team KitaSan)
// SPDX-License-Identifier: Apache-2.0

//! Generic 64-bit flag set.

#![allow(dead_code)]

/// A 64-bit flag set.
#[allow(dead_code)]
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub struct BitFlags64 {
    pub bits: u64,
}

/// Create a new zeroed flag set.
#[allow(dead_code)]
pub fn new_bit_flags() -> BitFlags64 {
    BitFlags64 { bits: 0 }
}

/// Set bit `bit` (0-63).
#[allow(dead_code)]
pub fn set_flag(flags: &mut BitFlags64, bit: u8) {
    if bit < 64 {
        flags.bits |= 1u64 << bit;
    }
}

/// Clear bit `bit` (0-63).
#[allow(dead_code)]
pub fn clear_flag(flags: &mut BitFlags64, bit: u8) {
    if bit < 64 {
        flags.bits &= !(1u64 << bit);
    }
}

/// Return true if bit `bit` is set.
#[allow(dead_code)]
pub fn has_flag(flags: &BitFlags64, bit: u8) -> bool {
    bit < 64 && (flags.bits & (1u64 << bit)) != 0
}

/// Toggle bit `bit`.
#[allow(dead_code)]
pub fn toggle_flag(flags: &mut BitFlags64, bit: u8) {
    if bit < 64 {
        flags.bits ^= 1u64 << bit;
    }
}

/// Count the number of set bits.
#[allow(dead_code)]
pub fn flags_count(flags: &BitFlags64) -> u32 {
    flags.bits.count_ones()
}

/// Return true if any bit is set.
#[allow(dead_code)]
pub fn any_set(flags: &BitFlags64) -> bool {
    flags.bits != 0
}

/// Return true if no bits are set.
#[allow(dead_code)]
pub fn all_clear(flags: &BitFlags64) -> bool {
    flags.bits == 0
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_new_flags_all_clear() {
        let f = new_bit_flags();
        assert!(all_clear(&f));
        assert!(!any_set(&f));
    }

    #[test]
    fn test_set_and_has_flag() {
        let mut f = new_bit_flags();
        set_flag(&mut f, 3);
        assert!(has_flag(&f, 3));
        assert!(!has_flag(&f, 4));
    }

    #[test]
    fn test_clear_flag() {
        let mut f = new_bit_flags();
        set_flag(&mut f, 7);
        clear_flag(&mut f, 7);
        assert!(!has_flag(&f, 7));
    }

    #[test]
    fn test_toggle_flag() {
        let mut f = new_bit_flags();
        toggle_flag(&mut f, 1);
        assert!(has_flag(&f, 1));
        toggle_flag(&mut f, 1);
        assert!(!has_flag(&f, 1));
    }

    #[test]
    fn test_flags_count() {
        let mut f = new_bit_flags();
        set_flag(&mut f, 0);
        set_flag(&mut f, 10);
        set_flag(&mut f, 63);
        assert_eq!(flags_count(&f), 3);
    }

    #[test]
    fn test_any_set_after_set() {
        let mut f = new_bit_flags();
        set_flag(&mut f, 5);
        assert!(any_set(&f));
    }

    #[test]
    fn test_all_clear_after_clear() {
        let mut f = new_bit_flags();
        set_flag(&mut f, 5);
        clear_flag(&mut f, 5);
        assert!(all_clear(&f));
    }

    #[test]
    fn test_bit_63_boundary() {
        let mut f = new_bit_flags();
        set_flag(&mut f, 63);
        assert!(has_flag(&f, 63));
        assert_eq!(flags_count(&f), 1);
    }

    #[test]
    fn test_set_flag_above_63_is_noop() {
        let mut f = new_bit_flags();
        set_flag(&mut f, 64); // should be ignored
        assert!(all_clear(&f));
    }
}