malachite-nz 0.3.2

The bignum types Natural and Integer, with efficient algorithms partially derived from GMP and FLINT
Documentation
use malachite_base::num::arithmetic::traits::ModInverse;
use malachite_base::test_util::bench::{run_benchmark, BenchmarkType};
use malachite_base::test_util::generators::common::{GenConfig, GenMode};
use malachite_base::test_util::runner::Runner;
use malachite_nz::test_util::bench::bucketers::pair_2_natural_bit_bucketer;
use malachite_nz::test_util::generators::natural_pair_gen_var_11;
use malachite_nz::test_util::natural::arithmetic::mod_inverse::mod_inverse_simple;

pub(crate) fn register(runner: &mut Runner) {
    register_demo!(runner, demo_natural_mod_inverse);
    register_demo!(runner, demo_natural_mod_inverse_val_ref);
    register_demo!(runner, demo_natural_mod_inverse_ref_val);
    register_demo!(runner, demo_natural_mod_inverse_ref_ref);

    register_bench!(runner, benchmark_natural_mod_inverse_evaluation_strategy);
    register_bench!(runner, benchmark_natural_mod_inverse_algorithms);
}

fn demo_natural_mod_inverse(gm: GenMode, config: GenConfig, limit: usize) {
    for (n, m) in natural_pair_gen_var_11().get(gm, &config).take(limit) {
        let n_old = n.clone();
        let m_old = m.clone();
        if let Some(inverse) = n.mod_inverse(m) {
            println!("{}⁻¹ ≡ {} mod {}", n_old, inverse, m_old);
        } else {
            println!("{} is not invertible mod {}", n_old, m_old);
        }
    }
}

fn demo_natural_mod_inverse_val_ref(gm: GenMode, config: GenConfig, limit: usize) {
    for (n, m) in natural_pair_gen_var_11().get(gm, &config).take(limit) {
        let n_old = n.clone();
        if let Some(inverse) = n.mod_inverse(&m) {
            println!("{}⁻¹ ≡ {} mod {}", n_old, inverse, m);
        } else {
            println!("{} is not invertible mod {}", n_old, m);
        }
    }
}

fn demo_natural_mod_inverse_ref_val(gm: GenMode, config: GenConfig, limit: usize) {
    for (n, m) in natural_pair_gen_var_11().get(gm, &config).take(limit) {
        let m_old = m.clone();
        if let Some(inverse) = (&n).mod_inverse(m) {
            println!("{}⁻¹ ≡ {} mod {}", n, inverse, m_old);
        } else {
            println!("{} is not invertible mod {}", n, m_old);
        }
    }
}

fn demo_natural_mod_inverse_ref_ref(gm: GenMode, config: GenConfig, limit: usize) {
    for (n, m) in natural_pair_gen_var_11().get(gm, &config).take(limit) {
        if let Some(inverse) = (&n).mod_inverse(&m) {
            println!("{}⁻¹ ≡ {} mod {}", n, inverse, m);
        } else {
            println!("{} is not invertible mod {}", n, m);
        }
    }
}

fn benchmark_natural_mod_inverse_evaluation_strategy(
    gm: GenMode,
    config: GenConfig,
    limit: usize,
    file_name: &str,
) {
    run_benchmark(
        "Natural.mod_inverse(Natural)",
        BenchmarkType::EvaluationStrategy,
        natural_pair_gen_var_11().get(gm, &config),
        gm.name(),
        limit,
        file_name,
        &pair_2_natural_bit_bucketer("m"),
        &mut [
            ("Natural.mod_inverse(Natural)", &mut |(n, m)| {
                no_out!(n.mod_inverse(m))
            }),
            ("Natural.mod_inverse(&Natural)", &mut |(n, m)| {
                no_out!(n.mod_inverse(&m))
            }),
            ("(&Natural).mod_inverse(Natural)", &mut |(n, m)| {
                no_out!((&n).mod_inverse(m))
            }),
            ("(&Natural).mod_inverse(&Natural)", &mut |(n, m)| {
                no_out!((&n).mod_inverse(&m))
            }),
        ],
    );
}

fn benchmark_natural_mod_inverse_algorithms(
    gm: GenMode,
    config: GenConfig,
    limit: usize,
    file_name: &str,
) {
    run_benchmark(
        "Natural.mod_inverse(Natural)",
        BenchmarkType::Algorithms,
        natural_pair_gen_var_11().get(gm, &config),
        gm.name(),
        limit,
        file_name,
        &pair_2_natural_bit_bucketer("m"),
        &mut [
            ("default", &mut |(n, m)| no_out!(n.mod_inverse(m))),
            ("simple", &mut |(n, m)| no_out!(mod_inverse_simple(n, m))),
        ],
    );
}