Référence de la classe BigDecimal

Graphe d'héritage de BigDecimal:

Fonctions membres publiques
	plus ($that)
	minus ($that)
	multipliedBy ($that)
	dividedBy ($that, ?int $scale=null, int $roundingMode=RoundingMode::UNNECESSARY)
	exactlyDividedBy ($that)
	power (int $exponent)
	quotient ($that)
	remainder ($that)
	quotientAndRemainder ($that)
	sqrt (int $scale)
	withPointMovedLeft (int $n)
	withPointMovedRight (int $n)
	stripTrailingZeros ()
	abs ()
	negated ()
	compareTo ($that)
	getSign ()
	getUnscaledValue ()
	getScale ()
	getIntegralPart ()
	getFractionalPart ()
	hasNonZeroFractionalPart ()
	toBigInteger ()
	toBigDecimal ()
	toBigRational ()
	toScale (int $scale, int $roundingMode=RoundingMode::UNNECESSARY)
	toInt ()
	toFloat ()
	__toString ()
	serialize ()
	unserialize ($value)
Fonctions membres publiques hérités de BigNumber
	isEqualTo ($that)
	isLessThan ($that)
	isLessThanOrEqualTo ($that)
	isGreaterThan ($that)
	isGreaterThanOrEqualTo ($that)
	isZero ()
	isNegative ()
	isNegativeOrZero ()
	isPositive ()
	isPositiveOrZero ()
	getSign ()
	compareTo ($that)
	toBigInteger ()
	toBigDecimal ()
	toBigRational ()
	toScale (int $scale, int $roundingMode=RoundingMode::UNNECESSARY)
	toInt ()
	toFloat ()
	__toString ()
	jsonSerialize ()

Fonctions membres publiques statiques
static	of ($value)
static	ofUnscaledValue ($value, int $scale=0)
static	zero ()
static	one ()
static	ten ()
Fonctions membres publiques statiques hérités de BigNumber
static	of ($value)
static	min (... $values)
static	max (... $values)

Fonctions membres protégées
	__construct (string $value, int $scale=0)

Fonctions membres privées
	scaleValues (BigDecimal $x, BigDecimal $y)
	valueWithMinScale (int $scale)
	getUnscaledValueWithLeadingZeros ()

Attributs privés
	$value
	$scale

Membres hérités additionnels
Fonctions membres protégées statiques hérités de BigNumber
static	create (... $args)

Description détaillée

Immutable, arbitrary-precision signed decimal numbers.

-immutable

Documentation des constructeurs et destructeur

__construct()

__construct ( string  $value, int  $scale = 0  )

protected

Protected constructor. Use a factory method to obtain an instance.

Paramètres

string	$value	The unscaled value, validated.
int	$scale	The scale, validated.

Références BigDecimal\$scale, BigDecimal\$value, et value.

Documentation des fonctions membres

__toString()

__toString

(

)

{}

Références BigDecimal\$value, et BigDecimal\getUnscaledValueWithLeadingZeros().

abs()

abs

(

)

Returns the absolute value of this number.

Renvoie

BigDecimal

Références $this, BigNumber\isNegative(), et BigDecimal\negated().

compareTo()

compareTo

(

$that

)

{}

Références $b, $this, Calculator\get(), BigNumber\of(), et BigDecimal\scaleValues().

dividedBy()

dividedBy	(		$that,
		?int	$scale = null,
		int	$roundingMode = RoundingMode::UNNECESSARY
	)

Returns the result of the division of this number by the given one, at the given scale.

Paramètres

BigNumber | int | float | string	$that	The divisor.
int | null	$scale	The desired scale, or null to use the scale of this number.
int	$roundingMode	An optional rounding mode.

Renvoie

BigDecimal

Exceptions

Références $result, BigDecimal\$scale, $this, DivisionByZeroException\divisionByZero(), elseif, Calculator\get(), null, BigDecimal\of(), et BigDecimal\valueWithMinScale().

Référencé par BigDecimal\exactlyDividedBy(), BigDecimal\toBigInteger(), et BigDecimal\toScale().

