rusqsieve 0.2.1

//! Strong probable-prime testing.
use crate::Natural;
use core::num::NonZero;

// Counts strong-Lucas evaluations on the current thread. No known input distinguishes a correct
// Lucas implementation from one that never runs — no Baillie-PSW pseudoprime is known — so the tests
// assert on this counter to prove the stage is not dead code. Thread-local, because `cargo test` runs
// test functions concurrently and a process-wide counter would let one test's Lucas call satisfy
// another test's assertion.
#[cfg(test)]
thread_local! {
    static LUCAS_TEST_CALLS: core::cell::Cell<usize> = const { core::cell::Cell::new(0) };
}

#[derive(Clone, Debug)]
pub struct PrimalityConfig {
    /// Miller-Rabin rounds. Under the default [`WitnessPolicy::FirstPrimes`] the witness for round
    /// `r` is `SMALL[r % SMALL.len()]` over a 32-entry table, so **rounds beyond 32 repeat witnesses
    /// and add no confidence** at the cost of a full modexp each. Above 2^64 the strength comes from
    /// Baillie-PSW rather than from these rounds; below it the seven-base witness set in
    /// `smallfactor` is proven exact.
    pub rounds: NonZero<u32>,
    pub witnesses: WitnessPolicy,
}
#[derive(Clone, Debug)]
pub enum WitnessPolicy {
    FirstPrimes,
    Seeded { seed: [u8; 32] },
}
impl Default for PrimalityConfig {
    fn default() -> Self {
        Self {
            rounds: NonZero::new(16).unwrap(),
            witnesses: WitnessPolicy::FirstPrimes,
        }
    }
}

const SMALL: [u64; 32] = [
    2, 3, 5, 7, 11, 13, 17, 19, 23, 29, 31, 37, 41, 43, 47, 53, 59, 61, 67, 71, 73, 79, 83, 89, 97,
    101, 103, 107, 109, 113, 127, 131,
];
pub fn is_probable_prime<const P: usize>(n: &Natural<P>, config: &PrimalityConfig) -> bool {
    if *n < Natural::from_u64(2) {
        return false;
    }
    for &p in &SMALL {
        let q = Natural::from_u64(p);
        if n == &q {
            return true;
        }
        if n.mod_u64(p) == 0 {
            return false;
        }
    }
    if n.is_even() {
        return false;
    }
    // Baillie-PSW, above 2^64 only. Below that the seven-base Jaeschke/Sinclair witness set in
    // `smallfactor` is proven exact, so BPSW would add cost and no strength. The square test is not
    // an optimization: Selfridge's `D` search never terminates for a perfect square.
    if n.bit_len() > 64
        && (n.is_square() || !miller_rabin_witness(n, 2) || !strong_lucas_selfridge(n))
    {
        return false;
    }
    let one = Natural::ONE;
    let nm1 = n.checked_sub(&one).unwrap();
    let s = nm1.trailing_zeros();
    let d = nm1.clone() >> s;
    let mut rng = seed_state(config, n);
    for round in 0..config.rounds.get() {
        let a = match config.witnesses {
            WitnessPolicy::FirstPrimes => Natural::from_u64(SMALL[round as usize % SMALL.len()]),
            WitnessPolicy::Seeded { .. } => {
                rng = xorshift(rng);
                Natural::from_u64(2u64.wrapping_add(rng))
            }
        };
        let a = a.div_rem(n).unwrap().1;
        if a.is_zero() {
            continue;
        }
        let mut x = a.pow_mod(&d, n);
        if x == one || x == nm1 {
            continue;
        }
        let mut composite = true;
        for _ in 1..s {
            x = x.mul_mod(&x, n);
            if x == nm1 {
                composite = false;
                break;
            }
            if x == one {
                return false;
            }
        }
        if composite {
            return false;
        }
    }
    true
}

fn miller_rabin_witness<const P: usize>(n: &Natural<P>, witness: u64) -> bool {
    let one = Natural::ONE;
    let nm1 = n.checked_sub(&one).unwrap();
    let s = nm1.trailing_zeros();
    let d = nm1.clone() >> s;
    let mut x = Natural::from_u64(witness).pow_mod(&d, n);
    if x == one || x == nm1 {
        return true;
    }
    for _ in 1..s {
        x = x.mul_mod(&x, n);
        if x == nm1 {
            return true;
        }
        if x == one {
            return false;
        }
    }
    false
}

