graphembed 0.0.8

graph embedding
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

//! Validation parameters

/// A structure describing validation strategy.
/// At present time only link prediction is implemented
///
//  TODO nodelabeling
#[derive(Copy, Clone, Debug)]
pub struct ValidationParams {
    /// The fraction of edges to skip when construction the train set
    delete_fraction: f64,
    /// the number of pass to run
    nbpass: usize,
    /// We must know if graph is symetric as we will have to delete edges in a coherent way!
    symetric: bool,
    /// centric flag to ask for centric auc computation
    centric: bool,
} // end of ValidationParams

impl ValidationParams {
    pub fn new(delete_fraction: f64, nbpass: usize, symetric: bool, centric: bool) -> Self {
        ValidationParams {
            delete_fraction,
            nbpass,
            symetric,
            centric,
        }
    }

    /// number of pass in validation
    pub fn get_nbpass(&self) -> usize {
        self.nbpass
    }

    /// fraction to skip in train test
    pub fn get_delete_fraction(&self) -> f64 {
        self.delete_fraction
    }

    //
    pub fn is_symetric(&self) -> bool {
        self.symetric
    }

    /// retruns true if a centric auc computation is required after standard AUC link prediction validation
    pub fn do_centric(&self) -> bool {
        self.centric
    }
} // end of ValidationParams