algebraic_immunity 0.3.2

A package to compute the algebrac immunity and the restricted algebraic immunity of Boolean functions.
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

use crate::ai::{AlgebraicImmunity, RestrictedAlgebraicImmunity};

pub struct BooleanFunction {
    t_table: Vec<u8>,
    n: usize,
}

impl BooleanFunction {
    /// Creates a Boolean function from its truth table.
    ///
    /// # Panics
    /// Panics if the truth table length is not a power of two.
    pub fn new(truth_table: Vec<u8>) -> Self {
        let len = truth_table.len();
        assert!(
            len.is_power_of_two(),
            "Truth table length must be a power of two."
        );
        let n: usize = (usize::BITS - 1 - len.leading_zeros()) as usize;
        BooleanFunction {
            t_table: truth_table,
            n: n,
        }
    }

    /// Alias for [`BooleanFunction::new`]
    ///
    /// # Arguments
    ///
    /// * `truth_table` - truth table of the Boolean function
    ///
    /// # Returns
    ///
    /// Boolean function object corresponding to `truth_table`.
    ///
    /// # Panics
    ///
    /// Panics if truth table lenght is not a power of 2.
    ///
    /// # Example
    ///
    /// ```
    /// use algebraic_immunity::boolean_function::BooleanFunction;
    /// let truth_table = vec![0,1,1,0];
    /// let boolean_function = BooleanFunction::from_truth_table(truth_table.clone());
    /// assert_eq!(boolean_function.truth_table(), truth_table);
    /// ```
    pub fn from_truth_table(truth_table: Vec<u8>) -> Self {
        Self::new(truth_table)
    }

    /// Get the Boolean function truth table from the Boolean function.
    ///
    /// # Returns
    ///
    /// Truth table of the Boolean function.
    ///
    /// # Example
    /// ```
    /// use algebraic_immunity::boolean_function::BooleanFunction;
    /// let t_table = vec![0,1,1,0];
    /// let bf = BooleanFunction::new(t_table.clone());
    /// assert_eq!(bf.truth_table(), t_table);
    /// ```
    pub fn truth_table(&self) -> Vec<u8> {
        self.t_table.clone()
    }

    /// Computes the algebraic immunity of the Boolean function.
    ///
    /// # Returns
    ///
    /// The algebraic immunity of the Boolean function, denoted `AI(f)`.
    ///
    /// # Examples
    ///
    /// ```
    /// use algebraic_immunity::boolean_function::BooleanFunction;
    ///
    /// let t_table = vec![0, 1, 1, 0];
    /// let bf = BooleanFunction::new(t_table);
    /// assert_eq!(bf.algebraic_immunity(), 1);
    /// ```
    pub fn algebraic_immunity(&self) -> usize {
        AlgebraicImmunity::algebraic_immunity(self.t_table.clone(), self.n)
    }

    /// Compute the restricted algebraic immunity of the Boolean function.
    ///
    /// # Arguments
    ///
    /// * `subset` - restriction set `S ⊆ {0,1}^n`
    ///
    /// # Returns
    ///
    /// Restricted Algebraic immunity of the Boolean function on S: `AI_S(f)`.
    ///
    /// # Example
    /// ```
    /// use algebraic_immunity::boolean_function::BooleanFunction;
    /// let t_table = vec![0,1,1,0];
    /// let bf = BooleanFunction::new(t_table);
    /// assert_eq!(bf.restricted_algebraic_immunity(vec![0,1]), 1);
    /// ```
    pub fn restricted_algebraic_immunity(&self, subset: Vec<usize>) -> usize {
        RestrictedAlgebraicImmunity::algebraic_immunity(self.t_table.clone(), subset, self.n)
    }
}