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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124

// 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::rounding_modes::RoundingMode::*;
use malachite_base::test_util::bench::bucketers::{pair_1_bucketer, unsigned_direct_bucketer};
use malachite_base::test_util::bench::{BenchmarkType, run_benchmark};
use malachite_base::test_util::generators::common::{GenConfig, GenMode};
use malachite_base::test_util::generators::{
    unsigned_gen_var_11, unsigned_rounding_mode_pair_gen_var_4,
};
use malachite_base::test_util::runner::Runner;
use malachite_float::ComparableFloat;
use malachite_float::Float;
use malachite_float::test_util::common::rug_round_exact_from_rounding_mode;
use malachite_float::test_util::constants::pi::rug_pi_prec_round;

pub(crate) fn register(runner: &mut Runner) {
    register_demo!(runner, demo_float_pi_prec_round);
    register_demo!(runner, demo_float_pi_prec_round_debug);
    register_demo!(runner, demo_float_pi_prec);
    register_demo!(runner, demo_float_pi_prec_debug);

    register_bench!(runner, benchmark_float_pi_prec_round_library_comparison);
    register_bench!(runner, benchmark_float_pi_prec_library_comparison);
}

fn demo_float_pi_prec_round(gm: GenMode, config: &GenConfig, limit: usize) {
    for (p, rm) in unsigned_rounding_mode_pair_gen_var_4()
        .get(gm, config)
        .take(limit)
    {
        println!(
            "pi_prec_round({}, {}) = {:?}",
            p,
            rm,
            Float::pi_prec_round(p, rm)
        );
    }
}

fn demo_float_pi_prec_round_debug(gm: GenMode, config: &GenConfig, limit: usize) {
    for (p, rm) in unsigned_rounding_mode_pair_gen_var_4()
        .get(gm, config)
        .take(limit)
    {
        let (pc, o) = Float::pi_prec_round(p, rm);
        println!(
            "pi_prec_round({}, {}) = ({:#x}, {:?})",
            p,
            rm,
            ComparableFloat(pc),
            o
        );
    }
}

fn demo_float_pi_prec(gm: GenMode, config: &GenConfig, limit: usize) {
    for p in unsigned_gen_var_11().get(gm, config).take(limit) {
        println!("pi_prec({}) = {:?}", p, Float::pi_prec(p));
    }
}

fn demo_float_pi_prec_debug(gm: GenMode, config: &GenConfig, limit: usize) {
    for p in unsigned_gen_var_11().get(gm, config).take(limit) {
        let (pc, o) = Float::pi_prec(p);
        println!("pi_prec({}) = ({:#x}, {:?})", p, ComparableFloat(pc), o);
    }
}

fn benchmark_float_pi_prec_round_library_comparison(
    gm: GenMode,
    config: &GenConfig,
    limit: usize,
    file_name: &str,
) {
    run_benchmark(
        "Float::pi_prec_round(u64, RoundingMode)",
        BenchmarkType::LibraryComparison,
        unsigned_rounding_mode_pair_gen_var_4().get(gm, config),
        gm.name(),
        limit,
        file_name,
        &pair_1_bucketer("prec"),
        &mut [
            ("Malachite", &mut |(p, rm)| {
                no_out!(Float::pi_prec_round(p, rm));
            }),
            ("rug", &mut |(p, rm)| {
                no_out!(rug_pi_prec_round(p, rug_round_exact_from_rounding_mode(rm)));
            }),
        ],
    );
}

fn benchmark_float_pi_prec_library_comparison(
    gm: GenMode,
    config: &GenConfig,
    limit: usize,
    file_name: &str,
) {
    run_benchmark(
        "Float::pi_prec(u64)",
        BenchmarkType::LibraryComparison,
        unsigned_gen_var_11().get(gm, config),
        gm.name(),
        limit,
        file_name,
        &unsigned_direct_bucketer(),
        &mut [
            ("Malachite", &mut |p| no_out!(Float::pi_prec(p))),
            ("rug", &mut |p| {
                no_out!(rug_pi_prec_round(
                    p,
                    rug_round_exact_from_rounding_mode(Nearest)
                ));
            }),
        ],
    );
}