wikiwho 0.2.0

Fast Rust reimplementation of the WikiWho algorithm for fine-grained authorship attribution on large datasets. Optimized for easy integration in multi-threaded applications.
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

// SPDX-License-Identifier: MPL-2.0
//! <style>
//! .rustdoc-hidden { display: none; }
//! </style>
#![doc = include_str!("../README.md")]
//!
//! ## Data Structures
//!
//! The library uses a graph structure to represent the relationships between revisions, paragraphs, sentences, and tokens. To efficiently manage this, each node is split into two parts:
//!
//! - **Immutable Part**: Contains data that doesn't change during analysis (e.g., the text of a token).
//! - **Mutable Part**: Contains data that is updated during analysis (e.g., the origin of a token).
//!
//! **Pointers and Indexing**
//!
//! - Nodes are referenced using pointer structs (e.g., `SentencePointer`), which include an index and a shared reference to the immutable data.
//! - To access mutable data, use indexing into the `PageAnalysis` struct:
//!
//! ```rust,ignore
//! let origin_revision = &analysis[word_pointer].origin_revision;
//! ```
//!
//! - Alternatively you may access the `words` field on `PageAnalysis` directly:
//!
//! ```rust,ignore
//! let origin_revision = &analysis.words[word_pointer.unique_id()].origin_revision;
//! ```

pub mod algorithm;
pub mod dump_parser;
pub mod utils;