fn strong_lucas_selfridge<const P: usize>(n: &Natural<P>) -> bool {
    #[cfg(test)]
    LUCAS_TEST_CALLS.with(|c| c.set(c.get() + 1));

    let mut magnitude = 5i64;
    let mut positive = true;
    let d = loop {
        let candidate = if positive { magnitude } else { -magnitude };
        match jacobi_small_natural(candidate, n) {
            -1 => break candidate,
            0 => return false,
            _ => {}
        }
        magnitude += 2;
        positive = !positive;
    };
    let q = (1 - d) / 4;
    let n_plus_one = n.checked_add(&Natural::ONE).unwrap();
    let s = n_plus_one.trailing_zeros();
    let odd_part = n_plus_one >> s;
    let (u, mut v, mut qk) = lucas_sequence(n, d, q, &odd_part);
    if u.is_zero() || v.is_zero() {
        return true;
    }
    for _ in 1..s {
        v = sub_mod(&v.mul_mod(&v, n), &qk.add_mod(&qk, n), n);
        qk = qk.mul_mod(&qk, n);
        if v.is_zero() {
            return true;
        }
    }
    false
}

fn lucas_sequence<const P: usize>(
    n: &Natural<P>,
    d: i64,
    q: i64,
    k: &Natural<P>,
) -> (Natural<P>, Natural<P>, Natural<P>) {
    debug_assert!(!k.is_zero() && k.is_odd());
    let mut u = Natural::ONE;
    let mut v = Natural::ONE;
    let q_mod = signed_small_mod(q, n);
    let mut qk = q_mod.clone();
    let bits = k.bit_len();
    for bit in (0..bits.saturating_sub(1)).rev() {
        u = u.mul_mod(&v, n);
        v = sub_mod(&v.mul_mod(&v, n), &qk.add_mod(&qk, n), n);
        qk = qk.mul_mod(&qk, n);
        if natural_bit(k, bit) {
            let old_u = u;
            let old_v = v;
            u = half_mod(&old_u.add_mod(&old_v, n), n);
            let du = signed_mul_mod(d, &old_u, n);
            v = half_mod(&du.add_mod(&old_v, n), n);
            qk = qk.mul_mod(&q_mod, n);
        }
    }
    (u, v, qk)
}

fn jacobi_small_natural<const P: usize>(d: i64, n: &Natural<P>) -> i32 {
    debug_assert!(d != 0 && d & 1 != 0 && n.is_odd());
    let magnitude = d.unsigned_abs();
    let mut sign = 1;
    let n_mod_four = n.mod_u64(4);
    if d < 0 && n_mod_four == 3 {
        sign = -sign;
    }
    if magnitude & 3 == 3 && n_mod_four == 3 {
        sign = -sign;
    }
    sign * i32::from(crate::jacobi_u64(n.mod_u64(magnitude), magnitude))
}

fn natural_bit<const P: usize>(n: &Natural<P>, bit: usize) -> bool {
    n.as_parts()
        .get(bit / 64)
        .is_some_and(|limb| limb & (1u64 << (bit % 64)) != 0)
}

fn signed_small_mod<const P: usize>(value: i64, n: &Natural<P>) -> Natural<P> {
    let magnitude = Natural::from_u64(value.unsigned_abs())
        .div_rem(n)
        .unwrap()
        .1;
    if value < 0 && !magnitude.is_zero() {
        n.wrapping_sub(&magnitude)
    } else {
        magnitude
    }
}

fn signed_mul_mod<const P: usize>(value: i64, rhs: &Natural<P>, n: &Natural<P>) -> Natural<P> {
    let product = Natural::from_u64(value.unsigned_abs()).mul_mod(rhs, n);
    if value < 0 && !product.is_zero() {
        n.wrapping_sub(&product)
    } else {
        product
    }
}

fn sub_mod<const P: usize>(a: &Natural<P>, b: &Natural<P>, n: &Natural<P>) -> Natural<P> {
    if a >= b {
        a.wrapping_sub(b)
    } else {
        n.wrapping_sub(&b.wrapping_sub(a))
    }
}

fn half_mod<const P: usize>(value: &Natural<P>, n: &Natural<P>) -> Natural<P> {
    if value.is_even() {
        value.clone() >> 1
    } else {
        (value.clone() >> 1).add_mod(&((n.clone() >> 1).wrapping_add(&Natural::ONE)), n)
    }
}
fn seed_state<const P: usize>(c: &PrimalityConfig, n: &Natural<P>) -> u64 {
    let mut s = 0x9e3779b97f4a7c15;
    for &x in n.as_parts() {
        s ^= x;
        s = xorshift(s)
    }
    if let WitnessPolicy::Seeded { seed } = c.witnesses {
        for chunk in seed.chunks_exact(8) {
            s ^= u64::from_le_bytes(chunk.try_into().unwrap());
            s = xorshift(s)
        }
    }
    s
}
fn xorshift(mut x: u64) -> u64 {
    x ^= x << 13;
    x ^= x >> 7;
    x ^= x << 17;
    x
}

