ciff 0.3.1

The inverted index exchange format as defined as part of the Open-Source IR Replicability Challenge (OSIRRC) initiative
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

mod common_index_format_v1;
pub use common_index_format_v1::{DocRecord, Header, Posting, PostingsList};

use std::fmt;

impl fmt::Display for Header {
    fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
        writeln!(fmt, "----- CIFF HEADER -----")?;
        writeln!(fmt, "Version: {}", self.get_version())?;
        writeln!(fmt, "No. Postings Lists: {}", self.get_num_postings_lists())?;
        writeln!(
            fmt,
            "Total Postings Lists: {}",
            self.get_total_postings_lists()
        )?;
        writeln!(fmt, "No. Documents: {}", self.get_num_docs())?;
        writeln!(fmt, "Total Documents: {}", self.get_total_docs())?;
        writeln!(
            fmt,
            "Total Terms in Collection {}",
            self.get_total_terms_in_collection()
        )?;
        writeln!(
            fmt,
            "Average Document Length: {}",
            self.get_average_doclength()
        )?;
        writeln!(fmt, "Description: {}", self.get_description())?;
        write!(fmt, "-----------------------")
    }
}

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

    #[test]
    fn test_display_header() {
        let header = Header {
            version: 1,
            num_postings_lists: 13,
            num_docs: 39,
            total_postings_lists: 399,
            total_docs: 200,
            total_terms_in_collection: 888,
            average_doclength: 12.7,
            description: "Test description".to_string(),
            ..Header::default()
        };
        let formatted = format!("{}", header);
        assert_eq!(
            formatted,
            r#"----- CIFF HEADER -----
Version: 1
No. Postings Lists: 13
Total Postings Lists: 399
No. Documents: 39
Total Documents: 200
Total Terms in Collection 888
Average Document Length: 12.7
Description: Test description
-----------------------"#
        );
    }
}