exactlyDividedBy()

exactlyDividedBy

(

$that

)

Returns the exact result of the division of this number by the given one.

The scale of the result is automatically calculated to fit all the fraction digits.

Paramètres

BigNumber | int | float | string

$that

The divisor. Must be convertible to a BigDecimal.

Renvoie

BigDecimal The result.

Exceptions

MathException

If the divisor is not a valid number, is not convertible to a BigDecimal, is zero, or the result yields an infinite number of digits.

Références $b, BigDecimal\$scale, $this, BigDecimal\dividedBy(), DivisionByZeroException\divisionByZero(), Calculator\get(), BigDecimal\of(), et BigDecimal\scaleValues().

getFractionalPart()

getFractionalPart

(

)

Returns a string representing the fractional part of this decimal number.

If the scale is zero, an empty string is returned.

Examples: -123.456 => '456', 123 => ''.

Renvoie

string

Références BigDecimal\$value, et BigDecimal\getUnscaledValueWithLeadingZeros().

Référencé par BigDecimal\hasNonZeroFractionalPart().

getIntegralPart()

getIntegralPart

(

)

Returns a string representing the integral part of this decimal number.

Example: -123.456 => -123.

Renvoie

string

Références BigDecimal\$value, et BigDecimal\getUnscaledValueWithLeadingZeros().

getScale()

getScale

(

)

Renvoie

int

Références BigDecimal\$scale.

getSign()

getSign

(

)

{}

Références value.

getUnscaledValue()

getUnscaledValue

(

)

Renvoie

BigInteger

Références BigNumber\create(), et value.

getUnscaledValueWithLeadingZeros()

getUnscaledValueWithLeadingZeros ( )

private

Adds leading zeros if necessary to the unscaled value to represent the full decimal number.

Renvoie

string

Références BigDecimal\$value.

Référencé par BigDecimal\__toString(), BigDecimal\getFractionalPart(), et BigDecimal\getIntegralPart().

hasNonZeroFractionalPart()

hasNonZeroFractionalPart

(

)

Returns whether this decimal number has a non-zero fractional part.

Renvoie

bool

Références BigDecimal\getFractionalPart().

minus()

minus

(

$that

)

Returns the difference of this number and the given one.

The result has a scale of max($this->scale, $that->scale).

Paramètres

BigNumber | int | float | string

$that

The number to subtract. Must be convertible to a BigDecimal.

Renvoie

BigDecimal The result.

Exceptions

MathException

If the number is not valid, or is not convertible to a BigDecimal.

Références $b, BigDecimal\$scale, $this, BigDecimal\$value, Calculator\get(), BigDecimal\of(), et BigDecimal\scaleValues().

multipliedBy()

multipliedBy

(

$that

)

Returns the product of this number and the given one.

The result has a scale of $this->scale + $that->scale.

Paramètres

BigNumber | int | float | string

$that

The multiplier. Must be convertible to a BigDecimal.

Renvoie

BigDecimal The result.

Exceptions

MathException

If the multiplier is not a valid number, or is not convertible to a BigDecimal.

Références BigDecimal\$scale, $this, BigDecimal\$value, Calculator\get(), BigDecimal\of(), et value.

negated()

negated

(

)

Returns the negated value of this number.

Renvoie

BigDecimal

Références Calculator\get(), et value.

Référencé par BigDecimal\abs().

of()

static of (   $value )

static

Creates a BigDecimal of the given value.

Paramètres

BigNumber | int | float | string

$value

Renvoie

BigDecimal

Exceptions

MathException

If the value cannot be converted to a BigDecimal.

-pure

Références BigDecimal\$value, et BigNumber\toBigDecimal().

Référencé par BigDecimal\dividedBy(), BigDecimal\exactlyDividedBy(), BigDecimal\minus(), BigDecimal\multipliedBy(), BigDecimal\plus(), BigDecimal\quotient(), BigDecimal\quotientAndRemainder(), et BigDecimal\remainder().

ofUnscaledValue()

static ofUnscaledValue (   $value, int  $scale = 0  )

static

