# BigInteger

``open class BigInteger : ObjectBase``
``extension BigInteger: Equatable, Comparable``

Arbitrary precision integer value.

• ``` init(_:) ```

Initialize from an integer value.

#### Declaration

Swift

``public convenience init(_ value: Int)``

#### Parameters

 ``` value ``` Integer value.
• ``` decimalValue() ```

#### Declaration

Swift

``public func decimalValue() -> Decimal``
• ``` init(_:) ```

Initialize from a decimal value.

#### Declaration

Swift

``public convenience init(_ value: Decimal)``

#### Parameters

 ``` value ``` Swift.Decimal value.
• ``` init(_:) ```

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 `integer`.
• ``` abs() ```

#### Declaration

Swift

``public final func abs() -> BigInteger``

#### Return Value

The absolute value of this value (0 for zero, otherwise positive).

• ``` add(_:) ```

#### Declaration

Swift

``public final func add(_ p_y: BigInteger) -> BigInteger``

#### Return Value

The sum of this value and another value.

• ``` byteValue() ```

#### Declaration

Swift

``public final func byteValue() -> Int``

#### Return Value

This value converted to type `byte’.

• ``` compareTo(_:) ```

#### Declaration

Swift

``public final func compareTo(_ p_y: BigInteger) -> Int``

#### Return Value

This value compared to another value (-1 if `this < other`, 0 if `this == other`, 1 if `this > other`).

• ``` divide(_:) ```

#### Declaration

Swift

``public final func divide(_ p_y: BigInteger) -> BigInteger``

#### Return Value

This value divided by another value.

• ``` doubleValue() ```

#### Declaration

Swift

``public final func doubleValue() -> Double``

#### Return Value

This value converted to type `double’.

• ``` equalTo(_:) ```

#### Declaration

Swift

``public final func equalTo(_ y: BigInteger) -> Bool``

#### Return Value

`true` if this value is equal to another value.

• ``` floatValue() ```

#### Declaration

Swift

``public final func floatValue() -> Float``

#### Return Value

This value converted to type `float’.

• ``` fromByte(_:) ```

#### Declaration

Swift

``open class func fromByte(_ value: Int) -> BigInteger``

#### Parameters

 ``` value ``` Byte value.

#### Return Value

`value` converted from type `byte`.

• ``` fromDouble(_:) ```

#### Declaration

Swift

``open class func fromDouble(_ value: Double) -> BigInteger``

#### Parameters

 ``` value ``` Double value.

#### Return Value

`value` converted from type `double`.

• ``` fromFloat(_:) ```

#### Declaration

Swift

``open class func fromFloat(_ value: Float) -> BigInteger``

#### Parameters

 ``` value ``` Float value.

#### Return Value

`value` converted from type `float`.

• ``` fromInt(_:) ```

#### Declaration

Swift

``open class func fromInt(_ value: Int) -> BigInteger``

#### Parameters

 ``` value ``` Int value.

#### Return Value

`value` converted from type `int`.

• ``` fromLong(_:) ```

#### Declaration

Swift

``open class func fromLong(_ value: Int64) -> BigInteger``

#### Parameters

 ``` value ``` Long value.

#### Return Value

`value` converted from type `long`.

• ``` fromShort(_:) ```

#### Declaration

Swift

``open class func fromShort(_ value: Int) -> BigInteger``

#### Parameters

 ``` value ``` Short value.

#### Return Value

`value` converted from type `short`.

• ``` greaterEqual(_:) ```

#### Declaration

Swift

``public final func greaterEqual(_ y: BigInteger) -> Bool``

#### Return Value

`true` if this value is greater than or equal to another value.

• ``` greaterThan(_:) ```

#### Declaration

Swift

``public final func greaterThan(_ y: BigInteger) -> Bool``

#### Return Value

`true` if this value is greater than another value.

• ``` intValue() ```

#### Declaration

Swift

``public final func intValue() -> Int``

#### Return Value

This value converted to type `int’.

• ``` lessEqual(_:) ```

#### Declaration

Swift

``public final func lessEqual(_ y: BigInteger) -> Bool``

#### Return Value

`true` if this value is less than or equal to another value.

• ``` lessThan(_:) ```

#### Declaration

Swift

``public final func lessThan(_ y: BigInteger) -> Bool``

#### Return Value

`true` if this value is less than another value.

• ``` literal(_:) ```

#### Declaration

Swift

``open class func literal(_ text: String) -> BigInteger``

#### Parameters

 ``` text ``` Text string using XML Schema lexical representation for this type.

#### Return Value

`value` parsed from `text` in XML Schema lexical form. Throws an exception if the value is invalid.

• ``` longValue() ```

#### Declaration

Swift

``public final func longValue() -> Int64``

#### Return Value

This value converted to type `long’.

• ``` multiply(_:) ```

#### Declaration

Swift

``public final func multiply(_ p_y: BigInteger) -> BigInteger``

#### Return Value

The product of this value and another value.

• ``` negate() ```

#### Declaration

Swift

``public final func negate() -> BigInteger``

#### Return Value

The negation of this value.

• ``` notEqual(_:) ```

#### Declaration

Swift

``public final func notEqual(_ y: BigInteger) -> Bool``

#### Return Value

`true` if this value is not equal to another value.

• ``` parse(_:) ```

#### Declaration

Swift

``open class func parse(_ text: String) -> BigInteger?``

#### Parameters

 ``` text ``` Text string using XML Schema lexical representation for this type.

#### Return Value

`value` parsed from `text` in XML Schema lexical form, or `nil` if `text` is not in that form.

• ``` remainder(_:) ```

#### Declaration

Swift

``public final func remainder(_ y: BigInteger) -> BigInteger``

#### Return Value

The remainder of this value divided by another value.

• ``` shortValue() ```

#### Declaration

Swift

``public final func shortValue() -> Int``

#### Return Value

This value converted to type `short’.

• ``` sign() ```

#### Declaration

Swift

``public final func sign() -> Int``

#### Return Value

The sign of this value (-1 for negative, 0 for zero, 1 for positive).

• ``` subtract(_:) ```

#### Declaration

Swift

``public final func subtract(_ p_y: BigInteger) -> BigInteger``

#### Return Value

The difference between this value and another value.

• ``` toString() ```

#### Declaration

Swift

``override public final func toString() -> String``

#### Return Value

String representation of this value (using XML Schema canonical form).