Graphe d'héritage de Calculator:

Fonctions membres publiques
	abs (string $n)

	neg (string $n)

	cmp (string $a, string $b)

	add (string $a, string $b)

	sub (string $a, string $b)

	mul (string $a, string $b)

	divQ (string $a, string $b)

	divR (string $a, string $b)

	divQR (string $a, string $b)

	pow (string $a, int $e)

	mod (string $a, string $b)

	modInverse (string $x, string $m)

	modPow (string $base, string $exp, string $mod)

	gcd (string $a, string $b)

	sqrt (string $n)

	fromBase (string $number, int $base)

	toBase (string $number, int $base)

	fromArbitraryBase (string $number, string $alphabet, int $base)

	toArbitraryBase (string $number, string $alphabet, int $base)

	divRound (string $a, string $b, int $roundingMode)

	and (string $a, string $b)

	or (string $a, string $b)

	xor (string $a, string $b)

Fonctions membres publiques statiques
static	set (?Calculator $calculator)

static	get ()

Champs de données
const	MAX_POWER = 1000000

const	ALPHABET = '0123456789abcdefghijklmnopqrstuvwxyz'

Fonctions membres protégées
	init (string $a, string $b)

Fonctions membres privées
	gcdExtended (string $a, string $b, string &$x, string &$y)

	bitwise (string $operator, string $a, string $b)

	twosComplement (string $number)

	toBinary (string $number)

	toDecimal (string $bytes)

Fonctions membres privées statiques
static	detect ()

Attributs privés statiques
static	$instance

Description détaillée

Performs basic operations on arbitrary size integers.

Unless otherwise specified, all parameters must be validated as non-empty strings of digits, without leading zero, and with an optional leading minus sign if the number is not zero.

Any other parameter format will lead to undefined behaviour. All methods must return strings respecting this format, unless specified otherwise.

Documentation des fonctions membres

◆ abs()

abs ( string $n )

final

Returns the absolute value of a number.

Paramètres

string $n The number.

Renvoie: string The absolute value.

Références $n.

Référencé par Calculator\divRound(), Calculator\gcd(), et Calculator\modInverse().

◆ add()

add	(	string	$a,
		string	$b
	)

abstract

Adds two numbers.

Paramètres

string	$a	The augend.
string	$b	The addend.

Renvoie: string The sum.

Référencé par Calculator\divRound(), Calculator\fromArbitraryBase(), Calculator\mod(), Calculator\modInverse(), et Calculator\toDecimal().

◆ and()

and	(	string	$a,
		string	$b
	)

Calculates bitwise AND of two numbers.

This method can be overridden by the concrete implementation if the underlying library has built-in support for bitwise operations.

Paramètres

string	$a
string	$b

Renvoie: string

Références $b, et Calculator\bitwise().

Référencé par Calculator\bitwise().

◆ bitwise()

bitwise	(	string	$operator,
		string	$a,
		string	$b
	)

private

Performs a bitwise operation on a decimal number.

Paramètres

string	$operator	The operator to use, must be "and", "or" or "xor".
string	$a	The left operand.
string	$b	The right operand.

Renvoie: string

Références $b, $result, $value, Calculator\and(), elseif, Calculator\init(), Calculator\neg(), Calculator\or(), Calculator\toBinary(), Calculator\toDecimal(), Calculator\twosComplement(), et Calculator\xor().

Référencé par Calculator\and(), Calculator\or(), et Calculator\xor().

◆ cmp()

cmp	(	string	$a,
		string	$b
	)

final

Compares two numbers.

Paramètres

string	$a	The first number.
string	$b	The second number.

Renvoie: int [-1, 0, 1] If the first number is less than, equal to, or greater than the second number.

Références $b, $result, elseif, et Calculator\init().

Référencé par Calculator\divRound(), Calculator\modInverse(), et NativeCalculator\sqrt().

◆ detect()

static detect ( )

staticprivate

Returns the fastest available Calculator implementation.

Renvoie: Calculator

◆ divQ()

divQ	(	string	$a,
		string	$b
	)

abstract

