nautilus_indicators/
testing.rs

1// -------------------------------------------------------------------------------------------------
2//  Copyright (C) 2015-2025 Nautech Systems Pty Ltd. All rights reserved.
3//  https://nautechsystems.io
4//
5//  Licensed under the GNU Lesser General Public License Version 3.0 (the "License");
6//  You may not use this file except in compliance with the License.
7//  You may obtain a copy of the License at https://www.gnu.org/licenses/lgpl-3.0.en.html
8//
9//  Unless required by applicable law or agreed to in writing, software
10//  distributed under the License is distributed on an "AS IS" BASIS,
11//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12//  See the License for the specific language governing permissions and
13//  limitations under the License.
14// -------------------------------------------------------------------------------------------------
15
16//! Common test related helper functions.
17
18/// Checks if two floating-point numbers are approximately equal within the
19/// margin of floating-point precision.
20///
21/// * `a`: The first floating-point number.
22/// * `b`: The second floating-point number.
23///
24/// # Returns
25///
26/// Returns `true` if the absolute difference between `a` and `b` is less than
27/// `f64::EPSILON`, indicating that they are approximately equal.
28///
29/// # Example
30///
31/// ```
32/// use nautilus_indicators::testing::approx_equal;
33///
34/// let a = 0.1 + 0.2;
35/// let b = 0.3;
36/// assert!(approx_equal(a, b));
37/// ```
38#[must_use]
39pub fn approx_equal(a: f64, b: f64) -> bool {
40    (a - b).abs() < f64::EPSILON
41}
nautilus_indicators/testing.rs

nautilus_indicators/
testing.rs
