DoxigAlpha

pow

q = a ^ b

r may not alias a.

Asserts that r has enough limbs to store the result. Upper bound is calcPowLimbsBufferLen(a.bitCountAbs(), b).

limbs_buffer is used for temporary storage. The amount required is given by calcPowLimbsBufferLen.

Function parameters

Parameters

#
r:*Mutable
b:u32
limbs_buffer:[]Limb

Used to indicate either limit of a 2s-complement integer.

Types

#
TwosCompIntLimit
Used to indicate either limit of a 2s-complement integer.
Mutable
A arbitrary-precision big integer, with a fixed set of mutable limbs.
Const
A arbitrary-precision big integer, with a fixed set of immutable limbs.
Managed
An arbitrary-precision big integer along with an allocator which manages the memory.

Returns the number of limbs needed to store `scalar`, which must be a

Functions

#
calcLimbLen
Returns the number of limbs needed to store `scalar`, which must be a
calcSetStringLimbCount
Assumes `string_len` doesn't account for minus signs if the number is negative.
calcNonZeroTwosCompLimbCount
Compute the number of limbs required to store a 2s-complement number of `bit_count` bits.
calcTwosCompLimbCount
Compute the number of limbs required to store a 2s-complement number of `bit_count` bits.
addMulLimbWithCarry
a + b * c + *carry, sets carry to the overflow bits
llcmp
Returns -1, 0, 1 if |a| < |b|, |a| == |b| or |a| > |b| respectively for limbs.

Source

Implementation

#
pub fn pow(r: *Mutable, a: Const, b: u32, limbs_buffer: []Limb) void {
    assert(r.limbs.ptr != a.limbs.ptr); // illegal aliasing

    // Handle all the trivial cases first
    switch (b) {
        0 => {
            // a^0 = 1
            return r.set(1);
        },
        1 => {
            // a^1 = a
            return r.copy(a);
        },
        else => {},
    }

    if (a.eqlZero()) {
        // 0^b = 0
        return r.set(0);
    } else if (a.limbs.len == 1 and a.limbs[0] == 1) {
        // 1^b = 1 and -1^b = ±1
        r.set(1);
        r.positive = a.positive or (b & 1) == 0;
        return;
    }

    // Here a>1 and b>1
    const needed_limbs = calcPowLimbsBufferLen(a.bitCountAbs(), b);
    assert(r.limbs.len >= needed_limbs);
    assert(limbs_buffer.len >= needed_limbs);

    llpow(r.limbs, a.limbs, b, limbs_buffer);

    r.normalize(needed_limbs);
    r.positive = a.positive or (b & 1) == 0;
}