Назад Далее

Класс BirtMath

Класс BirtMath предоставляет функции для работы с числовыми данными, например, для сложения, вычитания, умножения, деления и округления чисел. Число - это базовый объект, который можно преобразовать в другой тип в поле Тип данных в окне Изменить связывание данных. Это статический класс. Приложения не могут создавать экземпляры данного класса.

BirtMath.add

Эта функция возвращает сумму двух чисел.

Синтаксис

Number BirtMath.add( Number n1, Number n2 )

Параметры

n1

Числовой объект. Первое число, используемое при вычислении.

n2

Второе число, используемое при вычислении.

Возвращает

Числовой объект. Число, полученное в результате сложения n1 и n2.

Пример

В следующем примере возвращается сумма значений в полях SalesTotal и Shipping:

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

BirtMath.ceiling

Эта функция округляет число в большую сторону, от 0 до ближайшего указанного кратного числа.

Синтаксис

Number BirtMath.ceiling( Number n, Number significance )

Параметры

n

Числовой объект. Число, которое требуется округлить в большую сторону.

significance

Числовой объект. Значимость. Кратное до которого требуется округлить n.

Возвращает

Числовой объект. Число, полученное в результате округления. Если n является числом, кратным значимости, округление не выполняется.

Примеры

BirtMath.ceiling( ) широко используется для округления цен в большую сторону. Например, для того чтобы не оперировать одноцентовыми монетами, можно округлять цены в поле Price (цена) до ближайшего значения, кратного пяти центам, используя следующее выражение:

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

Если значение поля Price равно 20,52, выражение возвращает 20,55.

В следующем выражении цены округляются в большую сторону до ближайшего значения, кратного десяти центам:

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

Если значение поля Price равно 20,52, выражение возвращает 20,60. Если значение поля Price равно 20,40, выражение возвращает 20,40. Округление не выполняется, поскольку значение 20,40 кратно 0,1.

В следующем выражении цены округляются в большую сторону до ближайшего значения, кратного одному доллару:

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

Если значение поля Price равно 20,30, выражение возвращает 21.

BirtMath.divide

Эта функция возвращает результат деления одного числа на другое.

Синтаксис

Number BirtMath.divide( Number dividend, Number divisor )

Параметры

dividend

Числовой объект. Делимое. Число, которое требуется разделить.

divisor

Числовой объект. Делитель. Число, на которое требуется разделить делимое.

Возвращает

Числовой объект. Число, полученное в результате деления dividend на divisor.

Примеры

В следующем примере показаны результаты деления определенных чисел:

BirtMath.divide( 10, 2 ) // возвращает 5
BirtMath.divide( 2, 10) // возвращает 0,2

В следующем примере возвращается результат деления значений в поле Total (всего) на значения в поле Quantity (количество):

BirtMath.divide( row["Total"], row["Quantity"] )

BirtMath.mod

Эта функция возвращает остаток, полученный при делении числа на делитель.

Синтаксис

Number BirtMath.mod( Number number, Number divisor )

Параметры

number

Числовой объект. Делимое. Число, которое требуется разделить.

divisor

Числовой объект. Число, на которое требуется разделить первое число. Указанное число не должно быть нулем.

Возвращает

Остаток, полученный после деления number на divisor.

Примеры

В следующих примерах показаны результаты, возвращаемые функцией для определенных чисел:

BirtMath.mod( 10, 3 ) // возвращает 1
BirtMath.mod( 10, 5 ) // возвращает 0
BirtMath.mod( 10, 6 ) // возвращает 4

В следующем примере выполняется проверка, являются ли числа в поле Grade нечетными или четными. Если делитель равен 2, функция возвращает 0 для четных чисел и 1 для нечетных чисел.

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

BirtMath.multiply

Эта функция возвращает произведение двух чисел.

Синтаксис

Number BirtMath.multiply( Number n1, Number n2 )

Параметры

n1

Числовой объект. Первое число, используемое при вычислении.

n2

Числовой объект. Второе число, используемое при вычислении.

Возвращает

Числовой объект. Число, полученное в результате умножения n1 на n2.

Пример

В следующем примере возвращается результат произведения значений в полях QuantityOrdered и PriceEach:

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

BirtMath.round

Эта функция округляет число до указанного количества знаков.

Синтаксис

Number BirtMath.round( Number number, Number dec )

Параметры

number

Числовой объект. Число, которое требуется округлить.

dec

Числовой объект. Число десятичных знаков после запятой, до которого требуется округлить число. Если этот параметр не задан, функция использует значение 0.

