Documentation

PHP64 extends PHP

in package

• PHP

Pure-PHP 64-bit Engine.

Tags

author

Jim Wigginton terrafrost@php.net

access

public

Table of Contents

Constants

BASE  = 31

BASE_FULL  = 0x80000000

ENGINE_DIR  = 'PHP'

Engine Directory

FAST_BITWISE  = true

Can Bitwise operations be done fast?

KARATSUBA_CUTOFF  = 25

Karatsuba Cutoff

MAX10  = 1000000000

MAX10 in greatest MAX10LEN satisfying MAX10 = 10**MAX10LEN <= 2**BASE.

MAX10LEN  = 9

MAX10LEN in greatest MAX10LEN satisfying MAX10 = 10**MAX10LEN <= 2**BASE.

MAX_DIGIT  = 0x7fffffff

MAX_DIGIT2  = 4611686018427387904

MSB  = 0x40000000

SIGN  = 1

$result[self::SIGN] contains the sign.

VALUE  = 0

$result[self::VALUE] contains the value.

Properties

$bitmask  : mixed

Precision Bitmask

$is_negative  : bool

Holds the BigInteger's sign

$isValidEngine  : bool

Engine Validity Flag

$modexpEngine  : string

Modular Exponentiation Engine

$one  : PHP64

BigInteger(1)

$precision  : mixed

Precision

$primes  : array<string|int, mixed>

Primes > 2 and < 1000

$reduce  : callable

Recurring Modulo Function

$two  : PHP64

BigInteger(2)

$value  : mixed

Holds the BigInteger's value

$zero  : PHP64

BigInteger(0)

Methods

__construct()  : PHP

Default constructor

__debugInfo()  : mixed

__debugInfo() magic method

__toString()  : string

Converts a BigInteger to a base-10 number.

abs()  : PHP

Absolute value.

add()  : PHP64

Adds two BigIntegers.

between()  : bool

Tests BigInteger to see if it is between two integers, inclusive

bitwise_and()  : PHP64

Logical And

bitwise_leftRotate()  : Engine

Logical Left Rotate

bitwise_leftShift()  : PHP

Logical Left Shift

bitwise_not()  : Engine|string

Logical Not

bitwise_or()  : PHP64

Logical Or

bitwise_rightRotate()  : Engine

Logical Right Rotate

bitwise_rightShift()  : PHP

Logical Right Shift

bitwise_split()  : array<string|int, PHP>

Bitwise Split

bitwise_xor()  : PHP64

Logical Exclusive Or

compare()  : int

Compares two numbers.

createRecurringModuloFunction()  : callable

Create Recurring Modulo Function

divide()  : PHP64

Divides two BigIntegers.

equals()  : bool

Tests the equality of two numbers.

extendedGCD()  : array<string|int, PHP64>

Calculates modular inverses.

gcd()  : PHP64

Calculates the greatest common divisor

getLength()  : int

Return the size of a BigInteger in bits

getLengthInBytes()  : int

Return the size of a BigInteger in bytes

getPrecision()  : int

Get Precision

isNegative()  : bool

Is Negative?

isOdd()  : bool

Is Odd?

isPrime()  : bool

Checks a numer to see if it's prime

isValidEngine()  : bool

Test for engine validity

max()  : PHP64

Return the maximum BigInteger between an arbitrary number of BigIntegers.

min()  : PHP64

Return the minimum BigInteger between an arbitrary number of BigIntegers.

minMaxBits()  : array<string|int, Engine>

Returns the smallest and largest n-bit number

modInverse()  : false|PHP64

Calculates modular inverses.

modPow()  : PHP64

Performs modular exponentiation.

multiply()  : PHP64

Multiplies two BigIntegers.

negate()  : BigInteger

Negate

pow()  : PHP64

Performs exponentiation.

powMod()  : PHP64

Performs modular exponentiation.

random()  : Engine

Generates a random number of a certain size

