malachite-base 0.9.1

A collection of utilities, including new arithmetic traits and iterators that generate all values of a type.
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

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

/// A trait for testing whether a number is prime.
pub trait IsPrime {
    fn is_prime(&self) -> bool;
}

/// A trait for testing whether a number is a square.
pub trait IsSquare {
    fn is_square(&self) -> bool;
}

/// A trait for testing whether a number is a perfect power.
pub trait IsPower {
    fn is_power(&self) -> bool;
}

/// A trait for expessing as number as the power of some number raised to an exponent greater than
/// 1, if such a representation exists.
pub trait ExpressAsPower: Sized {
    fn express_as_power(&self) -> Option<(Self, u64)>;
}

/// A trait for finding the prime factorization of a number.
pub trait Factor {
    type FACTORS;

    fn factor(&self) -> Self::FACTORS;
}

/// A trait for producing iterators of primes.
pub trait Primes {
    type I: Iterator<Item = Self>;
    type LI: Iterator<Item = Self>;

    fn primes_less_than(n: &Self) -> Self::LI;

    fn primes_less_than_or_equal_to(n: &Self) -> Self::LI;

    fn primes() -> Self::I;
}

/// A trait for finding a primitive root modulo a prime.
pub trait PrimitiveRootPrime {
    type Output;

    fn primitive_root_prime(&self) -> Self::Output;
}