malachite-nz 0.11.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

// 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/>.

// These mirror the macros of the same names in `malachite_base`, and are defined here rather than
// imported for a specific reason: lints that report against the span of a generated item --
// `clippy::missing_const_for_fn` among them -- are silent when the macro comes from a *different*
// crate. Defining them locally puts every generated function back in view of those lints. Only the
// macros this crate uses are defined.
//
// Each pair promotes an item to `pub` under the `test_build` feature, so tests outside the crate
// can reach internals, and keeps the narrower visibility otherwise. The names read as
// `<visibility>_test_<kind>`, where the visibility is the one the item has *without* `test_build`
// and the kind is the item emitted, so `crate_test_const_fn` is a `const fn` and `crate_test_const`
// is a `const`.

#[cfg(feature = "test_build")]
macro_rules! private_test_fn {
    ($( #[$meta:meta] )* $name:ident $( $body:tt )*) => {
        $( #[$meta] )*
        pub fn $name $( $body )*
    };
}

#[cfg(not(feature = "test_build"))]
macro_rules! private_test_fn {
    ($( #[$meta:meta] )* $name:ident $( $body:tt )*) => {
        #[allow(dead_code)]
        $( #[$meta] )*
        fn $name $( $body )*
    };
}

#[cfg(feature = "test_build")]
macro_rules! crate_test_fn {
    ($( #[$meta:meta] )* $name:ident $( $body:tt )*) => {
        $( #[$meta] )*
        pub fn $name $( $body )*
    };
}

#[cfg(not(feature = "test_build"))]
macro_rules! crate_test_fn {
    ($( #[$meta:meta] )* $name:ident $( $body:tt )*) => {
        #[allow(dead_code)]
        $( #[$meta] )*
        pub(crate) fn $name $( $body )*
    };
}

#[cfg(feature = "test_build")]
macro_rules! private_test_const_fn {
    ($( #[$meta:meta] )* $name:ident $( $body:tt )*) => {
        $( #[$meta] )*
        pub const fn $name $( $body )*
    };
}

#[cfg(not(feature = "test_build"))]
macro_rules! private_test_const_fn {
    ($( #[$meta:meta] )* $name:ident $( $body:tt )*) => {
        #[allow(dead_code)]
        $( #[$meta] )*
        const fn $name $( $body )*
    };
}

#[cfg(feature = "test_build")]
macro_rules! crate_test_const_fn {
    ($( #[$meta:meta] )* $name:ident $( $body:tt )*) => {
        $( #[$meta] )*
        pub const fn $name $( $body )*
    };
}

#[cfg(not(feature = "test_build"))]
macro_rules! crate_test_const_fn {
    ($( #[$meta:meta] )* $name:ident $( $body:tt )*) => {
        #[allow(dead_code)]
        $( #[$meta] )*
        pub(crate) const fn $name $( $body )*
    };
}

#[cfg(feature = "test_build")]
macro_rules! crate_test_mod {
    ($( #[$meta:meta] )* $name:ident) => {
        $( #[$meta] )*
        pub mod $name;
    };
}

#[cfg(not(feature = "test_build"))]
macro_rules! crate_test_mod {
    ($( #[$meta:meta] )* $name:ident) => {
        $( #[$meta] )*
        #[allow(dead_code)]
        pub(crate) mod $name;
    };
}

#[cfg(feature = "test_build")]
macro_rules! crate_test_const {
    ($( #[$meta:meta] )* $name:ident $( $body:tt )*) => {
        $( #[$meta] )*
        pub const $name $( $body )*
    };
}

#[cfg(not(feature = "test_build"))]
macro_rules! crate_test_const {
    ($( #[$meta:meta] )* $name:ident $( $body:tt )*) => {
        $( #[$meta] )*
        pub(crate) const $name $( $body )*
    };
}