Returns the quotient of the division of two numbers.

Paramètres

string	$a	The dividend.
string	$b	The divisor, must not be zero.

Renvoie: string The quotient.

Référencé par Calculator\gcdExtended().

◆ divQR()

divQR	(	string	$a,
		string	$b
	)

abstract

Returns the quotient and remainder of the division of two numbers.

Paramètres

string	$a	The dividend.
string	$b	The divisor, must not be zero.

Renvoie: string[] An array containing the quotient and remainder.

Référencé par Calculator\divRound(), Calculator\toArbitraryBase(), et Calculator\toBinary().

◆ divR()

divR	(	string	$a,
		string	$b
	)

abstract

Returns the remainder of the division of two numbers.

Paramètres

string	$a	The dividend.
string	$b	The divisor, must not be zero.

Renvoie: string The remainder.

Référencé par Calculator\gcd(), et Calculator\mod().

◆ divRound()

divRound	(	string	$a,
		string	$b,
		int	$roundingMode
	)

final

Performs a rounded division.

Rounding is performed when the remainder of the division is not zero.

Paramètres

string	$a	The dividend.
string	$b	The divisor.
int	$roundingMode	The rounding mode.

Renvoie: string

Exceptions

Références $b, $r, Calculator\abs(), Calculator\add(), RoundingMode\CEILING, Calculator\cmp(), Calculator\divQR(), RoundingMode\DOWN, RoundingMode\FLOOR, RoundingMode\HALF_CEILING, RoundingMode\HALF_DOWN, RoundingMode\HALF_EVEN, RoundingMode\HALF_FLOOR, RoundingMode\HALF_UP, Calculator\mul(), RoundingNecessaryException\roundingNecessary(), RoundingMode\UNNECESSARY, et RoundingMode\UP.

◆ fromArbitraryBase()

fromArbitraryBase	(	string	$number,
		string	$alphabet,
		int	$base
	)

final

Converts a non-negative number in an arbitrary base using a custom alphabet, to base 10.

Paramètres

string	$number	The number to convert, validated as a non-empty string, containing only chars in the given alphabet/base.
string	$alphabet	The alphabet that contains every digit, validated as 2 chars minimum.
int	$base	The base of the number, validated from 2 to alphabet length.

Renvoie: string The number in base 10, following the Calculator conventions.

Références $base, $i, $result, Calculator\add(), et Calculator\mul().

Référencé par Calculator\fromBase().

◆ fromBase()

fromBase	(	string	$number,
		int	$base
	)

Converts a number from an arbitrary base.

This method can be overridden by the concrete implementation if the underlying library has built-in support for base conversion.

Paramètres

string	$number	The number, positive or zero, non-empty, case-insensitively validated for the given base.
int	$base	The base of the number, validated from 2 to 36.

Renvoie: string The converted number, following the Calculator conventions.

Références $base, et Calculator\fromArbitraryBase().

◆ gcd()

gcd	(	string	$a,
		string	$b
	)

Returns the greatest common divisor of the two numbers.

This method can be overridden by the concrete implementation if the underlying library has built-in support for GCD calculations.

Paramètres

string	$a	The first number.
string	$b	The second number.

Renvoie: string The GCD, always positive, or zero if both arguments are zero.

Références $b, Calculator\abs(), et Calculator\divR().

◆ gcdExtended()

gcdExtended	(	string	$a,
		string	$b,
		string &	$x,
		string &	$y
	)

private

Références $b, Calculator\divQ(), Calculator\mod(), Calculator\mul(), et Calculator\sub().

Référencé par Calculator\modInverse().

◆ get()

static get ( )

staticfinal

Returns the Calculator instance to use.

If none has been explicitly set, the fastest available implementation will be returned.

Renvoie: Calculator

-pure -suppress ImpureStaticProperty

-suppress ImpureMethodCall

Références null.