Возвращает

Числовой объект. Число, округленное до указанного количества знаков после запятой.

Примеры

В следующих примерах показаны результаты, возвращаемые функцией для определенных чисел:

BirtMath.round( 1545,50 ) // возвращает 1546
BirtMath.round( 1545,56, 1 ) // возвращает 1545,6
BirtMath.round( 1545,23, 1 ) // возвращает 1545,2
BirtMath.round( 1545,50, -1 ) // возвращает 1550

В следующем примере округляются значения в поле PriceEstimate и возвращается целое число:

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

BirtMath.roundDown

Эта функция округляет число в меньшую сторону до указанного количества знаков.

Синтаксис

Number BirtMath.roundDown( Number number, Number dec )

Параметры

number

Числовой объект. Число, которое требуется округлить.

dec

Числовой объект. Число десятичных знаков после запятой, до которого требуется округлить число в меньшую сторону. Если этот параметр не задан, функция использует значение 0.

Возвращает

Числовой объект. Число, округленное в меньшую сторону до указанного количества знаков после запятой.

Примеры

В следующих примерах показаны результаты, возвращаемые функцией для определенных чисел:

BirtMath.roundDown( 1545,50 ) // возвращает 1545
BirtMath.roundDown( 1545,56, 1 ) // возвращает 1545,5
BirtMath.roundDown( 1545,23, 1 ) // возвращает 1545,2
BirtMath.roundDown( 1545,50, -1 ) // возвращает 1540

В следующем примере округляются в меньшую сторону значения в поле PriceEstimate и возвращается целое число:

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

BirtMath.roundUp

Эта функция округляет число в большую сторону до указанного количества знаков.

Синтаксис

Number BirtMath.roundUp( Number number, Number dec )

Параметры

number

Числовой объект. Число, которое требуется округлить в большую сторону.

dec

Числовой объект. Число десятичных знаков после запятой, до которого требуется округлить число в большую сторону. Если этот параметр не задан, функция использует значение 0.

Возвращает

Числовой объект. Число, округленное в большую сторону до указанного количества знаков после запятой.

Примеры

В следующих примерах показаны результаты, возвращаемые функцией для определенных чисел:

BirtMath.roundUp( 1545,50 ) // возвращает 1546
BirtMath.roundUp( 1545,56, 1 ) // возвращает 1545,6
BirtMath.roundUp( 1545,23, 1 ) // возвращает 1545,3
BirtMath.roundUp( 1545,50, -1 ) // возвращает 1550

В следующем примере округляются в большую сторону значения в поле PriceEstimate и возвращается целое число:

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

BirtMath.safeDivide

Эта функция возвращает результат деления одного числа на другое, не допуская деления на ноль.

Синтаксис

Number BirtMath.safeDivide( Number dividend, Number divisor, object ifZero )

Параметры

dividend

Числовой объект. Делимое. Число, которое требуется разделить.

divisor

Числовой объект. Делитель. Число, на которое требуется разделить делимое.

ifZero

Object. Значение, которое требуется возвратить, если делитель равен нулю.

Возвращает

Числовой объект. Числовой объект. Число, полученное в результате деления dividend на divisor.

Примеры

В следующем примере показаны результаты, возвращаемые функцией для определенных чисел:

BirtMath.safeDivide( 10, 2, 0 ) // возвращает 5
BirtMath.safeDivide( 10, 0, 0 ) // возвращает 0

В следующем примере возвращается результат деления значений в поле Revenue (доход) на значения в поле Volume (объем). Если значение поля Volume равно 0, функция возвращает 0.

BirtMath.safeDivide( row["Revenue"], row["Volume"], 0 )

BirtMath.subtract

Эта функция возвращает результат вычитания одного числа из другого.

Синтаксис

Number BirtMath.subtract( Number n1, Number n2 )

Параметры

n1

Числовой объект. Число, из которого выполняется вычитание.

n2

Числовой объект. Число, которое требуется вычесть из n1.

Возвращает

Числовой объект. Число, полученное в результате вычитания n2 из n1.

Пример

В следующем примере показаны результаты вычитания, выполняемого с определенными числами:

BirtMath.subtract( 12, 4 ) // возвращает 8
BirtMath.subtract( 4, 12) // возвращает -8

В следующем примере возвращается результат вычитания значений в поле Discount (скидка) из значений в поле Total (всего):

BirtMath.subtract( row["Total"], row["Discount"] )

(c) Copyright Actuate Corporation 2013