前へ 次へ

クラス BirtMath

BirtMath クラスには、数値の加算、減算、乗算、除算、および丸めなど、数値データを操作するための関数があります。数値は、「データ・バインディングの編集」ダイアログの「データ型」フィールドで、別のタイプとしてキャストできる汎用オブジェクトです。このクラスは静的です。アプリケーションでは、このクラスのインスタンスは作成できません。

BirtMath.add

この関数は、2 つの数値の合計を戻します。

構文

Number BirtMath.add( Number n1, Number n2 )

パラメーター

n1

Number オブジェクト。計算で使用する最初の数値。

n2

計算で使用する 2 番目の数値。

戻り値

Number オブジェクト。n1 と n2 を加算した結果の数値。

以下の例は、SalesTotal フィールドの値と Shipping フィールドの値の合計を戻します。

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

BirtMath.ceiling

この関数は、数値を指定した倍数に最も近い 0 以上の数値に切り上げます。

構文

Number BirtMath.ceiling( Number n, Number significance )

パラメーター

n

Number オブジェクト。切り上げる数値。

significance

Number オブジェクト。n の切り上げ対象の倍数。

戻り値

Number オブジェクト。丸めた数値。n が significance の倍数と一致している場合、丸めは行われません。

BirtMath.ceiling( ) は、一般に、価格を切り上げるために使用されます。例えば、1 セントを扱わないようにする場合は、以下の式を使用して、Price フィールドの価格を最も近い 5 セントの価格に切り上げることができます。

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

Price の値が 20.52 の場合、式は 20.55 を戻します。

以下の式は、価格を最も近い 10 セント単位の価格に切り上げます。

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 被除数, Number 除数 )

パラメーター

被除数

Number オブジェクト。除算される数値。

除数

Number オブジェクト。被除数を除算する数値。

戻り値

Number オブジェクト。被除数を除数で除算した結果の数値。

以下の例は、特定の数値の除算結果を示しています。

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

以下の例は、Total フィールドの値を Quantity フィールドの値で除算した結果を戻します。

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

BirtMath.mod

この関数は、ある数値を除数で除算した結果の余りを戻します。

構文

Number BirtMath.mod( Number 数値, Number 除数 )

パラメーター

数値

Number オブジェクト。除算される数値。

除数

Number オブジェクト。最初の数値を除算する数値。ゼロ以外の数値を指定する必要があります。

戻り値

数値を除数で除算した結果の余り。

以下の例は、特定の数値に戻される結果を示しています。

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

以下の例は、Grade フィールドの数値が奇数か偶数かをチェックします。除数が 2 の場合、偶数には 0、奇数には 1 が戻されます。

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

BirtMath.multiply

この関数は、2 つの数値の乗算結果を戻します。

構文

Number BirtMath.multiply( Number n1, Number n2 )

パラメーター

n1

Number オブジェクト。計算で使用する最初の数値。

n2

Number オブジェクト。計算で使用する 2 番目の数値。

戻り値

Number オブジェクト。n1 と n2 を乗算した結果の数値。

以下の例は、QuantityOrdered フィールドの値と PriceEach フィールドの値を乗算した結果を戻します。

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

BirtMath.round

この関数は、数値を指定した桁数に丸めます。

構文

Number BirtMath.round( Number 数値, Number dec )

パラメーター

数値

Number オブジェクト。丸める数値。

dec

Number オブジェクト。数値を丸める桁数。この引数を省略した場合、0 と見なされます。

戻り値

Number オブジェクト。指定した桁数に丸められた数値。

以下の例は、特定の数値に戻される結果を示しています。

BirtMath.round( 1545.50 ) // returns 1546
BirtMath.round( 1545.56, 1 ) // returns 1545.6
BirtMath.round( 1545.23, 1 ) // returns 1545.2
BirtMath.round( 1545.50, -1 ) // returns 1550

以下の例は、PriceEstimate フィールドの値を丸めて整数を戻します。

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

BirtMath.roundDown

この関数は、数値を指定した桁数まで切り捨てます。

構文

Number BirtMath.roundDown( Number 数値, Number dec )

パラメーター

数値

Number オブジェクト。丸める数値。

dec

Number オブジェクト。数値を切り捨てる桁数。この引数を省略した場合、0 と見なされます。

戻り値

Number オブジェクト。指定した桁数に切り捨てられた数値。

以下の例は、特定の数値に戻される結果を示しています。

BirtMath.roundDown( 1545.50 ) // returns 1545
BirtMath.roundDown( 1545.56, 1 ) // returns 1545.5
BirtMath.roundDown( 1545.23, 1 ) // returns 1545.2
BirtMath.roundDown( 1545.50, -1 ) // returns 1540

以下の例は、PriceEstimate フィールドの値を切り捨てて整数を戻します。

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

BirtMath.roundUp

この関数は、数値を指定した桁数まで切り上げます。

構文

Number BirtMath.roundUp( Number 数値, Number dec )

パラメーター

数値

Number オブジェクト。切り上げる数値。

dec

Number オブジェクト。数値を切り上げる桁数。この引数を省略した場合、0 と見なされます。

戻り値

Number オブジェクト。指定した桁数に切り上げられた数値。

以下の例は、特定の数値に戻される結果を示しています。

BirtMath.roundUp( 1545.50 ) // returns 1546
BirtMath.roundUp( 1545.56, 1 ) // returns 1545.6
BirtMath.roundUp( 1545.23, 1 ) // returns 1545.3
BirtMath.roundUp( 1545.50, -1 ) // returns 1550

以下の例は、PriceEstimate フィールドの値を切り上げて整数を戻します。

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

BirtMath.safeDivide

この関数は、ある数値を他の数値で除算した結果を戻します。ゼロ条件での除算は抑制されます。

構文

Number BirtMath.safeDivide( Number 被除数, Number 除数, object ifZero )

パラメーター

被除数

Number オブジェクト。除算される数値。

除数

Number オブジェクト。被除数を除算する数値。

ifZero

Object 型。除数がゼロのときに戻す値。

戻り値

Number オブジェクト。Number オブジェクト。被除数を除数で除算した結果の数値。

以下の例は、特定の数値に戻される結果を示しています。

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

以下の例は、Revenue フィールドの値を Volume フィールドの値で除算した結果を戻します。Volume の値が 0 の場合、0 を戻します。

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

BirtMath.subtract

この関数は、ある数値から他の数値を減算した結果を戻します。

構文

Number BirtMath.subtract( Number n1, Number n2 )

パラメーター

n1

Number オブジェクト。減算される数値。

n2

Number オブジェクト。n1 から減算する数値。

戻り値

Number オブジェクト。n1 から n2 を減算した結果の数値。

以下の例は、特定の数値の減算結果を示しています。

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

以下の例は、Total フィールドの値から Discount フィールドの値を減算した結果を戻します。

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

(c) Copyright Actuate Corporation 2013