BirtMath

Clase BirtMath

La clase BirtMath proporciona funciones para manipular datos numéricos, por ejemplo, para sumar, restar, dividir, multiplicar, y redondear números.

BirtMath.add

Esta función devuelve la suma de dos números.

Sintaxis

BirtMath.add (n1, n2)

Parámetros

n1 - El primer número a utilizar en el cálculo.

n2 - El segundo número a utilizar en el cálculo.

Devoluciones

Un número que resulte de sumar n1 y n2.

Ejemplo

El ejemplo siguiente devuelve la suma de los valores en los campos SalesTotal y Shipping:

BirtMath.add( row["SalesTotal"], row["Shipping"] )

BirtMath.ceiling

Esta función redondea un número hacia arriba, alejado de 0, al múltiplo más cercano especificado.

Sintaxis

BirtMath.ceiling (n, importancia)

Parámetros

n - El número a redondear al alza.

importancia - Los múltiplos para redondear n.

Devoluciones

Un número que resulta del redondeo. Si n es un múltiplo exacto de importancia, no se redondea.

Ejemplos

BirtMath.ceiling ()

Se utiliza comúnmente para redondear al alza los precios.

BirtMath.ceiling (row ["precio"], 0,05)

Si el valor del precio es 20.52, la expresión devuelve 20.55.

BirtMath.ceiling (row ["precio"], 0,1)

Si el valor del precio es 20.52, la expresión devuelve 20.60. Si el valor del precio es 20.40, la expresión devuelve 20.40. No hay redondeo se debe a que 20,40 es un múltiplo de 0,1.

BirtMath.ceiling (row ["precio"], 1)

Si el valor del precio es 20.30, la expresión devuelve 21.

BirtMath.divide

Esta función devuelve el resultado de dividir un número por otro.

Sintaxis

BirtMath.divide (dividendo, divisor)

Parámetros

dividendos - El número que se divide.

divisor - El número por el cual los dividendos se dividen.

Devoluciones

Un número que resulte de dividir dividendo por el divisor.

Ejemplos

El siguiente ejemplo muestra el resultado de dividir un número específico:

BirtMath.divide (10, 2) // devuelve 5
BirtMath.divide (2, 10) // devuelve 0.2

El ejemplo siguiente devuelve el resultado de dividir los valores del campo total de valores en el campo Cantidad:

BirtMath.divide (row ["total"], row ["Cantidad"])

BirtMath.mod

Esta función devuelve el resto después de dividir un número por un divisor.

Sintaxis

BirtMath.mod (número, divisor)

Parámetros

número - El número que se divide.

divisor - El número por el cual el primer número está dividido. Debe especificar un número distinto de cero.

Devoluciones

El resto después de dividir un número por el divisor.

Ejemplos

Los siguientes ejemplos muestran los resultados que devuelve la función de números específicos:

BirtMath.mod (10, 3) // devuelve 1
BirtMath.mod (10, 5) // devuelve 0
BirtMath.mod (10, 6) // devuelve 4

El siguiente ejemplo comprueba si los números en el campo de grado son pares o impares. Cuando el divisor es 2, la función devuelve 0 para los números pares, y 1 para números impares.

BirtMath.mod (row ["Grado"], 2)

BirtMath.multiply

Esta función devuelve la multiplicación de dos números.

Sintaxis

BirtMath.multiply (n1, n2)

Parámetros

n1 - El primer número a utilizar en el cálculo.

n2 - El segundo número a utilizar en el cálculo.

Devoluciones

Un número que resulte de multiplicar n1 y n2.

Ejemplo

En el ejemplo siguiente se devuelve el resultado de multiplicar los valores en los campos QuantityOrdered y PriceEach:

BirtMath.multiply (row ["QuantityOrdered"], row ["PriceEach"])

BirtMath.round

Esta función redondea un número a un número determinado de dígitos.

Sintaxis

BirtMath.round (número, dec)

Parámetros

número - El número para el redondeo.

dec - El número de dígitos de redondeo para todo el número. Si se omite este argumento, la función supone 0.