Référencé par BigInteger\and(), BigDecimal\compareTo(), BigInteger\compareTo(), BigDecimal\dividedBy(), BigInteger\dividedBy(), BigDecimal\exactlyDividedBy(), BigInteger\fromArbitraryBase(), BigInteger\fromBase(), BigInteger\gcd(), BigDecimal\minus(), BigInteger\minus(), BigInteger\mod(), BigInteger\modInverse(), BigInteger\modPow(), BigDecimal\multipliedBy(), BigInteger\multipliedBy(), BigDecimal\negated(), BigInteger\negated(), BigInteger\or(), BigDecimal\plus(), BigInteger\plus(), BigDecimal\power(), BigInteger\power(), BigDecimal\quotient(), BigInteger\quotient(), BigDecimal\quotientAndRemainder(), BigInteger\quotientAndRemainder(), BigDecimal\remainder(), BigInteger\remainder(), BigDecimal\sqrt(), BigInteger\sqrt(), BigInteger\toArbitraryBase(), BigInteger\toBase(), et BigInteger\xor().

◆ init()

init	(	string	$a,
		string	$b
	)

finalprotected

Extracts the sign & digits of the operands.

Paramètres

string	$a	The first operand.
string	$b	The second operand.

Renvoie: array{0: bool, 1: bool, 2: string, 3: string} Whether $a and $b are negative, followed by their digits.

Références $b.

Référencé par NativeCalculator\add(), Calculator\bitwise(), Calculator\cmp(), NativeCalculator\divQR(), et NativeCalculator\mul().

◆ mod()

mod	(	string	$a,
		string	$b
	)

Paramètres

string	$a
string	$b	The modulus; must not be zero.

Renvoie: string

Références $b, Calculator\add(), et Calculator\divR().

Référencé par Calculator\gcdExtended(), et Calculator\modInverse().

◆ modInverse()

modInverse	(	string	$x,
		string	$m
	)

Returns the modular multiplicative inverse of $x modulo $m.

If $x has no multiplicative inverse mod m, this method must return null.

This method can be overridden by the concrete implementation if the underlying library has built-in support.

Paramètres

string	$x
string	$m	The modulus; must not be negative or zero.

Renvoie: string|null

Références $g, Calculator\abs(), Calculator\add(), Calculator\cmp(), Calculator\gcdExtended(), Calculator\mod(), et null.

◆ modPow()

modPow	(	string	$base,
		string	$exp,
		string	$mod
	)

abstract

Raises a number into power with modulo.

Paramètres

string	$base	The base number; must be positive or zero.
string	$exp	The exponent; must be positive or zero.
string	$mod	The modulus; must be strictly positive.

Renvoie: string The power.

◆ mul()

mul	(	string	$a,
		string	$b
	)

abstract

Multiplies two numbers.

Paramètres

string	$a	The multiplicand.
string	$b	The multiplier.

Renvoie: string The product.

Référencé par Calculator\divRound(), Calculator\fromArbitraryBase(), Calculator\gcdExtended(), et Calculator\toDecimal().

◆ neg()

neg ( string $n )

final

Negates a number.

Paramètres

string $n The number.

Renvoie: string The negated value.

Références $n.

Référencé par NativeCalculator\add(), Calculator\bitwise(), NativeCalculator\divQR(), NativeCalculator\doSub(), NativeCalculator\mul(), et NativeCalculator\sub().

◆ or()

or	(	string	$a,
		string	$b
	)

Calculates bitwise OR of two numbers.

This method can be overridden by the concrete implementation if the underlying library has built-in support for bitwise operations.

Paramètres

string	$a
string	$b

Renvoie: string

Références $b, et Calculator\bitwise().

Référencé par Calculator\bitwise().

◆ pow()

pow	(	string	$a,
		int	$e
	)

abstract

Exponentiates a number.

Paramètres

string	$a	The base number.
int	$e	The exponent, validated as an integer between 0 and MAX_POWER.

Renvoie: string The power.

◆ set()

static set ( ?Calculator $calculator )

staticfinal

Sets the Calculator instance to use.

An instance is typically set only in unit tests: the autodetect is usually the best option.

Paramètres

Calculator | null $calculator The calculator instance, or NULL to revert to autodetect.

Renvoie: void

◆ sqrt()