#[cfg(test)]
mod tests {
    use super::*;
    #[test]
    fn known() {
        let c = PrimalityConfig::default();
        for p in [2, 3, 97, 104729] {
            assert!(is_probable_prime(&Natural::<2>::from_u64(p), &c))
        }
        for n in [0, 1, 4, 91, 561, 1105] {
            assert!(!is_probable_prime(&Natural::<2>::from_u64(n), &c))
        }
    }

    /// Below 2^64 the witness set is not Baillie-PSW but the fixed `SMALL` table, so these are the
    /// inputs that table has to get right on its own: Carmichael numbers (Fermat liars to every base
    /// coprime to `n`) and strong pseudoprimes to base 2.
    #[test]
    fn rejects_carmichael_numbers_and_base_two_strong_pseudoprimes() {
        let c = PrimalityConfig::default();
        for n in [
            561u64, 1105, 1729, 2465, 2821, 6601, 8911, 41041, 62745, 162401, 825265, 321197185,
        ] {
            assert!(
                !is_probable_prime(&Natural::<2>::from_u64(n), &c),
                "Carmichael number {n} was accepted as prime"
            );
        }
        for n in [2047u64, 3277, 4033, 4681, 8321, 15841, 42799, 3215031751] {
            assert!(
                !is_probable_prime(&Natural::<2>::from_u64(n), &c),
                "base-2 strong pseudoprime {n} was accepted as prime"
            );
        }
    }

    /// Above 2^64 the guarantee comes from Baillie-PSW. `318665857834031151167461` and
    /// `3317044064679887385961981` are the smallest strong pseudoprimes to all bases up to 37 and 41
    /// respectively — beyond what a fixed-base table can settle — and
    /// `82963349344421390809 = 2400187 · 4800373 · 7200559` is a Carmichael number above 2^64, so it
    /// is a Fermat liar to every base coprime to it. All three must be rejected, the Mersenne prime
    /// must be accepted, and the strong Lucas stage must be shown to have actually run.
    #[test]
    fn baillie_psw_rejects_strong_pseudoprimes_and_runs_the_lucas_stage() {
        LUCAS_TEST_CALLS.with(|c| c.set(0));
        let c = PrimalityConfig::default();
        for composite in [
            "318665857834031151167461",
            "3317044064679887385961981",
            "82963349344421390809",
        ] {
            let n = Natural::<16>::from_decimal(composite).unwrap();
            assert!(!is_probable_prime(&n, &c), "{composite} is composite");
        }
        let prime = Natural::<16>::from_decimal("170141183460469231731687303715884105727").unwrap();
        assert!(is_probable_prime(&prime, &c));
        assert!(
            LUCAS_TEST_CALLS.with(core::cell::Cell::get) > 0,
            "the strong Lucas stage was not exercised"
        );
    }

    /// Cost of the primality path, which Baillie-PSW adds a base-2 Miller-Rabin and a strong Lucas
    /// test to. Run with `cargo test --profile release-test -- --ignored --nocapture`.
    #[test]
    #[ignore = "manual primality-path measurement"]
    fn profile_primality_path() {
        // Primes above 2^64 (so BPSW applies) and a composite of two large primes, which is what the
        // engine actually feeds this on recovered factors.
        let inputs = [
            "170141183460469231731687303715884105727",
            "18446744073709551629",
            "340282366920938463463374607431768211297",
            "340282366920938463463374607431768211455",
        ];
        let values: Vec<Natural<16>> = inputs
            .iter()
            .map(|s| Natural::from_decimal(s).unwrap())
            .collect();
        let config = PrimalityConfig::default();
        let started = std::time::Instant::now();
        let mut accepted = 0usize;
        for _ in 0..200 {
            for value in &values {
                if is_probable_prime(std::hint::black_box(value), &config) {
                    accepted += 1;
                }
            }
        }
        eprintln!(
            "BENCH primality_800_calls={:.6}s accepted={accepted}",
            started.elapsed().as_secs_f64()
        );
    }

    /// Selfridge's `D` search never terminates for a perfect square, so the square test in front of
    /// it is load-bearing rather than an optimization. A large square must be rejected promptly.
    #[test]
    fn perfect_squares_above_2_64_are_rejected_before_the_d_search() {
        let c = PrimalityConfig::default();
        let root = Natural::<16>::from_decimal("18446744073709551557").unwrap();
        let square = root.checked_mul(&root).unwrap();
        assert!(square.bit_len() > 64);
        assert!(!is_probable_prime(&square, &c));
    }
}