malachite-float 0.9.1

The arbitrary-precision floating-point type Float, with efficient algorithms partially derived from MPFR.
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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

// Copyright © 2026 Mikhail Hogrefe
//
// This file is part of Malachite.
//
// Malachite is free software: you can redistribute it and/or modify it under the terms of the GNU
// Lesser General Public License (LGPL) as published by the Free Software Foundation; either version
// 3 of the License, or (at your option) any later version. See <https://www.gnu.org/licenses/>.

use malachite_base::test_util::bench::{BenchmarkType, run_benchmark};
use malachite_base::test_util::generators::common::{GenConfig, GenMode};
use malachite_base::test_util::runner::Runner;
use malachite_float::ComparableFloatRef;
use malachite_float::test_util::bench::bucketers::pair_1_float_complexity_bucketer;
use malachite_float::test_util::generators::float_ordering_pair_gen;
use malachite_float::{test_overflow, test_underflow};

pub(crate) fn register(runner: &mut Runner) {
    register_demo!(runner, demo_float_test_overflow);
    register_demo!(runner, demo_float_test_overflow_debug);
    register_demo!(runner, demo_float_test_underflow);
    register_demo!(runner, demo_float_test_underflow_debug);

    register_bench!(runner, benchmark_float_test_overflow);
    register_bench!(runner, benchmark_float_test_underflow);
}

fn demo_float_test_overflow(gm: GenMode, config: &GenConfig, limit: usize) {
    for (x, o) in float_ordering_pair_gen().get(gm, config).take(limit) {
        println!("test_overflow({}, {:?}) = {}", x, o, test_overflow(&x, o));
    }
}

fn demo_float_test_overflow_debug(gm: GenMode, config: &GenConfig, limit: usize) {
    for (x, o) in float_ordering_pair_gen().get(gm, config).take(limit) {
        println!(
            "test_overflow({:#x}, {:?}) = {}",
            ComparableFloatRef(&x),
            o,
            test_overflow(&x, o)
        );
    }
}

fn demo_float_test_underflow(gm: GenMode, config: &GenConfig, limit: usize) {
    for (x, o) in float_ordering_pair_gen().get(gm, config).take(limit) {
        println!("test_underflow({}, {:?}) = {}", x, o, test_underflow(&x, o));
    }
}

fn demo_float_test_underflow_debug(gm: GenMode, config: &GenConfig, limit: usize) {
    for (x, o) in float_ordering_pair_gen().get(gm, config).take(limit) {
        println!(
            "test_underflow({:#x}, {:?}) = {}",
            ComparableFloatRef(&x),
            o,
            test_underflow(&x, o)
        );
    }
}

fn benchmark_float_test_overflow(gm: GenMode, config: &GenConfig, limit: usize, file_name: &str) {
    run_benchmark(
        "Float.ulp()",
        BenchmarkType::Single,
        float_ordering_pair_gen().get(gm, config),
        gm.name(),
        limit,
        file_name,
        &pair_1_float_complexity_bucketer("x"),
        &mut [("Malachite", &mut |(x, o)| no_out!(test_overflow(&x, o)))],
    );
}

fn benchmark_float_test_underflow(gm: GenMode, config: &GenConfig, limit: usize, file_name: &str) {
    run_benchmark(
        "Float.ulp()",
        BenchmarkType::Single,
        float_ordering_pair_gen().get(gm, config),
        gm.name(),
        limit,
        file_name,
        &pair_1_float_complexity_bucketer("x"),
        &mut [("Malachite", &mut |(x, o)| no_out!(test_overflow(&x, o)))],
    );
}