miniboosts 0.2.1

MiniBoosts: A collection of boosting algorithms written in Rust 🦀
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

//! This file defines some functions that checks some pre-conditions
//! E.g., Shape of data

use crate::Sample;


/// Check whether the training sample is valid or not.
#[inline(always)]
pub(crate) fn check_sample(sample: &Sample)
{
    let (n_sample, n_feature) = sample.shape();


    // `data` and `target` must have the length greater than `0`.
    // Since the previous assertion guarantees `n_data == n_target`,
    // we only need to check `n_data`.
    assert!(n_sample > 0);


    // `data` must have a feature.
    assert!(n_feature > 0);
}


/// Check whether the capping parameter is valid or not.
#[inline(always)]
pub(crate) fn check_nu(nu: f64, n_sample: usize) {
    let n_sample = n_sample as f64;
    assert!((1.0..=n_sample).contains(&nu));
}

/// Check the stepsize
#[inline(always)]
pub(crate) fn check_stepsize(size: f64) {
    assert!((0.0..=1.0).contains(&size));
}


#[inline(always)]
pub(crate) fn check_capped_simplex_condition(
    slice: &[f64],
    nu: f64,
)
{
    let length = slice.len();
    check_nu(nu, length);

    assert!((slice.iter().sum::<f64>() - 1.0).abs() < 1e-9);

    let ub = 1.0 / nu;
    assert!(slice.iter().all(|s| (0.0..=ub).contains(s)));
}