keyword_extraction 1.5.0

Collection of algorithms for keyword extraction from text
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

// Copyright (C) 2023 Afonso Barracha
//
// Rust Keyword Extraction is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Rust Keyword Extraction is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with Rust Keyword Extraction. If not, see <http://www.gnu.org/licenses/>.

use crate::common::{PhraseLength, Punctuation, Stopwords, Text};

/// The `RakeParams` enum represents the parameters for the RAKE (Rapid Automatic Keyword Extraction) algorithm.
/// It has two variants: `WithDefaults` and `All`.
pub enum RakeParams<'a> {
    /// The `WithDefaults` variant is used when the user wants to use default values for punctuation and phrase length.
    ///
    /// ## Arguments
    /// 1. `text` - The text to be analyzed.
    /// 2. `stop_words` - A list of stop words.
    ///
    /// ### Default values
    /// * `Punctuation` - A list of punctuation symbols, defaults to those in Latin and Germanic languages.
    /// * `PhraseLength` - Optional maximum length of the phrases to be ranked by the RAKE algorithm. Defaults to None.
    WithDefaults(Text<'a>, Stopwords<'a>),

    /// The `WithDefaultsAndPhraseLength` variant is used when the user wants to use default values for punctuation
    /// and specify the phrase length.
    ///
    /// ## Arguments
    /// 1. `text` - The text to be analyzed.
    /// 2. `stop_words` - A list of stop words.
    /// 3. `phrase_length` - Optional maximum length of the phrases to be ranked by the RAKE algorithm.
    ///
    /// ### Default values
    /// * `Punctuation` - A list of punctuation symbols, defaults to those in Latin and Germanic languages.
    WithDefaultsAndPhraseLength(Text<'a>, Stopwords<'a>, PhraseLength),

    /// The `All` variant is used when the user wants to specify all parameters.
    ///
    /// ## Arguments
    /// 1. `text` - The text to be analyzed.
    /// 2. `stop_words` - A list of stop words.
    /// 3. `punctuation` - Optional list of punctuation symbols.
    /// 4. `phrase_length` - Optional maximum length of the phrases to be ranked by the RAKE algorithm.
    All(Text<'a>, Stopwords<'a>, Punctuation<'a>, PhraseLength),
}

impl<'a> RakeParams<'a> {
    pub fn get_rake_params(self) -> (Text<'a>, Stopwords<'a>, Punctuation<'a>, PhraseLength) {
        match self {
            RakeParams::WithDefaults(text, stop_words) => (text, stop_words, None, None),
            RakeParams::WithDefaultsAndPhraseLength(text, stop_words, phrase_length) => {
                (text, stop_words, None, phrase_length)
            }
            RakeParams::All(text, stop_words, punctuation, phrase_length) => {
                (text, stop_words, punctuation, phrase_length)
            }
        }
    }
}