BigDecimal
open class BigDecimal : ObjectBase
extension BigDecimal: Equatable, Comparable
Arbitrary precision decimal value.
-
Initialize from an integer value.
Declaration
Swift
public convenience init(_ value: Int)
Parameters
value
Integer value.
-
Declaration
Swift
public func decimalValue() -> Decimal
-
Initialize from a decimal value.
Declaration
Swift
public convenience init(_ value: Decimal)
Parameters
value
Decimal value.
-
Initialize from a string value.
Declaration
Swift
public convenience init(_ text: String)
Parameters
text
String value. Must use valid XML Schema lexical representation for type
decimal
. -
Undocumented
Declaration
Swift
public static let roundNone: Int
-
Undocumented
Declaration
Swift
public static let roundDown: Int
-
Undocumented
Declaration
Swift
public static let roundEven: Int
-
Undocumented
Declaration
Swift
public static let roundUp: Int
-
Declaration
Swift
public final func abs() -> BigDecimal
Return Value
The absolute value of this value (0 for zero, otherwise positive).
-
Declaration
Swift
public final func add(_ p_y: BigDecimal) -> BigDecimal
Return Value
The sum of this value and another value.
-
Declaration
Swift
public final func byteValue() -> Int
Return Value
This value converted to type `byte’.
-
Declaration
Swift
public final func ceiling() -> BigDecimal
Return Value
This value rounded up to the nearest integer value.
-
Declaration
Swift
public final func compareTo(_ p_y: BigDecimal) -> Int
Return Value
This value compared to another value (-1 if
this < other
, 0 ifthis == other
, 1 ifthis > other
). -
Declaration
Swift
public final func divide(_ p_y: BigDecimal) -> BigDecimal
Return Value
This value divided by another value.
-
Declaration
Swift
public final func doubleValue() -> Double
Return Value
This value converted to type `double’.
-
Declaration
Swift
public final func equalTo(_ y: BigDecimal) -> Bool
Return Value
true
if this value is equal to another value. -
Declaration
Swift
public final func floatValue() -> Float
Return Value
This value converted to type `float’.
-
Declaration
Swift
public final func floor() -> BigDecimal
Return Value
This value rounded down to the nearest integer value.
-
Declaration
Swift
open class func fromByte(_ value: Int) -> BigDecimal
Parameters
value
Byte value.
Return Value
value
converted from typebyte
. -
Declaration
Swift
open class func fromDouble(_ value: Double) -> BigDecimal
Parameters
value
Double value.
Return Value
value
converted from typedouble
. -
Declaration
Swift
open class func fromFloat(_ value: Float) -> BigDecimal
Parameters
value
Float value.
Return Value
value
converted from typefloat
. -
Declaration
Swift
open class func fromInt(_ value: Int) -> BigDecimal
Parameters
value
Int value.
Return Value
value
converted from typeint
. -
Declaration
Swift
open class func fromLong(_ value: Int64) -> BigDecimal
Parameters
value
Long value.
Return Value
value
converted from typelong
. -
Declaration
Swift
open class func fromShort(_ value: Int) -> BigDecimal
Parameters
value
Short value.
Return Value
value
converted from typeshort
. -
Declaration
Swift
public final func greaterEqual(_ y: BigDecimal) -> Bool
Return Value
true
if this value is greater than or equal to another value. -
Declaration
Swift
public final func greaterThan(_ y: BigDecimal) -> Bool
Return Value
true
if this value is greater than another value. -
Declaration
Swift
public final func intValue() -> Int
Return Value
This value converted to type `int’.
-
Declaration
Swift
public final func lessEqual(_ y: BigDecimal) -> Bool
Return Value
true
if this value is less than or equal to another value. -
Declaration
Swift
public final func lessThan(_ y: BigDecimal) -> Bool
Return Value
true
if this value is less than another value. -
Declaration
Swift
open class func literal(_ text: String) -> BigDecimal
Parameters
text
Text string using XML Schema lexical representation for this type.
Return Value
value
parsed fromtext
in XML Schema lexical form. Throws an exception if the value is invalid. -
Declaration
Swift
public final func longValue() -> Int64
Return Value
This value converted to type `long’.
-
Declaration
Swift
public final func multiply(_ p_y: BigDecimal) -> BigDecimal
Return Value
The product of this value and another value.
-
Declaration
Swift
public final func negate() -> BigDecimal
Return Value
The negation of this value.
-
Declaration
Swift
public final func notEqual(_ y: BigDecimal) -> Bool
Return Value
true
if this value is not equal to another value. -
Declaration
Swift
open class func parse(_ text: String) -> BigDecimal?
Parameters
text
Text string using XML Schema lexical representation for this type.
Return Value
value
parsed fromtext
in XML Schema lexical form, ornil
iftext
is not in that form. -
Declaration
Swift
public final func remainder(_ y: BigDecimal) -> BigDecimal
Return Value
The remainder of this value divided by another value.
-
Declaration
Swift
public final func round(_ scale: Int = (0 as Int)) -> BigDecimal
Return Value
This value rounded to the specified scale (number of digits to the right of the decimnal point).
-
Declaration
Swift
public final func scale() -> Int
Return Value
The scale of this value (number of places to the right of the decimal point).
-
Declaration
Swift
public final func shortValue() -> Int
Return Value
This value converted to type `short’.
-
Declaration
Swift
public final func sign() -> Int
Return Value
The sign of this value (-1 for negative, 0 for zero, 1 for positive).
-
Declaration
Swift
public final func subtract(_ p_y: BigDecimal) -> BigDecimal
Return Value
The difference between this value and another value.
-
Declaration
Swift
override public final func toString() -> String
Return Value
String representation of this value (using XML Schema canonical form).
-
Declaration
Swift
public final func truncate() -> BigDecimal
Return Value
This value with fraction truncated.