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

// 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::basic::unsigneds::PrimitiveUnsigned;
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::pair_1_gaussian_integer_bit_bucketer;
use malachite_nz::test_util::generators::gaussian_integer_unsigned_pair_gen_var_1;
use std::ops::{Shl, ShlAssign};

pub(crate) fn register(runner: &mut Runner) {
    register_unsigned_demos!(runner, demo_gaussian_integer_shl_assign_unsigned);
    register_unsigned_demos!(runner, demo_gaussian_integer_shl_unsigned);
    register_unsigned_demos!(runner, demo_gaussian_integer_shl_unsigned_ref);

    register_unsigned_benches!(runner, benchmark_gaussian_integer_shl_assign_unsigned);
    register_unsigned_benches!(
        runner,
        benchmark_gaussian_integer_shl_unsigned_evaluation_strategy
    );
}

fn demo_gaussian_integer_shl_assign_unsigned<T: PrimitiveUnsigned>(
    gm: GenMode,
    config: &GenConfig,
    limit: usize,
) where
    GaussianInteger: ShlAssign<T>,
{
    for (mut n, u) in gaussian_integer_unsigned_pair_gen_var_1::<T>()
        .get(gm, config)
        .take(limit)
    {
        let n_old = n.clone();
        n <<= u;
        println!("x := {n_old}; x <<= {u}; x = {n}");
    }
}

fn demo_gaussian_integer_shl_unsigned<T: PrimitiveUnsigned>(
    gm: GenMode,
    config: &GenConfig,
    limit: usize,
) where
    GaussianInteger: Shl<T, Output = GaussianInteger>,
{
    for (n, u) in gaussian_integer_unsigned_pair_gen_var_1::<T>()
        .get(gm, config)
        .take(limit)
    {
        let n_old = n.clone();
        println!("({}) << {} = {}", n_old, u, n << u);
    }
}

fn demo_gaussian_integer_shl_unsigned_ref<T: PrimitiveUnsigned>(
    gm: GenMode,
    config: &GenConfig,
    limit: usize,
) where
    for<'a> &'a GaussianInteger: Shl<T, Output = GaussianInteger>,
{
    for (n, u) in gaussian_integer_unsigned_pair_gen_var_1::<T>()
        .get(gm, config)
        .take(limit)
    {
        println!("&({}) << {} = {}", n, u, &n << u);
    }
}

fn benchmark_gaussian_integer_shl_assign_unsigned<T: PrimitiveUnsigned>(
    gm: GenMode,
    config: &GenConfig,
    limit: usize,
    file_name: &str,
) where
    GaussianInteger: ShlAssign<T>,
{
    run_benchmark(
        &format!("GaussianInteger <<= {}", T::NAME),
        BenchmarkType::Single,
        gaussian_integer_unsigned_pair_gen_var_1::<T>().get(gm, config),
        gm.name(),
        limit,
        file_name,
        &pair_1_gaussian_integer_bit_bucketer("n"),
        &mut [("Malachite", &mut |(mut n, u)| n <<= u)],
    );
}

#[allow(unused_must_use)]
fn benchmark_gaussian_integer_shl_unsigned_evaluation_strategy<T: PrimitiveUnsigned>(
    gm: GenMode,
    config: &GenConfig,
    limit: usize,
    file_name: &str,
) where
    GaussianInteger: Shl<T, Output = GaussianInteger>,
    for<'a> &'a GaussianInteger: Shl<T, Output = GaussianInteger>,
{
    run_benchmark(
        &format!("GaussianInteger << {}", T::NAME),
        BenchmarkType::EvaluationStrategy,
        gaussian_integer_unsigned_pair_gen_var_1::<T>().get(gm, config),
        gm.name(),
        limit,
        file_name,
        &pair_1_gaussian_integer_bit_bucketer("n"),
        &mut [
            (&format!("GaussianInteger << {}", T::NAME), &mut |(x, y)| {
                no_out!(x << y);
            }),
            (
                &format!("&GaussianInteger << {}", T::NAME),
                &mut |(x, y)| {
                    no_out!(&x << y);
                },
            ),
        ],
    );
}