Creates a BigDecimal from an unscaled value and a scale.

Example: (12345, 3) will result in the BigDecimal 12.345.

Paramètres

BigNumber | int | float | string	$value	The unscaled value. Must be convertible to a BigInteger.
int	$scale	The scale of the number, positive or zero.

Renvoie

BigDecimal

Exceptions

Références BigDecimal\$scale, BigDecimal\$value, et BigInteger\of().

one()

static one ( )

static

Returns a BigDecimal representing one, with a scale of zero.

Renvoie

BigDecimal

-pure

-suppress ImpureStaticVariable

Références null.

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

plus()

plus

(

$that

)

Returns the sum of this number and the given one.

The result has a scale of max($this->scale, $that->scale).

Paramètres

BigNumber | int | float | string

$that

The number to add. Must be convertible to a BigDecimal.

Renvoie

BigDecimal The result.

Exceptions

MathException

If the number is not valid, or is not convertible to a BigDecimal.

Références $b, BigDecimal\$scale, $this, BigDecimal\$value, Calculator\get(), BigDecimal\of(), BigDecimal\scaleValues(), et value.

power()

power

(

int

$exponent

)

Returns this number exponentiated to the given value.

The result has a scale of $this->scale * $exponent.

Paramètres

int

$exponent

The exponent.

Renvoie

BigDecimal The result.

Exceptions

Références $this, Calculator\get(), Calculator\MAX_POWER, BigDecimal\one(), et value.

quotient()

quotient

(

$that

)

Returns the quotient of the division of this number by this given one.

The quotient has a scale of 0.

Paramètres

BigNumber | int | float | string

$that

The divisor. Must be convertible to a BigDecimal.

Renvoie

BigDecimal The quotient.

Exceptions

MathException

If the divisor is not a valid decimal number, or is zero.

Références DivisionByZeroException\divisionByZero(), Calculator\get(), BigDecimal\of(), et BigDecimal\valueWithMinScale().

quotientAndRemainder()

quotientAndRemainder

(

$that

)

Returns the quotient and remainder of the division of this number by the given one.

The quotient has a scale of 0, and the remainder has a scale of max($this->scale, $that->scale).

Paramètres

BigNumber | int | float | string

$that

The divisor. Must be convertible to a BigDecimal.

Renvoie

BigDecimal[] An array containing the quotient and the remainder.

Exceptions

MathException

If the divisor is not a valid decimal number, or is zero.

Références BigDecimal\$scale, DivisionByZeroException\divisionByZero(), Calculator\get(), BigDecimal\of(), et BigDecimal\valueWithMinScale().

remainder()

remainder

(

$that

)

Returns the remainder of the division of this number by this given one.

The remainder has a scale of max($this->scale, $that->scale).

Paramètres

BigNumber | int | float | string

$that

The divisor. Must be convertible to a BigDecimal.

Renvoie

BigDecimal The remainder.

Exceptions

MathException

If the divisor is not a valid decimal number, or is zero.

Références BigDecimal\$scale, DivisionByZeroException\divisionByZero(), Calculator\get(), BigDecimal\of(), et BigDecimal\valueWithMinScale().

scaleValues()

scaleValues ( BigDecimal  $x, BigDecimal  $y  )

private

Puts the internal values of the given decimal numbers on the same scale.

Paramètres

BigDecimal	$x	The first decimal number.
BigDecimal	$y	The second decimal number.

Renvoie

array{0: string, 1: string} The scaled integer values of $x and $y.

Références $b, et elseif.

Référencé par BigDecimal\compareTo(), BigDecimal\exactlyDividedBy(), BigDecimal\minus(), et BigDecimal\plus().

serialize()

serialize

(

)

This method is required by interface Serializable and SHOULD NOT be accessed directly.

Références BigDecimal\$scale, et value.

sqrt()

sqrt

(

int

$scale

)

Returns the square root of this number, rounded down to the given number of decimals.

Paramètres

int

$scale

Renvoie

BigDecimal

Exceptions

Références BigDecimal\$scale, BigDecimal\$value, elseif, Calculator\get(), et value.

