permutation-rs 3.0.0

Do calculations with groups
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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163

//! Home for special groups.

use super::{GroupElement, GroupAction, Morphism};
use super::tree::SLP;
use super::permutation::Permutation;
use super::free::Word;

/// A special product of a `SLP` and a `Permutation`.
#[derive(Debug, PartialEq)]
pub struct SLPPermutation {
    /// The product of a SLP and a Permutation.
    pub element : (SLP, Permutation),
}

impl SLPPermutation {
    /// Create an `SLPPermutation`.
    pub fn new(slp: SLP, permutation: Permutation) -> SLPPermutation {
        SLPPermutation { element : (slp, permutation) }
    }

    /// Map the `SLPPermutation` in to a `Word` according to the `Morphism`.
    pub fn transform(&self, morphism: &Morphism<SLP, Word>) -> Word {
        self.element.0.transform(&morphism)
    }
}

impl GroupElement for SLPPermutation {
    fn is_identity(&self) -> bool {
        self.element.1.is_identity()
    }

    fn times(&self, multiplicant: &SLPPermutation) -> SLPPermutation {
        SLPPermutation::new(
            self.element.0.times(&multiplicant.element.0),
            self.element.1.times(&multiplicant.element.1))
    }

    fn inverse(&self) -> SLPPermutation {
        SLPPermutation::new(
            self.element.0.inverse(),
            self.element.1.inverse())
    }
}

impl GroupAction for SLPPermutation {
    type Domain = u64;

    fn act_on(&self, original: &u64) -> u64 {
        self.element.1.act_on(original)
    }
}

#[cfg(test)]
mod tests {
    use std::collections::HashMap;
    use super::super::{GroupElement, GroupAction};
    use super::super::tree::SLP;
    use super::super::permutation::Permutation;
    use super::SLPPermutation;

    #[test]
    fn slp_permutaion_should_know_when_it_is_the_identity() {
        let mut not_identity_images = HashMap::new();
        not_identity_images.insert(0u64, 1u64);
        not_identity_images.insert(1u64, 0u64);
        let not_identity: SLPPermutation = SLPPermutation::new(
            SLP::Generator(1),
            Permutation::new(not_identity_images));

        assert!(!not_identity.is_identity());

        let mut identity_images = HashMap::new();
        identity_images.insert(0u64, 0u64);
        identity_images.insert(1u64, 1u64);
        let identity: SLPPermutation = SLPPermutation::new(
            SLP::Identity,
            Permutation::new(identity_images));

        assert!(identity.is_identity());
    }

    #[test]
    fn multiplication_should_be_from_left_to_right() {
        let mut first_images = HashMap::new();
        first_images.insert(0u64, 1u64);
        first_images.insert(1u64, 0u64);
        first_images.insert(2u64, 2u64);
        let first: SLPPermutation = SLPPermutation::new(
            SLP::Generator(1),
            Permutation::new(first_images));

        let mut second_images = HashMap::new();
        second_images.insert(0u64, 0u64);
        second_images.insert(1u64, 2u64);
        second_images.insert(2u64, 1u64);
        let second: SLPPermutation = SLPPermutation::new(
            SLP::Generator(2),
            Permutation::new(second_images));

        let product = first.times(&second);

        let mut expected_images = HashMap::new();
        expected_images.insert(0u64, 2u64);
        expected_images.insert(1u64, 0u64);
        expected_images.insert(2u64, 1u64);
        let expected: SLPPermutation = SLPPermutation::new(
            SLP::Product(Box::new(SLP::Generator(1)), Box::new(SLP::Generator(2))),
            Permutation::new(expected_images));

        assert_eq!(product, expected);
    }

    #[test]
    fn inverse_should_multiply_to_identity() {
        let mut first_images = HashMap::new();
        first_images.insert(0u64, 1u64);
        first_images.insert(1u64, 2u64);
        first_images.insert(2u64, 0u64);
        let first: SLPPermutation = SLPPermutation::new(
            SLP::Generator(1),
            Permutation::new(first_images));

        let second = first.inverse();

        let product = first.times(&second);

        assert!(product.is_identity());
    }

    #[test]
    fn permutation_should_act_upon_integers() {
        let mut permutation_images = HashMap::new();
        permutation_images.insert(0u64, 1u64);
        permutation_images.insert(1u64, 2u64);
        permutation_images.insert(2u64, 0u64);
        let permutation: SLPPermutation = SLPPermutation::new(
            SLP::Generator(1),
            Permutation::new(permutation_images));

        assert_eq!(permutation.act_on(&0u64), 1u64);
        assert_eq!(permutation.act_on(&1u64), 2u64);
        assert_eq!(permutation.act_on(&2u64), 0u64);
    }

    // #[test]
    // fn permutation_should_display_correctly() {
    //     let mut identity_images = HashMap::new();
    //     identity_images.insert(0u64, 0u64);
    //     identity_images.insert(1u64, 1u64);
    //     let identity = Permutation::new(identity_images);

    //     let mut permutation_images = HashMap::new();
    //     permutation_images.insert(0u64, 1u64);
    //     permutation_images.insert(1u64, 2u64);
    //     permutation_images.insert(2u64, 0u64);
    //     permutation_images.insert(3u64, 4u64);
    //     permutation_images.insert(4u64, 3u64);
    //     let permutation = Permutation::new(permutation_images);

    //     assert_eq!("Id", format!("{}", identity));
    //     assert_eq!("(0 1 2)(3 4)", format!("{}", permutation));
    // }
}