Référence de la classe BigRational

Graphe d'héritage de BigRational:

Fonctions membres publiques
	getNumerator ()
	getDenominator ()
	quotient ()
	remainder ()
	quotientAndRemainder ()
	plus ($that)
	minus ($that)
	multipliedBy ($that)
	dividedBy ($that)
	power (int $exponent)
	reciprocal ()
	abs ()
	negated ()
	simplified ()
	compareTo ($that)
	getSign ()
	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	nd ($numerator, $denominator)
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 (BigInteger $numerator, BigInteger $denominator, bool $checkDenominator)

Attributs privés
	$numerator
	$denominator

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

Description détaillée

An arbitrarily large rational number.

This class is immutable.

-immutable

Documentation des constructeurs et destructeur

__construct()

__construct ( BigInteger  $numerator, BigInteger  $denominator, bool  $checkDenominator  )

protected

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

Paramètres

BigInteger	$numerator	The numerator.
BigInteger	$denominator	The denominator.
bool	$checkDenominator	Whether to check the denominator for negative and zero.

Exceptions

DivisionByZeroException

If the denominator is zero.

Références BigRational\$denominator, BigRational\$numerator, et DivisionByZeroException\denominatorMustNotBeZero().

Documentation des fonctions membres

__toString()

__toString

(

)

{}

Références BigRational\$denominator, et BigRational\$numerator.

abs()

abs

(

)

Returns the absolute value of this BigRational.

Renvoie

BigRational

Références BigRational\$denominator.

compareTo()

compareTo

(

$that

)

{}

Références BigRational\minus().

dividedBy()

dividedBy

(

$that

)

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

Paramètres

BigNumber | int | float | string

$that

The divisor.

Renvoie

BigRational The result.

Exceptions

MathException

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

Références BigRational\$denominator, BigRational\$numerator, et BigRational\of().

getDenominator()

getDenominator

(

)

Renvoie

BigInteger

Références BigRational\$denominator.

getNumerator()

getNumerator

(

)

Renvoie

BigInteger

Références BigRational\$numerator.

getSign()

getSign

(

)

{}

minus()

minus

(

$that

)

Returns the difference of this number and the given one.

Paramètres

BigNumber | int | float | string

$that

The number to subtract.

Renvoie

BigRational The result.

Exceptions

MathException

If the number is not valid.

Références BigRational\$denominator, BigRational\$numerator, $this, et BigRational\of().

Référencé par BigRational\compareTo().

multipliedBy()

multipliedBy

(

$that

)

Returns the product of this number and the given one.

Paramètres

BigNumber | int | float | string

$that

The multiplier.

Renvoie

BigRational The result.

Exceptions

MathException

If the multiplier is not a valid number.

Références BigRational\$denominator, BigRational\$numerator, et BigRational\of().

nd()

static nd (   $numerator,   $denominator  )

static

Creates a BigRational out of a numerator and a denominator.

If the denominator is negative, the signs of both the numerator and the denominator will be inverted to ensure that the denominator is always positive.

Paramètres

BigNumber | int | float | string	$numerator	The numerator. Must be convertible to a BigInteger.
BigNumber | int | float | string	$denominator	The denominator. Must be convertible to a BigInteger.

Renvoie

BigRational

Exceptions

NumberFormatException	If an argument does not represent a valid number.
RoundingNecessaryException	If an argument represents a non-integer number.
DivisionByZeroException	If the denominator is zero.

-pure

Références BigRational\$denominator, BigRational\$numerator, et BigInteger\of().

negated()

negated

(

)

Returns the negated value of this BigRational.

Renvoie

BigRational

Références BigRational\$denominator.

of()

static of (   $value )

static

Creates a BigRational of the given value.

Paramètres

BigNumber | int | float | string

$value

Renvoie

BigRational

Exceptions

MathException

If the value cannot be converted to a BigRational.

-pure

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

Référencé par BigRational\dividedBy(), BigRational\minus(), BigRational\multipliedBy(), et BigRational\plus().

one()

static one ( )

static

Returns a BigRational representing one.

Renvoie

BigRational

-pure

-suppress ImpureStaticVariable

Références null, et BigInteger\one().

plus()

plus

(

$that

)

Returns the sum of this number and the given one.

Paramètres

BigNumber | int | float | string

$that

The number to add.

Renvoie

BigRational The result.

Exceptions

MathException

If the number is not valid.

Références BigRational\$denominator, BigRational\$numerator, $this, et BigRational\of().

power()

power

(

int

$exponent

)

Returns this number exponentiated to the given value.

Paramètres

int

$exponent

The exponent.

Renvoie

BigRational The result.

Exceptions

Références $this, false, et BigInteger\one().

quotient()

quotient

(

)

Returns the quotient of the division of the numerator by the denominator.

Renvoie

BigInteger

quotientAndRemainder()

quotientAndRemainder

(

)

Returns the quotient and remainder of the division of the numerator by the denominator.

Renvoie

BigInteger[]

reciprocal()

reciprocal

(

)

Returns the reciprocal of this BigRational.

The reciprocal has the numerator and denominator swapped.

Renvoie

BigRational

Exceptions

DivisionByZeroException

If the numerator is zero.

remainder()

remainder

(

)

Returns the remainder of the division of the numerator by the denominator.

Renvoie

BigInteger

serialize()

serialize

(

)

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

Références BigRational\$denominator.

simplified()

simplified

(

)

Returns the simplified value of this BigRational.

Renvoie

BigRational

Références BigRational\$denominator, et BigRational\$numerator.

Référencé par BigRational\toBigInteger().

ten()

static ten ( )

static

Returns a BigRational representing ten.

Renvoie

BigRational

-pure

-suppress ImpureStaticVariable

Références null, BigInteger\one(), et BigInteger\ten().

toBigDecimal()

toBigDecimal

(

)

{}

Références BigDecimal\toBigDecimal().

toBigInteger()

toBigInteger

(

)

{}

Références BigRational\simplified().

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

toBigRational()

toBigRational

(

)

{}

Références $this.

toFloat()

toFloat

(

)

{}

toInt()

toInt

(

)

{}

Références BigRational\toBigInteger().

toScale()

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

{}

Références BigDecimal\toBigDecimal().

unserialize()

unserialize

(

$value

)

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

Références BigRational\$denominator, BigRational\$numerator, $value, et BigInteger\of().

zero()

static zero ( )

static

Returns a BigRational representing zero.

Renvoie

BigRational

-pure

-suppress ImpureStaticVariable

Références null, BigInteger\one(), et BigInteger\zero().

Documentation des champs

$denominator

$denominator

private

Référencé par BigRational\__construct(), BigRational\__toString(), BigRational\abs(), BigRational\dividedBy(), BigRational\getDenominator(), BigRational\minus(), BigRational\multipliedBy(), BigRational\nd(), BigRational\negated(), BigRational\plus(), BigRational\serialize(), BigRational\simplified(), et BigRational\unserialize().

$numerator

$numerator

private

Référencé par BigRational\__construct(), BigRational\__toString(), BigRational\dividedBy(), BigRational\getNumerator(), BigRational\minus(), BigRational\multipliedBy(), BigRational\nd(), BigRational\plus(), BigRational\simplified(), et BigRational\unserialize().

---

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

• BigRational.php