Poprzedni Następny

Klasa BirtMath

Klasa BirtMath udostępnia funkcje, które pozwalają na manipulowanie danymi liczbowymi, na przykład na dodawanie, odejmowanie, mnożenie, dzielenie i zaokrąglanie liczb. Liczba to ogólny obiekt, który można rzutować jako inny typ w polu Typ danych okna dialogowego Edycja powiązania danych. Jest to klasa statyczna. Aplikacja nie może tworzyć instancji klasy.

BirtMath.add

Ta funkcja zwraca sumę dwóch liczb.

Składnia

Number BirtMath.add( Number n1, Number n2 )

Parametry

n1

Obiekt Number. Pierwsza liczba do użycia w obliczeniach.

n2

Drugi składnik sumy.

Wartość zwracana

Obiekt Number. Liczba będąca wynikiem dodania liczb n1 i n2.

Przykład

Następujący przykład zwraca sumę wartości pól SprzedażŁącznie i Dostawa:

BirtMath.add( row["SprzedażŁącznie"], row["Dostawa"] )

BirtMath.ceiling

Ta funkcja służy do zaokrąglania liczby (powyżej zera) w górę do najbliższej określonej wielokrotności.

Składnia

Number BirtMath.ceiling( Number n, Number istotność )

Parametry

n

Obiekt Number. Liczba do zaokrąglenia od zera.

istotność

Obiekt Number. Wielokrotność, do której ma zostać zaokrąglona liczba n.

Wartość zwracana

Obiekt Number. Liczba będąca wynikiem zaokrąglenia. Jeśli liczba n jest dokładną wielokrotnością wartości podanej jako istotność, nie zostanie ona zaokrąglona.

Przykłady

Funkcja BirtMath.ceiling( ) jest często używana do zaokrąglania cen w górę. Aby na przykład uniknąć przeliczania wartości w pojedynczych groszach, można zaokrąglić wartość pola Cena do wielokrotności 5 gr przy użyciu następującego wyrażenia:

BirtMath.ceiling( row["Cena"] , 0.05 )

Jeśli parametr Cena ma wartość 20,52, wyrażenie zwróci wartość 20,55.

Następujące wyrażenie spowoduje zaokrąglenie cen w górę do najbliższych dziesięciu groszy:

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

Jeśli parametr Cena ma wartość 20,52, wyrażenie zwróci wartość 20,60. Jeśli parametr Cena ma wartość 20,40, wyrażenie zwróci wartość 20,40. Nie dojdzie do zaokrąglania, ponieważ liczba 20,40 jest wielokrotnością liczby 0,1.

Następujące wyrażenie spowoduje zaokrąglenie cen w górę do najbliższej złotówki:

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

Jeśli parametr Cena ma wartość 20,30, wyrażenie zwróci wartość 21.

BirtMath.divide

Ta funkcja zwraca wynik dzielenia jednej liczby przez drugą.

Składnia

Number BirtMath.divide( Number dzielna, Number dzielnik )

Parametry

dzielna

Obiekt Number. Liczba do podzielenia.

dzielnik

Obiekt Number. Liczba, przez którą zostanie podzielona dzielna.

Wartość zwracana

Obiekt Number. Liczba będąca wynikiem podzielenia dzielnej przez dzielnik.

Przykłady

Następujący przykład przedstawia wynik dzielenia konkretnych liczb:

BirtMath.divide( 10, 2 ) // zwraca 5
BirtMath.divide( 2, 10) // zwraca 0,2

Następujący przykład zwraca wynik podzielenia wartości z pola Suma przez wartości z pola Ilość:

BirtMath.divide( row["Suma"], row["Ilość"] )

BirtMath.mod

Ta funkcja zwraca resztę z dzielenia dzielnej przez dzielnik.

Składnia

Number BirtMath.mod( Number liczba, Number dzielnik )

Parametry

liczba

Obiekt Number. Liczba do podzielenia.

dzielnik

Obiekt Number. Liczba, przez którą zostanie podzielona pierwsza liczba. Należy podać liczbę inną niż zero.

Wartość zwracana

Reszta z dzielenia pierwszej liczby przez dzielnik.

Przykłady

Następujące przykłady przedstawiają wynik działania funkcji dla konkretnych liczb:

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

Następujący przykład pozwala sprawdzić, czy wartość w polu Ocena jest liczbą parzystą, czy nieparzystą. Przy dzielniku o wartości 2 funkcja zwróci 0 dla liczb parzystych i 1 dla liczb nieparzystych.

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

BirtMath.multiply

Ta funkcja zwraca iloczyn dwóch liczb.

Składnia

Number BirtMath.multiply( Number n1, Number n2 )

Parametry

n1

Obiekt Number. Pierwsza liczba do użycia w obliczeniach.

n2

Obiekt Number. Druga liczba do użycia w obliczeniach.

Wartość zwracana

Obiekt Number. Liczba będąca wynikiem pomnożenia przez siebie liczb n1 i n2.

Przykład

Następujący przykład zwraca iloczyn wartości pól IlośćZamówiona i CenaJednostkowa:

BirtMath.multiply( row["IlośćZamówiona"], row["CenaJednostkowa"] )

BirtMath.round