stripTrailingZeros()

stripTrailingZeros

(

)

Returns a copy of this BigDecimal with any trailing zeros removed from the fractional part.

Renvoie

BigDecimal

Références BigDecimal\$scale, $this, BigDecimal\$value, value, et BigDecimal\zero().

ten()

static ten ( )

static

Returns a BigDecimal representing ten, with a scale of zero.

Renvoie

BigDecimal

-pure

-suppress ImpureStaticVariable

Références null.

toBigDecimal()

toBigDecimal

(

)

{}

Références $this.

Référencé par BigRational\toBigDecimal(), et BigRational\toScale().

toBigInteger()

toBigInteger

(

)

{}

Références $this, BigNumber\create(), et BigDecimal\dividedBy().

Référencé par BigDecimal\toInt().

toBigRational()

toBigRational

(

)

{}

Références BigNumber\create(), et value.

toFloat()

toFloat

(

)

{}

Références $this.

toInt()

toInt

(

)

{}

Références BigDecimal\toBigInteger().

toScale()

toScale	(	int	$scale,
		int	$roundingMode = RoundingMode::UNNECESSARY
	)

{}

Références BigDecimal\$scale, $this, BigDecimal\dividedBy(), et BigDecimal\one().

unserialize()

unserialize

(

$value

)

This method is only here to implement interface Serializable and cannot be accessed directly.

Références BigDecimal\$scale, BigDecimal\$value, et value.

valueWithMinScale()

valueWithMinScale ( int  $scale )

private

Paramètres

int

$scale

Renvoie

string

Références BigDecimal\$scale, BigDecimal\$value, et value.

Référencé par BigDecimal\dividedBy(), BigDecimal\quotient(), BigDecimal\quotientAndRemainder(), et BigDecimal\remainder().

withPointMovedLeft()

withPointMovedLeft

(

int

$n

)

Returns a copy of this BigDecimal with the decimal point moved $n places to the left.

Paramètres

int

$n

Renvoie

BigDecimal

Références $n, $this, value, et BigDecimal\withPointMovedRight().

Référencé par BigDecimal\withPointMovedRight().

withPointMovedRight()

withPointMovedRight

(

int

$n

)

Returns a copy of this BigDecimal with the decimal point moved $n places to the right.

Paramètres

int

$n

Renvoie

BigDecimal

Références $n, BigDecimal\$scale, $this, BigDecimal\$value, et BigDecimal\withPointMovedLeft().

Référencé par BigDecimal\withPointMovedLeft().

zero()

static zero ( )

static

Returns a BigDecimal representing zero, with a scale of zero.

Renvoie

BigDecimal

-pure

-suppress ImpureStaticVariable

Références null.

Référencé par BigDecimal\stripTrailingZeros().

Documentation des champs

$scale

$scale

private

Référencé par BigDecimal\__construct(), BigDecimal\dividedBy(), BigDecimal\exactlyDividedBy(), BigDecimal\getScale(), BigDecimal\minus(), BigDecimal\multipliedBy(), BigDecimal\ofUnscaledValue(), BigDecimal\plus(), BigDecimal\quotientAndRemainder(), BigDecimal\remainder(), BigDecimal\serialize(), BigDecimal\sqrt(), BigDecimal\stripTrailingZeros(), BigDecimal\toScale(), BigDecimal\unserialize(), BigDecimal\valueWithMinScale(), et BigDecimal\withPointMovedRight().

$value

$value

private

Référencé par BigDecimal\__construct(), BigDecimal\__toString(), BigDecimal\getFractionalPart(), BigDecimal\getIntegralPart(), BigDecimal\getUnscaledValueWithLeadingZeros(), BigDecimal\minus(), BigDecimal\multipliedBy(), BigDecimal\of(), BigDecimal\ofUnscaledValue(), BigDecimal\plus(), BigDecimal\sqrt(), BigDecimal\stripTrailingZeros(), BigDecimal\unserialize(), BigDecimal\valueWithMinScale(), et BigDecimal\withPointMovedRight().

---

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

• BigDecimal.php