sqrt ( string $n )

abstract

Returns the square root of the given number, rounded down.

The result is the largest x such that x² ≤ n. The input MUST NOT be negative.

Paramètres

string $n The number.

Renvoie: string The square root.

◆ sub()

sub	(	string	$a,
		string	$b
	)

abstract

Subtracts two numbers.

Paramètres

string	$a	The minuend.
string	$b	The subtrahend.

Renvoie: string The difference.

Référencé par Calculator\gcdExtended().

◆ toArbitraryBase()

toArbitraryBase	(	string	$number,
		string	$alphabet,
		int	$base
	)

final

Converts a non-negative number to an arbitrary base using a custom alphabet.

Paramètres

string	$number	The number to convert, positive or zero, following the Calculator conventions.
string	$alphabet	The alphabet that contains every digit, validated as 2 chars minimum.
int	$base	The base to convert to, validated from 2 to alphabet length.

Renvoie: string The converted number in the given alphabet.

Références $base, $result, et Calculator\divQR().

Référencé par Calculator\toBase().

◆ toBase()

toBase	(	string	$number,
		int	$base
	)

Converts a number to an arbitrary base.

This method can be overridden by the concrete implementation if the underlying library has built-in support for base conversion.

Paramètres

string	$number	The number to convert, following the Calculator conventions.
int	$base	The base to convert to, validated from 2 to 36.

Renvoie: string The converted number, lowercase.

Références $base, et Calculator\toArbitraryBase().

◆ toBinary()

toBinary ( string $number )

private

Converts a decimal number to a binary string.

Paramètres

string $number The number to convert, positive or zero, only digits.

Renvoie: string

Références $result, et Calculator\divQR().

Référencé par Calculator\bitwise().

◆ toDecimal()

toDecimal ( string $bytes )

private

Returns the positive decimal representation of a binary number.

Paramètres

string $bytes The bytes representing the number.

Renvoie: string

Références $i, $result, Calculator\add(), et Calculator\mul().

Référencé par Calculator\bitwise().

◆ twosComplement()

twosComplement ( string $number )

private

Paramètres

string $number A positive, binary number.

Renvoie: string

Références $i.

Référencé par Calculator\bitwise().

◆ xor()

xor	(	string	$a,
		string	$b
	)

Calculates bitwise XOR of two numbers.

This method can be overridden by the concrete implementation if the underlying library has built-in support for bitwise operations.

Paramètres

string	$a
string	$b

Renvoie: string

Références $b, et Calculator\bitwise().

Référencé par Calculator\bitwise().

Documentation des champs

◆ $instance

$instance

staticprivate

◆ ALPHABET

const ALPHABET = '0123456789abcdefghijklmnopqrstuvwxyz'

The alphabet for converting from and to base 2 to 36, lowercase.

Référencé par BigInteger\fromBase().

◆ MAX_POWER

const MAX_POWER = 1000000

The maximum exponent value allowed for the pow() method.

Référencé par BigDecimal\power(), et BigInteger\power().

La documentation de cette classe a été générée à partir du fichier suivant :

Calculator.php

Fonctions membres publiques

Fonctions membres publiques statiques

Champs de données

Fonctions membres protégées

Fonctions membres privées

Fonctions membres privées statiques

Attributs privés statiques

Description détaillée

Documentation des fonctions membres

◆ abs()

◆ add()

◆ and()

◆ bitwise()

◆ cmp()

◆ detect()

◆ divQ()

◆ divQR()

◆ divR()

◆ divRound()

◆ fromArbitraryBase()

◆ fromBase()

◆ gcd()

◆ gcdExtended()

◆ get()

◆ init()

◆ mod()

◆ modInverse()

◆ modPow()

◆ mul()

◆ neg()

◆ or()

◆ pow()

◆ set()

◆ sqrt()

◆ sub()

◆ toArbitraryBase()

◆ toBase()

◆ toBinary()

◆ toDecimal()

◆ twosComplement()

◆ xor()

Documentation des champs

◆ $instance

◆ ALPHABET

◆ MAX_POWER