Ta funkcja pozwala na zaokrąglenie liczby do określonej liczby miejsc dziesiętnych.

Składnia

Number BirtMath.round( Number liczba, Number poz )

Parametry

liczba

Obiekt Number. Liczba do zaokrąglenia.

poz

Obiekt Number. Pozycja dziesiętna, do której liczba ma zostać zaokrąglona. Pominięcie tego argumentu oznacza, że zostanie przyjęta wartość 0.

Wartość zwracana

Obiekt Number. Liczba zaokrąglona do określonej liczby cyfr dziesiętnych.

Przykłady

Następujące przykłady przedstawiają wynik działania funkcji dla konkretnych liczb:

BirtMath.round( 1545.50 ) // zwraca 1546
BirtMath.round( 1545.56, 1 ) // zwraca 1545,6
BirtMath.round( 1545.23, 1 ) // zwraca 1545,2
BirtMath.round( 1545.50, -1 ) // zwraca 1550

W następującym przykładzie wartości pola CenaSzacowana zostaną zaokrąglone do liczb całkowitych:

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

BirtMath.roundDown

Ta funkcja pozwala na zaokrąglenie liczby w dół do określonej liczby miejsc dziesiętnych.

Składnia

Number BirtMath.roundDown( Number liczba, Number poz )

Parametry

liczba

Obiekt Number. Liczba do zaokrąglenia.

poz

Obiekt Number. Pozycja dziesiętna, do której liczba ma zostać zaokrąglona do zera. Pominięcie tego argumentu oznacza, że zostanie przyjęta wartość 0.

Wartość zwracana

Obiekt Number. Liczba zaokrąglona do zera do określonej liczby cyfr.

Przykłady

Następujące przykłady przedstawiają wynik działania funkcji dla konkretnych liczb:

BirtMath.roundDown( 1545.50 ) // zwraca 1545
BirtMath.roundDown( 1545.56, 1 ) // zwraca 1545,5
BirtMath.roundDown( 1545.23, 1 ) // zwraca 1545,2
BirtMath.roundDown( 1545.50, -1 ) // zwraca 1540

W następującym przykładzie wartości pola CenaSzacowana zostaną zaokrąglone do zera do liczb całkowitych:

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

BirtMath.roundUp

Ta funkcja pozwala na zaokrąglenie liczby w górę do określonej liczby miejsc dziesiętnych.

Składnia

Number BirtMath.roundUp( Number liczba, Number poz )

Parametry

liczba

Obiekt Number. Liczba do zaokrąglenia od zera.

poz

Obiekt Number. Pozycja dziesiętna, do której liczba ma zostać zaokrąglona od zera. Pominięcie tego argumentu oznacza, że zostanie przyjęta wartość 0.

Wartość zwracana

Obiekt Number. Liczba zaokrąglona od zera do określonej liczby cyfr.

Przykłady

Następujące przykłady przedstawiają wynik działania funkcji dla konkretnych liczb:

BirtMath.roundUp( 1545.50 ) // zwraca 1546
BirtMath.roundUp( 1545.56, 1 ) // zwraca 1545,6
BirtMath.roundUp( 1545.23, 1 ) // zwraca 1545,3
BirtMath.roundUp( 1545.50, -1 ) // zwraca 1550

W następującym przykładzie wartości pola CenaSzacowana zostaną zaokrąglone od zera do liczb całkowitych:

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

BirtMath.safeDivide

Ta funkcja zwraca wynik dzielenia jednej liczby przez drugą, zapobiegając jednocześnie wystąpieniu sytuacji dzielenia przez zero.

Składnia

Number BirtMath.safeDivide( Number dzielna, Number dzielnik, object jeśliZero )

Parametry

dzielna

Obiekt Number. Liczba do podzielenia.

dzielnik

Obiekt Number. Liczba, przez którą zostanie podzielona dzielna.

jeśliZero

Obiekt. Wartość zwracana, jeśli dzielnik jest równy zero.

Wartość zwracana

Obiekt Number. Liczba będąca wynikiem podzielenia dzielnej przez dzielnik.

Przykłady

Następujący przykład przedstawia wynik działania funkcji dla konkretnych liczb:

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

Następujący przykład zwraca wynik podzielenia wartości z pola Przychód przez wartości z pola Wolumen. Jeśli wartość w polu Wolumen wynosi 0, funkcja zwróci wartość 0.

BirtMath.safeDivide( row["Dochód"], row["Wolumen"], 0 )

BirtMath.subtract

Ta funkcja zwraca wynik odejmowania jednej liczby od drugiej.

Składnia

Number BirtMath.subtract( Number n1, Number n2 )

Parametry

n1

Obiekt Number. Liczba, od której zostanie odjęta liczba n2.

n2

Obiekt Number. Liczba do odjęcia od liczby n1.

Wartość zwracana

Obiekt Number. Liczba będąca wynikiem odjęcia liczby n2 od liczby n1.

Przykład

Następujący przykład przedstawia wyniki odejmowania konkretnych liczb:

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

Następujący przykład zwraca wynik odejmowania wartości z pola Zniżka od wartości z pola Suma:

BirtMath.subtract( row["Suma"], row["Zniżka"] )

(c) Copyright Actuate Corporation 2013