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
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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145

//! A generic vocabulary builder that can be used to build a vocabulary for any
//! type of graph.

#[cfg(feature = "mem_dbg")]
use alloc::{string::String, vec::Vec};

use crate::{
    errors::builder::vocabulary::VocabularyBuilderError,
    traits::{GrowableVocabulary, Vocabulary, VocabularyBuilder},
};

#[cfg_attr(feature = "mem_size", derive(mem_dbg::MemSize))]
#[cfg_attr(feature = "mem_size", mem_size(rec))]
#[cfg_attr(feature = "mem_dbg", derive(mem_dbg::MemDbg))]
#[derive(Clone, Debug)]
/// A generic vocabulary builder that can be used to build a vocabulary for any
/// type of graph.
pub struct GenericVocabularyBuilder<Symbols, Vocabulary> {
    /// The symbols to build the vocabulary from.
    symbols: Option<Symbols>,
    /// The expected number of symbols.
    expected_number_of_symbols: Option<usize>,
    /// Whether to ignore duplicated symbols.
    ignore_duplicates: bool,
    /// The vocabulary type.
    _vocabulary: core::marker::PhantomData<Vocabulary>,
}

impl<Symbols, V> Default for GenericVocabularyBuilder<Symbols, V> {
    #[inline]
    fn default() -> Self {
        Self {
            symbols: None,
            expected_number_of_symbols: None,
            ignore_duplicates: false,
            _vocabulary: core::marker::PhantomData,
        }
    }
}

impl<Symbols, V: GrowableVocabulary> VocabularyBuilder for GenericVocabularyBuilder<Symbols, V>
where
    Symbols: IntoIterator<
        Item = (<V as Vocabulary>::SourceSymbol, <V as Vocabulary>::DestinationSymbol),
    >,
{
    type Symbols = Symbols;
    type Vocabulary = V;

    #[inline]
    fn expected_number_of_symbols(mut self, number_of_symbols: usize) -> Self {
        self.expected_number_of_symbols = Some(number_of_symbols);
        self
    }

    #[inline]
    fn get_expected_number_of_symbols(&self) -> Option<usize> {
        self.expected_number_of_symbols
    }

    #[inline]
    fn ignore_duplicates(mut self) -> Self {
        self.ignore_duplicates = true;
        self
    }

    #[inline]
    fn should_ignore_duplicates(&self) -> bool {
        self.ignore_duplicates
    }

    #[inline]
    fn symbols(mut self, symbols: Self::Symbols) -> Self {
        self.symbols = Some(symbols);
        self
    }
}

impl<Symbols, V> GenericVocabularyBuilder<Symbols, V>
where
    Self: VocabularyBuilder<Symbols = Symbols>,
    Symbols: IntoIterator<
        Item = (
            <<Self as VocabularyBuilder>::Vocabulary as Vocabulary>::SourceSymbol,
            <<Self as VocabularyBuilder>::Vocabulary as Vocabulary>::DestinationSymbol,
        ),
    >,
{
    /// Builds the vocabulary.
    ///
    /// # Errors
    ///
    /// Returns [`VocabularyBuilderError`] if the vocabulary cannot be built.
    #[inline]
    pub fn build(
        self,
    ) -> Result<
        <Self as VocabularyBuilder>::Vocabulary,
        VocabularyBuilderError<<Self as VocabularyBuilder>::Vocabulary>,
    > {
        let expected_number_of_symbols = self.get_expected_number_of_symbols();
        let mut vocabulary = if let Some(number_of_symbols) = expected_number_of_symbols {
            <Self as VocabularyBuilder>::Vocabulary::with_capacity(number_of_symbols)
        } else {
            <Self as VocabularyBuilder>::Vocabulary::new()
        };
        let should_ignore_duplicates = self.should_ignore_duplicates();
        self.symbols
            .ok_or(VocabularyBuilderError::MissingAttribute("symbols"))?
            .into_iter()
            .try_for_each(|(source, destination)| {
                if let Err(err) = vocabulary.add(source, destination) {
                    match err {
						crate::errors::builder::vocabulary::VocabularyBuilderError::RepeatedSourceSymbol(
							_,
						) | crate::errors::builder::vocabulary::VocabularyBuilderError::RepeatedDestinationSymbol(
							_,
						) => {
							if should_ignore_duplicates {
								Ok(())
							} else {
								Err(err)
							}
						}
						other => Err(other)
					}
                } else {
                    Ok(())
                }
            })?;

        if let Some(expected_number_of_symbols) = expected_number_of_symbols
            && vocabulary.len() != expected_number_of_symbols
        {
            return Err(
                crate::errors::builder::vocabulary::VocabularyBuilderError::NumberOfSymbols {
                    expected: expected_number_of_symbols,
                    actual: vocabulary.len(),
                },
            );
        }

        Ok(vocabulary)
    }
}