malachite-nz 0.13.0

The bignum types Natural and Integer, with efficient algorithms partially derived from GMP and FLINT.
Documentation
// 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_nz::gaussian_integer::GaussianInteger;
use malachite_nz::test_util::bench::bucketers::{
    pair_gaussian_integer_max_bit_bucketer, vec_gaussian_integer_sum_bits_bucketer,
};
use malachite_nz::test_util::gaussian_integer::arithmetic::add::gaussian_integer_sum_alt;
use malachite_nz::test_util::generators::{gaussian_integer_pair_gen, gaussian_integer_vec_gen};
use std::iter::Sum;

pub(crate) fn register(runner: &mut Runner) {
    register_demo!(runner, demo_gaussian_integer_add);
    register_demo!(runner, demo_gaussian_integer_add_val_ref);
    register_demo!(runner, demo_gaussian_integer_add_ref_val);
    register_demo!(runner, demo_gaussian_integer_add_ref_ref);
    register_demo!(runner, demo_gaussian_integer_add_assign);
    register_demo!(runner, demo_gaussian_integer_add_assign_ref);
    register_demo!(runner, demo_gaussian_integer_sum);
    register_demo!(runner, demo_gaussian_integer_ref_sum);

    register_bench!(runner, benchmark_gaussian_integer_add_evaluation_strategy);
    register_bench!(
        runner,
        benchmark_gaussian_integer_add_assign_evaluation_strategy
    );
    register_bench!(runner, benchmark_gaussian_integer_sum_algorithms);
    register_bench!(runner, benchmark_gaussian_integer_sum_evaluation_strategy);
}

fn demo_gaussian_integer_add(gm: GenMode, config: &GenConfig, limit: usize) {
    for (x, y) in gaussian_integer_pair_gen().get(gm, config).take(limit) {
        let x_old = x.clone();
        let y_old = y.clone();
        println!("({x_old}) + ({y_old}) = {}", x + y);
    }
}

fn demo_gaussian_integer_add_val_ref(gm: GenMode, config: &GenConfig, limit: usize) {
    for (x, y) in gaussian_integer_pair_gen().get(gm, config).take(limit) {
        let x_old = x.clone();
        println!("({x_old}) + (&{y}) = {}", x + &y);
    }
}

fn demo_gaussian_integer_add_ref_val(gm: GenMode, config: &GenConfig, limit: usize) {
    for (x, y) in gaussian_integer_pair_gen().get(gm, config).take(limit) {
        let y_old = y.clone();
        println!("(&{x}) + ({y_old}) = {}", &x + y);
    }
}

fn demo_gaussian_integer_add_ref_ref(gm: GenMode, config: &GenConfig, limit: usize) {
    for (x, y) in gaussian_integer_pair_gen().get(gm, config).take(limit) {
        println!("(&{x}) + (&{y}) = {}", &x + &y);
    }
}

fn demo_gaussian_integer_add_assign(gm: GenMode, config: &GenConfig, limit: usize) {
    for (mut x, y) in gaussian_integer_pair_gen().get(gm, config).take(limit) {
        let x_old = x.clone();
        let y_old = y.clone();
        x += y;
        println!("x := {x_old}; x += {y_old}; x = {x}");
    }
}

fn demo_gaussian_integer_add_assign_ref(gm: GenMode, config: &GenConfig, limit: usize) {
    for (mut x, y) in gaussian_integer_pair_gen().get(gm, config).take(limit) {
        let x_old = x.clone();
        x += &y;
        println!("x := {x_old}; x += &{y}; x = {x}");
    }
}

#[allow(unused_must_use)]
fn benchmark_gaussian_integer_add_evaluation_strategy(
    gm: GenMode,
    config: &GenConfig,
    limit: usize,
    file_name: &str,
) {
    run_benchmark(
        "GaussianInteger + GaussianInteger",
        BenchmarkType::EvaluationStrategy,
        gaussian_integer_pair_gen().get(gm, config),
        gm.name(),
        limit,
        file_name,
        &pair_gaussian_integer_max_bit_bucketer("x", "y"),
        &mut [
            ("GaussianInteger + GaussianInteger", &mut |(x, y)| {
                no_out!(x + y);
            }),
            ("GaussianInteger + &GaussianInteger", &mut |(x, y)| {
                no_out!(x + &y);
            }),
            ("&GaussianInteger + GaussianInteger", &mut |(x, y)| {
                no_out!(&x + y);
            }),
            ("&GaussianInteger + &GaussianInteger", &mut |(x, y)| {
                no_out!(&x + &y);
            }),
        ],
    );
}

#[allow(unused_must_use)]
fn benchmark_gaussian_integer_add_assign_evaluation_strategy(
    gm: GenMode,
    config: &GenConfig,
    limit: usize,
    file_name: &str,
) {
    run_benchmark(
        "GaussianInteger += GaussianInteger",
        BenchmarkType::EvaluationStrategy,
        gaussian_integer_pair_gen().get(gm, config),
        gm.name(),
        limit,
        file_name,
        &pair_gaussian_integer_max_bit_bucketer("x", "y"),
        &mut [
            ("GaussianInteger += GaussianInteger", &mut |(mut x, y)| {
                no_out!(x += y);
            }),
            ("GaussianInteger += &GaussianInteger", &mut |(mut x, y)| {
                no_out!(x += &y);
            }),
        ],
    );
}

fn demo_gaussian_integer_sum(gm: GenMode, config: &GenConfig, limit: usize) {
    for xs in gaussian_integer_vec_gen().get(gm, config).take(limit) {
        println!(
            "sum({:?}) = {}",
            xs.clone(),
            GaussianInteger::sum(xs.into_iter())
        );
    }
}

fn demo_gaussian_integer_ref_sum(gm: GenMode, config: &GenConfig, limit: usize) {
    for xs in gaussian_integer_vec_gen().get(gm, config).take(limit) {
        println!("sum({:?}) = {}", xs, GaussianInteger::sum(xs.iter()));
    }
}

fn benchmark_gaussian_integer_sum_algorithms(
    gm: GenMode,
    config: &GenConfig,
    limit: usize,
    file_name: &str,
) {
    run_benchmark(
        "GaussianInteger::sum(Iterator<Item=GaussianInteger>)",
        BenchmarkType::Algorithms,
        gaussian_integer_vec_gen().get(gm, config),
        gm.name(),
        limit,
        file_name,
        &vec_gaussian_integer_sum_bits_bucketer(),
        &mut [
            ("default", &mut |xs| {
                no_out!(GaussianInteger::sum(xs.into_iter()));
            }),
            ("alt", &mut |xs| {
                no_out!(gaussian_integer_sum_alt(xs.into_iter()));
            }),
        ],
    );
}

fn benchmark_gaussian_integer_sum_evaluation_strategy(
    gm: GenMode,
    config: &GenConfig,
    limit: usize,
    file_name: &str,
) {
    run_benchmark(
        "GaussianInteger::sum(Iterator<Item=GaussianInteger>)",
        BenchmarkType::EvaluationStrategy,
        gaussian_integer_vec_gen().get(gm, config),
        gm.name(),
        limit,
        file_name,
        &vec_gaussian_integer_sum_bits_bucketer(),
        &mut [
            (
                "GaussianInteger::sum(Iterator<Item=GaussianInteger>)",
                &mut |xs| {
                    no_out!(GaussianInteger::sum(xs.into_iter()));
                },
            ),
            (
                "GaussianInteger::sum(Iterator<Item=&GaussianInteger>)",
                &mut |xs| {
                    no_out!(GaussianInteger::sum(xs.iter()));
                },
            ),
        ],
    );
}