huff_coding 1.0.0

An implementation of the Huffman coding algorithm, enabling one to create a Huffman tree with any alphabet they choose.
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

use crate::bitvec::prelude::{BitVec, Msb0};
use super::letter::HuffLetter;

use std::cmp::Ordering;

/// Struct representing a [HuffBranch's][crate::tree::branch::HuffBranch] data.
/// 
/// Stores:
/// * `letter: Option<L>`
///  * type implementing [`HuffLetter`][crate::tree::letter::HuffLetter]
///  * if is a joint branch then `letter == None`
/// * `weight: usize`
/// * `code: Option<BitVec<Msb0, u8>>` (big endian)
/// 
/// # Examples
/// ---
/// Initialization:
/// ```
/// use huff_coding::prelude::{HuffLeaf, HuffLetter};
/// 
/// let foo = HuffLeaf::new(Some("oblo"), 12);
/// let bar = HuffLeaf::new(Some(23), 0);
/// ```
#[derive(Debug, Eq, Clone)]
pub struct HuffLeaf<L: HuffLetter>{
    letter: Option<L>,
    weight: usize,
    code: Option<BitVec<Msb0, u8>>,
}

impl<L: HuffLetter> Ord for HuffLeaf<L> {
    fn cmp(&self, other: &Self) -> Ordering {
        self.weight.cmp(&other.weight)
    }
}

impl<L: HuffLetter> PartialOrd for HuffLeaf<L> {
    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
        Some(self.cmp(other))
    }
}

impl<L: HuffLetter> PartialEq for HuffLeaf<L>{
    fn eq(&self, other: &Self) -> bool {
        self.weight == other.weight
    }
}

impl<L: HuffLetter> HuffLeaf<L>{
    /// Initialize a `HuffLeaf` with the given letter and weight 
    /// (code is at first set to None and can be changed with the [`set_code`](#method.set_code) method)
    pub fn new(letter: Option<L>, weight: usize) -> Self{
        HuffLeaf{
            letter,
            weight,
            code: None,
        }
    }

    /// Returns a reference to the stored letter 
    pub fn letter(&self) -> Option<&L>{
        self.letter.as_ref()
    }

    /// Returns the stored weight
    pub fn weight(&self) -> usize{
        self.weight
    }

    /// Returns the stored code
    pub fn code(&self) -> Option<&BitVec<Msb0, u8>>{
        self.code.as_ref()
    }
    
    /// Set the given code, consuming the original
    pub fn set_code(&mut self, code: BitVec<Msb0, u8>){    
        self.code = Some(code);
    }
}