argmin_testfunctions 0.1.1

Test functions for optimization algorithms
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

// Copyright 2018 Stefan Kroboth
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://apache.org/licenses/LICENSE-2.0> or the MIT license <LICENSE-MIT or
// http://opensource.org/licenses/MIT>, at your option. This file may not be
// copied, modified, or distributed except according to those terms.

//! # Zero
//!
//! Always returns `0.0`. This is only for performance tests.

/// Zero test function
///
/// Always returns `0.0`. This is only for performance tests.
#[inline(always)]
pub fn zero<T>(_param: &[T]) -> f64 {
    0.0
}

/// Derivative of zero test function
///
/// Always returns a vector with the lenght of param, full of `0.0`. This is only for performance
/// tests.
#[inline(always)]
pub fn zero_derivative<T>(param: &[T]) -> Vec<f64> {
    vec![0.0; param.len()]
}

#[cfg(test)]
mod tests {
    use super::*;
    use std;

    #[test]
    fn test_zero() {
        assert!(zero(&[0.0_f64, 0.0_f64]).abs() < std::f64::EPSILON);
    }
}