arcweight 0.1.0

A high-performance, modular library for weighted finite state transducers with comprehensive examples and benchmarks
Documentation

ArcWeight

Crates.io Documentation Build Status License: Apache 2.0

A high-performance Rust library for weighted finite-state transducers with comprehensive semiring support.

ArcWeight provides efficient algorithms for constructing, combining, and optimizing weighted finite-state transducers (WFSTs), making it suitable for natural language processing, speech recognition, and computational linguistics applications.

Features

  • Core FST Operations: Composition, determinization, minimization, closure, union, concatenation
  • Advanced Algorithms: Shortest path, weight pushing, epsilon removal, pruning, synchronization
  • Rich Semiring Support: Tropical, log, probability, boolean, integer, product, and Gallic weights
  • Multiple FST Implementations: Vector-based, constant, compact, lazy evaluation, and cached
  • Type-Safe Design: Zero-cost abstractions with trait-based polymorphism
  • OpenFST Compatible: Read and write OpenFST format files
  • Pure Rust: Memory-safe implementation with no C++ dependencies
  • Parallel Processing: Optional Rayon-based parallelization for large FSTs

Quick Start

Add ArcWeight to your Cargo.toml:

[dependencies]
arcweight = "0.1"

Basic Example

use arcweight::prelude::*;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Create a simple FST
    let mut fst = VectorFst::<TropicalWeight>::new();

    // Add states
    let s0 = fst.add_state();
    let s1 = fst.add_state();
    let s2 = fst.add_state();

    // Set start and final states
    fst.set_start(s0);
    fst.set_final(s2, TropicalWeight::one());

    // Add arcs
    fst.add_arc(s0, Arc::new(1, 1, TropicalWeight::one(), s1));
    fst.add_arc(s1, Arc::new(2, 2, TropicalWeight::one(), s2));

    // Perform operations
    let minimized = minimize(&fst)?;

    println!("Original states: {}", fst.num_states());
    println!("Minimized states: {}", minimized.num_states());

    Ok(())
}

Examples

ArcWeight includes comprehensive examples demonstrating real-world applications:

# String edit distance
cargo run --example edit_distance

# Spell checking and correction
cargo run --example spell_checking

# Morphological analysis
cargo run --example morphological_analyzer

# Phonological rules
cargo run --example phonological_rules

# Text normalization
cargo run --example number_date_normalizer

See the examples/ directory for complete implementations with detailed explanations.

Documentation

Minimum Supported Rust Version (MSRV)

ArcWeight requires Rust 1.85.0 or later.

The MSRV is explicitly tested in CI and will only be increased in minor version updates. When the MSRV is increased, the previous two stable releases will still be supported for six months.

Performance

ArcWeight is designed for high performance:

  • Zero-copy arc iteration minimizes allocations
  • Cache-friendly data structures optimize memory access
  • Optional parallel algorithms leverage multi-core processors
  • Automatic algorithm selection based on FST properties

Run benchmarks on your system:

cargo bench

Contributing

We welcome contributions! Please see CONTRIBUTING.md for guidelines.

Quick checklist:

  • Follow existing code style (run cargo fmt)
  • Add tests for new functionality (run cargo test)
  • Update documentation for public APIs (run cargo doc)
  • Ensure all CI checks pass (run cargo clippy)

Getting Help

License

Licensed under the Apache License, Version 2.0. See LICENSE for details.

Citation

If you use ArcWeight in your research, please cite:

@software{arcweight,
  author = {White, Aaron Steven},
  title = {ArcWeight: A Rust Library for Weighted Finite-State Transducers},
  url = {https://github.com/aaronstevenwhite/arcweight},
  year = {2025}
}

References

ArcWeight implements algorithms based on: