geometric-traits 0.1.0

Trait-based algebraic and graph algorithms for Rust, supporting no_std environments
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

//! Submodule defining the trait for Options for building a vocabulary.

use crate::traits::{GrowableVocabulary, Vocabulary};

/// Trait for Options for building a vocabulary.
pub trait VocabularyBuilder {
    /// The type of the vocabulary being built.
    type Vocabulary: GrowableVocabulary;
    /// The iterator of symbols.
    type Symbols: IntoIterator<
        Item = (
            <Self::Vocabulary as Vocabulary>::SourceSymbol,
            <Self::Vocabulary as Vocabulary>::DestinationSymbol,
        ),
    >;

    #[must_use]
    /// Set whether to ignore duplicated symbols.
    fn ignore_duplicates(self) -> Self;

    /// Returns whether to ignore duplicated symbols.
    fn should_ignore_duplicates(&self) -> bool;

    #[must_use]
    /// Set the expected number of symbols.
    ///
    /// # Arguments
    ///
    /// * `number_of_symbols` - The expected number of symbols.
    fn expected_number_of_symbols(self, number_of_symbols: usize) -> Self;

    /// Returns the expected number of symbols.
    fn get_expected_number_of_symbols(&self) -> Option<usize>;

    #[must_use]
    /// Set the iterator of symbols.
    ///
    /// # Arguments
    ///
    /// * `symbols` - The iterator of symbols.
    fn symbols(self, symbols: Self::Symbols) -> Self;
}