Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Référence de la classe RoundingMode

Champs de données

const UNNECESSARY = 0
 
const UP = 1
 
const DOWN = 2
 
const CEILING = 3
 
const FLOOR = 4
 
const HALF_UP = 5
 
const HALF_DOWN = 6
 
const HALF_CEILING = 7
 
const HALF_FLOOR = 8
 
const HALF_EVEN = 9
 

Fonctions membres privées

 __construct ()
 

Description détaillée

Specifies a rounding behavior for numerical operations capable of discarding precision.

Each rounding mode indicates how the least significant returned digit of a rounded result is to be calculated. If fewer digits are returned than the digits needed to represent the exact numerical result, the discarded digits will be referred to as the discarded fraction regardless the digits' contribution to the value of the number. In other words, considered as a numerical value, the discarded fraction could have an absolute value greater than one.

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( )
private

Private constructor. This class is not instantiable.

Documentation des champs

◆ CEILING

const CEILING = 3

Rounds towards positive infinity.

If the result is positive, behaves as for UP; if negative, behaves as for DOWN. Note that this rounding mode never decreases the calculated value.

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

◆ DOWN

const DOWN = 2

Rounds towards zero.

Never increments the digit prior to a discarded fraction (i.e., truncates). Note that this rounding mode never increases the magnitude of the calculated value.

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

◆ FLOOR

const FLOOR = 4

Rounds towards negative infinity.

If the result is positive, behave as for DOWN; if negative, behave as for UP. Note that this rounding mode never increases the calculated value.

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

◆ HALF_CEILING

const HALF_CEILING = 7

Rounds towards "nearest neighbor" unless both neighbors are equidistant, in which case round towards positive infinity.

If the result is positive, behaves as for HALF_UP; if negative, behaves as for HALF_DOWN.

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

◆ HALF_DOWN

const HALF_DOWN = 6

Rounds towards "nearest neighbor" unless both neighbors are equidistant, in which case round down.

Behaves as for UP if the discarded fraction is > 0.5; otherwise, behaves as for DOWN.

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

◆ HALF_EVEN

const HALF_EVEN = 9

Rounds towards the "nearest neighbor" unless both neighbors are equidistant, in which case rounds towards the even neighbor.

Behaves as for HALF_UP if the digit to the left of the discarded fraction is odd; behaves as for HALF_DOWN if it's even.

Note that this is the rounding mode that statistically minimizes cumulative error when applied repeatedly over a sequence of calculations. It is sometimes known as "Banker's rounding", and is chiefly used in the USA.

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

◆ HALF_FLOOR

const HALF_FLOOR = 8

Rounds towards "nearest neighbor" unless both neighbors are equidistant, in which case round towards negative infinity.

If the result is positive, behaves as for HALF_DOWN; if negative, behaves as for HALF_UP.

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

◆ HALF_UP

const HALF_UP = 5

Rounds towards "nearest neighbor" unless both neighbors are equidistant, in which case round up.

Behaves as for UP if the discarded fraction is >= 0.5; otherwise, behaves as for DOWN. Note that this is the rounding mode commonly taught at school.

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

◆ UNNECESSARY

const UNNECESSARY = 0

Asserts that the requested operation has an exact result, hence no rounding is necessary.

If this rounding mode is specified on an operation that yields a result that cannot be represented at the requested scale, a RoundingNecessaryException is thrown.

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

◆ UP

const UP = 1

Rounds away from zero.

Always increments the digit prior to a nonzero discarded fraction. Note that this rounding mode never decreases the magnitude of the calculated value.

Référencé par Calculator\divRound(), et BigInteger\shiftedRight().


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