malachite-nz 0.13.0

The bignum types Natural and Integer, with efficient algorithms partially derived from GMP and FLINT.
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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149

// 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::num::arithmetic::traits::CheckedSqrt;
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_nz::gaussian_integer::GaussianInteger;
use malachite_nz::test_util::bench::bucketers::gaussian_integer_bit_bucketer;
use malachite_nz::test_util::gaussian_integer::arithmetic::sqrt::*;
use malachite_nz::test_util::generators::{gaussian_integer_gen, gaussian_integer_gen_var_4};

pub(crate) fn register(runner: &mut Runner) {
    register_demo!(runner, demo_gaussian_integer_checked_sqrt);
    register_demo!(runner, demo_gaussian_integer_checked_sqrt_ref);
    register_demo!(runner, demo_gaussian_integer_checked_sqrts);

    register_bench!(runner, benchmark_gaussian_integer_checked_sqrt_algorithms);
    register_bench!(runner, benchmark_gaussian_integer_checked_sqrts);
    register_bench!(
        runner,
        benchmark_gaussian_integer_checked_sqrt_evaluation_strategy
    );
}

// `Option` and `Vec` print their contents in debug form, which for a `GaussianInteger` is the
// struct; these spell out the display form instead.
fn root_string(root: Option<GaussianInteger>) -> String {
    root.map_or_else(|| "None".to_string(), |r| format!("Some({r})"))
}

fn roots_string(roots: &[GaussianInteger]) -> String {
    format!(
        "[{}]",
        roots
            .iter()
            .map(ToString::to_string)
            .collect::<Vec<_>>()
            .join(", ")
    )
}

fn demo_gaussian_integer_checked_sqrt(gm: GenMode, config: &GenConfig, limit: usize) {
    for x in gaussian_integer_gen().get(gm, config).take(limit) {
        println!(
            "({}).checked_sqrt() = {}",
            x,
            root_string(x.clone().checked_sqrt())
        );
    }
}

fn demo_gaussian_integer_checked_sqrt_ref(gm: GenMode, config: &GenConfig, limit: usize) {
    for x in gaussian_integer_gen().get(gm, config).take(limit) {
        println!(
            "(&{}).checked_sqrt() = {}",
            x,
            root_string((&x).checked_sqrt())
        );
    }
}

fn demo_gaussian_integer_checked_sqrts(gm: GenMode, config: &GenConfig, limit: usize) {
    for x in gaussian_integer_gen().get(gm, config).take(limit) {
        println!(
            "({}).checked_sqrts() = {}",
            x,
            roots_string(&x.checked_sqrts())
        );
    }
}

#[allow(unused_must_use)]
fn benchmark_gaussian_integer_checked_sqrts(
    gm: GenMode,
    config: &GenConfig,
    limit: usize,
    file_name: &str,
) {
    run_benchmark(
        "GaussianInteger.checked_sqrts()",
        BenchmarkType::Single,
        gaussian_integer_gen_var_4().get(gm, config),
        gm.name(),
        limit,
        file_name,
        &gaussian_integer_bit_bucketer("x"),
        &mut [("Malachite", &mut |x| {
            no_out!(x.checked_sqrts());
        })],
    );
}

#[allow(unused_must_use)]
fn benchmark_gaussian_integer_checked_sqrt_algorithms(
    gm: GenMode,
    config: &GenConfig,
    limit: usize,
    file_name: &str,
) {
    run_benchmark(
        "GaussianInteger.checked_sqrt()",
        BenchmarkType::Algorithms,
        gaussian_integer_gen_var_4().get(gm, config),
        gm.name(),
        limit,
        file_name,
        &gaussian_integer_bit_bucketer("x"),
        &mut [
            ("default", &mut |x| {
                no_out!((&x).checked_sqrt());
            }),
            ("naive", &mut |x| {
                no_out!(gaussian_integer_checked_sqrt_naive(&x));
            }),
        ],
    );
}

#[allow(unused_must_use)]
fn benchmark_gaussian_integer_checked_sqrt_evaluation_strategy(
    gm: GenMode,
    config: &GenConfig,
    limit: usize,
    file_name: &str,
) {
    run_benchmark(
        "GaussianInteger.checked_sqrt()",
        BenchmarkType::EvaluationStrategy,
        gaussian_integer_gen_var_4().get(gm, config),
        gm.name(),
        limit,
        file_name,
        &gaussian_integer_bit_bucketer("x"),
        &mut [
            ("GaussianInteger.checked_sqrt()", &mut |x| {
                no_out!(x.checked_sqrt());
            }),
            ("(&GaussianInteger).checked_sqrt()", &mut |x| {
                no_out!((&x).checked_sqrt());
            }),
        ],
    );
}