Thème "Mathématiques et nombres"

   Ensemble des méthodes et macros disponibles dans le thème "Nombres".

BigDecimal divide(Object dividend, Object divisor)

Divise un nombre par un autre. La précision du résultat est à 20 décimales.

Exemple :
BigDecimal result = xtNumber.divide(2, 3);
report("Return value for the divide method (2/3) : [$1]", result); // Return value for the divide method (2/3) : [0.66666666666666666667]
try {
   result = xtNumber.divide(2, 0);    // ERROR ==> BigInteger divide by zero
} catch(ArithmeticException e) {
   report("ArithmeticException - Can't divide by 0");    // Display this message
}

Object value - Valeur à diviser.
Object divisor - Diviseur.

BigDecimal - Résultat de la division, avec une précision à 20 décimales.

ArithmeticException - Si le diviseur est 0.

1.0

BigDecimal divide(Object dividend, Object divisor, int scale)

Divise un nombre par un autre. Il est possible de spécifier la précision du résultat souhaité.
Exemple :
BigDecimal result = xtNumber.divide(2, 3, 5);
report("Return value for the divide method (2/3) : [$1]", result); // Return value for the divide method (2/3) : [0.66667]
try {
   result = xtNumber.divide(2, 0, 5);    // ERROR ==> BigInteger divide by zero
} catch(ArithmeticException e) {
   report("ArithmeticException - Can't divide by 0");    // Display this message
}

Object value - Valeur à diviser.
Object divisor - Diviseur.
int scale - Précision du résultat. La précision minimale est 0 (si on spécifie une valeur négative, la précision est forcée à 0).

BigDecimal - Résultat de la division, avec la précision demandée.

ArithmeticException - Si le diviseur est 0.

1.0

boolean isInteger(Object value)

Teste si un objet est un entier. Dans le cas où on souhaite tester une chaîne de caractères, celle-ci doit respecter le format suivant :
   - Aucun caractère espace.
   - Aucun séparateur de milliers.
   - Le séparateur de décimales doit être le caractère point.
   - Le caractère "e", en majuscule ou minuscule, peut être utilisé pour signifier un exposant (facultatif).

Exemple :
report("1 is an integer ? [$1]", xtNumber.isInteger(1));    // True
report("1.0 is an integer ? [$1]", xtNumber.isInteger(1.0));    // True
report("1.5 is an integer ? [$1]", xtNumber.isInteger(1.5));    // False
report("1.0 is an integer ? [$1]", xtNumber.isInteger("1.0"));    // True
report("1,0 is an integer ? [$1]", xtNumber.isInteger("1,0"));    // False
report(" 1.0 is an integer ? [$1]", xtNumber.isInteger(" 1.0"));    // False, value with space
report("1000.0 is an integer ? [$1]", xtNumber.isInteger("1000.0"));    // True
report("1,000.0 is an integer ? [$1]", xtNumber.isInteger("1,000.0"));    //False

Object value - Objet à tester.

boolean - Vrai (true), si l'objet est un entier.

1.0

boolean isNumber(Object value)

Teste si un objet est un nombre. Dans le cas où on souhaite tester une chaîne de caractères, celle-ci doit respecter le format suivant :
   - Aucun caractère espace.
   - Aucun séparateur de milliers.
   - Le séparateur de décimales doit être le caractère point.
   - Le caractère "e", en majuscule ou minuscule, peut être utilisé pour signifier un exposant (facultatif).

Exemple :
report("1 is an integer ? [$1]", xtNumber.isNumber(1));    // True
report("1.0 is an integer ? [$1]", xtNumber.isNumber(1.0));    // True
report("1.5 is an integer ? [$1]", xtNumber.isNumber(1.5));    // True
report("1.5 is a number ? [$1]", xtNumber.isNumber("1.5"));    // True
report(" 1.5 is a number ? [$1]", xtNumber.isNumber(" 1.5"));    // False, value with space
report("1,5 is a number ? [$1]", xtNumber.isNumber("1,5"));    //False
report("1000 is a number ? [$1]", xtNumber.isNumber("1000"));    // True
report("1,000 is a number ? [$1]", xtNumber.isNumber("1,000"));    // False

Object value - Objet à tester.

boolean - Vrai (true), si l'objet est un nombre.

1.0

BigDecimal multiply(Object value, Object multiplicand, Object... otherMultiplicand)

Retourne un BigDecimal dont la valeur est le résultat de la multiplication (value * multiplicand). Il est possible de spécifier un nombre indéterminé d'autres multiplicateurs (optionnel).

Exemple
BigDecimal multiplyResult = xtNumber.multiply(2, 3);
report("Return value for the multiply method (2*3) : [$1]", multiplyResult); // Return value for the multiply method (2*3) : [6]
multiplyResult = xtNumber.multiply(2, 3, 4, 5, 6);
report("Return value for the multiply method (2*3*4*5*6) : [$1]", multiplyResult);    // Return value for the multiply method (2*3*4*5*6) : [720]

Object value - Valeur de départ.
Object multiplicand - Multiplicateur.
Object... otherMultiplicand - Autres multiplicateurs (optionnel).

BigDecimal - Valeur calculée.

1.0

BigDecimal multiply(Object value, int scale)

Retourne un BigDecimal dont la valeur est l'arrondi de la valeur spécifiée en paramètre. Le nombre de décimales à conserver est spécifié dans le paramètre scale.

Exemple :
report("Rounded value (2/3) : [$1]", xtNumber.round(xtNumber.divide(2, 3), 2));    // Rounded value (2/3) : [0.67]

Object value - Valeur à arrondir.
int scale - Nombre de décimales à conserver.

BigDecimal - Valeur arrondie.

1.0

BigDecimal subtract(Object value, Object subtrahend, Object... otherSubtrahend)

Retourne un BigDecimal dont la valeur est le résultat de la soustraction (value - subtrahend). Il est possible de spécifier un nombre indéterminé d'autres diminuteurs (optionnel).

Exemple :
BigDecimal substractResult = xtNumber.subtract(10, 1);
report("Return value for the subtract method (10-1) : [$1]", substractResult); // Return value for the subtract method (10-1) : [9]
substractResult = xtNumber.subtract(10, 1, 2, 3, 4, 5);
report("Return value for the subtract method (10-1-2-3-4-5) : [$1]", substractResult);    // Return value for the subtract method (10-1-2-3-4-5) : [-5]

Object value - Valeur de départ.
Object subtrahend - diminuteur .
Object... otherSubtrahend - Autres diminuteurs (optionnel).

BigDecimal - Valeur calculée.

1.0