Devoluciones

Un número redondeado a un número determinado de dígitos.

Ejemplos

Los siguientes ejemplos muestran los resultados que devuelve la función de números específicos:

BirtMath.round (1.545,50) // devuelve 1546
BirtMath.round (1545,56, 1) // devuelve 1545.6
BirtMath.round (1545,23, 1) // devuelve 1545.2
BirtMath.round (1.545,50, -1) // devuelve 1550

Las rondas siguiente ejemplo los valores en el campo PriceEstimate para devolver un número entero:

BirtMath.round (row ["PriceEstimate"], 0)

BirtMath.roundDown

Esta función redondea un número a un número determinado de dígitos.

Sintaxis

BirtMath.roundDown (número, dec)

Parámetros

número - El número para el redondeo.

dec - El número de dígitos de redondeo para todo el número. Si se omite este argumento, la función supone 0.

Devoluciones

Un número redondeado a un número determinado de dígitos.

Ejemplos

Los siguientes ejemplos muestran los resultados que devuelve la función de números específicos:

BirtMath.roundDown (1.545,50) // devuelve 1545
BirtMath.roundDown (1545,56, 1) // devuelve 1545.5
BirtMath.roundDown (1545,23, 1) // devuelve 1545.2
BirtMath.roundDown (1.545,50, -1) // devuelve 1540

Las rondas de ejemplo siguiente se establecen los valores en el campo PriceEstimate para devolver un número entero:

BirtMath.roundDown (row ["PriceEstimate"], 0)

BirtMath.roundUp

Esta función redondea un número hasta un número determinado de dígitos.

Sintaxis

BirtMath.roundUp (número, dec)

Parámetros

número - El número para el redondeo.

dec - El número de dígitos de redondeo para todo el número. Si se omite este argumento, la función supone 0.

Devoluciones

Un número redondeado a un número determinado de dígitos.

Ejemplos

Los siguientes ejemplos muestran los resultados que devuelve la función de números específicos:

BirtMath.roundUp (1.545,50) // devuelve 1546
BirtMath.roundUp (1545,56, 1) // devuelve 1545.6
BirtMath.roundUp (1545,23, 1) // devuelve 1545.3
BirtMath.roundUp (1.545,50, -1) // devuelve 1550

Las rondas de ejemplo el seguimiento de los valores en el campo PriceEstimate para devolver un número entero:

BirtMath.roundUp (row ["PriceEstimate"], 0)

BirtMath.safeDivide

Esta función devuelve el resultado de dividir un número por otro, evitar una división por cero condición.

Sintaxis

BirtMath.safeDivide (dividendo, divisor, ifZero)

Parámetros

dividendos - El número que se divide.

divisor - El número por el cual los dividendos se dividen.

ifZero - El valor que se devolverá cuando el divisor es cero.

Devoluciones

Un número que resulte de dividir dividendo por el divisor.

Ejemplos

El siguiente ejemplo muestra los resultados que devuelve la función de números específicos:

BirtMath.safeDivide (10, 2, 0) // devuelve 5
BirtMath.safeDivide (10, 0, 0) // devuelve 0

En el ejemplo siguiente se devuelve el resultado de dividir los valores en el ámbito de los ingresos por valores en el campo de volumen. Si el valor de volumen es 0, la función devuelve 0.

BirtMath.safeDivide (row ["Ingresos"], row ["Volumen"], 0)

BirtMath.subtract

Esta función devuelve el resultado de restar un número de otro.

Sintaxis

BirtMath.subtract (n1, n2)

Parámetros

n1 - El número de los que a restar.

n2 - El número a restar de n1.

Devoluciones

Un número que resulta de restar n2 de n1.

Ejemplo

El siguiente ejemplo muestra los resultados de restar números específicos:

BirtMath.subtract (12, 4) // devuelve 8
BirtMath.subtract (4, 12) // devuelve -8

En el ejemplo siguiente se devuelve el resultado de restar descuento del total:

BirtMath.subtract (row ["total"], row ["Descuento"])