randomPrime()  : Engine

Generates a random prime number of a certain size

randomRange()  : PHP64

Generate a random number between a range

randomRangePrime()  : false|PHP64

Generate a random prime number between a range

root()  : Engine

Calculates the nth root of a biginteger.

scan1divide()  : int

Scan for 1 and right shift by that amount

serialize()  : string

Serialize

setModExpEngine()  : mixed

Sets engine type.

setPrecision()  : mixed

Set Precision

subtract()  : PHP64

Subtracts two BigIntegers.

subtractHelper()  : array<string|int, mixed>

Performs subtraction.

testBit()  : bool

Tests if a bit is set

toBits()  : string

Converts a BigInteger to a bit string (eg. base-2).

toBytes()  : string

Converts a BigInteger to a byte string (eg. base-256).

toHex()  : string

Converts a BigInteger to a hex string (eg. base-16).

toString()  : string

Converts a BigInteger to a base-10 number.

unserialize()  : mixed

Serialize

addHelper()  : array<string|int, mixed>

Performs addition.

array_repeat()  : array<string|int, mixed>

Array Repeat

base256_lshift()  : string

Logical Left Shift

baseSquare()  : array<string|int, mixed>

Performs traditional squaring on two BigIntegers

bitwiseAndHelper()  : Engine

Logical And

bitwiseOrHelper()  : Engine

Logical Or

bitwiseXorHelper()  : Engine

Logical Exclusive Or

compareHelper()  : mixed

convertToObj()  : mixed

extendedGCDHelper()  : Engine

Calculates the greatest common divisor and Bezout's identity.

initialize()  : mixed

Initialize a PHP64 BigInteger Engine instance

karatsubaSquare()  : array<string|int, mixed>

Performs Karatsuba "squaring" on two BigIntegers

lshift()  : mixed

Logical Left Shift

make_odd()  : mixed

Make the current number odd

maxHelper()  : Engine

Return the minimum BigInteger between an arbitrary number of BigIntegers.

minHelper()  : Engine

Return the minimum BigInteger between an arbitrary number of BigIntegers.

modInverseHelper()  : Engine|false

Calculates modular inverses.

multiplyHelper()  : array<string|int, mixed>

Performs multiplication.

normalize()  : PHP

Normalize

pad()  : string

Pads strings so that unpack may be used on them

powHelper()  : PHP

Performs exponentiation.

powModInner()  : PHP

Performs modular exponentiation.

powModOuter()  : bool|Engine

Performs some pre-processing for powMod

randomRangeHelper()  : Engine

Generate a random number between a range

randomRangePrimeInner()  : bool|Engine

Performs some post-processing for randomRangePrime

randomRangePrimeOuter()  : bool|Engine

Performs some pre-processing for randomRangePrime

regularMultiply()  : array<string|int, mixed>

Performs long multiplication on two BigIntegers

rootHelper()  : Engine

Performs a few preliminary checks on root

rootInner()  : Engine

Calculates the nth root of a biginteger.

rshift()  : mixed

Logical Right Shift

setBitmask()  : Engine

Set Bitmask

setupIsPrime()  : int

Sets the $t parameter for primality testing

slidingWindow()  : Engine

Sliding Window k-ary Modular Exponentiation

square()  : array<string|int, mixed>

Performs squaring

testPrimality()  : bool

Tests Primality

testSmallPrimes()  : mixed

Test the number against small primes.

toBytesHelper()  : string

Converts a BigInteger to a byte string (eg. base-256).

trim()  : PHP

Trim

bitwise_small_split()  : array<string|int, PHP>

Bitwise Split where $split < static::BASE

divide_digit()  : array<string|int, mixed>

Divides a BigInteger by a regular integer

int2bytes()  : string

Converts 32-bit integers to bytes.

karatsuba()  : array<string|int, mixed>

Performs Karatsuba multiplication on two BigIntegers

safe_divide()  : int

Single digit division