Decimal

isInfinite

get isInfinite(): boolean

var isInfinite: Bool { get }

A Boolean value indicating whether this decimal is infinity.

description

get description(): string

var description: String { get }

A textual representation of this instance. Calling this property directly is discouraged. Instead, convert an instance of any type to a string by using the `String(describing:)` initializer. This initializer works with any type, and uses the custom `description` property for types that conform to `CustomStringConvertible`: struct Point: CustomStringConvertible { let x: Int, y: Int var description: String { return "(\(x), \(y))" } } let p = Point(x: 21, y: 30) let s = String(describing: p) print(s) // Prints "(21, 30)" The conversion of `p` to a string in the assignment to `s` uses the `Point` type's `description` property.

isCanonical

get isCanonical(): boolean

var isCanonical: Bool { get }

A Boolean value indicating whether the representation of this decimal is canonical.

isSignMinus

get isSignMinus(): boolean

var isSignMinus: Bool { get }

A Boolean value indicating whether this decimal has a negative sign. This property is `true` when the value is negative or `-0.0`; otherwise, `false`.

isSignaling

get isSignaling(): boolean

var isSignaling: Bool { get }

A Boolean value indicating whether this decimal is a signaling NaN.

isSubnormal

get isSubnormal(): boolean

var isSubnormal: Bool { get }

A Boolean value indicating whether this decimal is subnormal.

significand

get significand(): Decimal

var significand: Decimal { get }

The significand of the decimal.

init

static initFloatLiteral(value: number): Decimal

init(floatLiteral value: Double)

Creates and initializes a decimal with the provided floating point value.

init

static initIntegerLiteral(value: number): Decimal

init(integerLiteral value: Int)

Creates and initializes a decimal with the provided integer value.

isSignalingNaN

get isSignalingNaN(): boolean

var isSignalingNaN: Bool { get }

A Boolean value indicating whether this decimal is a signaling NaN.

isTotallyOrdered

isTotallyOrdered(other: Decimal): boolean

func isTotallyOrdered(belowOrEqualTo other: Decimal) -> Bool

Returns a Boolean value indicating whether this instance should precede the given value in an ascending sort.

floatingPointClass

get floatingPointClass(): SDKHandle

var floatingPointClass: FloatingPointClassification { get }

The IEEE 754 class of this type.

isLessThanOrEqualTo

isLessThanOrEqualTo(other: Decimal): boolean

func isLessThanOrEqualTo(_ other: Decimal) -> Bool

Indicates whether this decimal is less than or equal to the specified one.

leastFiniteMagnitude

static get leastFiniteMagnitude(): Decimal

static let leastFiniteMagnitude: Decimal

The decimal that contains the smallest possible non-infinite magnitude for the underlying representation.

leastNormalMagnitude

static get leastNormalMagnitude(): Decimal

static let leastNormalMagnitude: Decimal

The decimal value that represents the smallest possible normal magnitude for the underlying representation.

leastNonzeroMagnitude

static get leastNonzeroMagnitude(): Decimal

static let leastNonzeroMagnitude: Decimal

The decimal value that represents the smallest possible non-zero value for the underlying representation.

greatestFiniteMagnitude

static get greatestFiniteMagnitude(): Decimal

static let greatestFiniteMagnitude: Decimal

The decimal that contains the largest possible non-infinite magnitude for the underlying representation.

pi

static get pi(): Decimal

static let pi: Decimal

The mathematical constant pi.

nan

static get nan(): Decimal

static var nan: Decimal { get }

The value that represents "not a number."

ulp

get ulp(): Decimal

var ulp: Decimal { get }

The unit in the last place of the decimal.

init

static initSignExponentSignificand(sign: SDKHandle, exponent: number, significand: Decimal): Decimal

init(sign: FloatingPointSign, exponent: Int, significand: Decimal)

Creates a decimal initialized with the given sign, exponent, and significand.

sign

get sign(): SDKHandle

var sign: FloatingPointSign { get }

The sign of the decimal.

isNaN

get isNaN(): boolean

var isNaN: Bool { get }

A Boolean value indicating whether this decimal is NaN.

radix

static get radix(): number

static var radix: Int { get }

The radix used by decimal numbers.

isLess

isLess(other: Decimal): boolean

func isLess(than other: Decimal) -> Bool

Indicates whether this decimal is less than the specified one.

isZero

get isZero(): boolean

var isZero: Bool { get }

A Boolean value indicating whether this value is zero. This property is `true` for `-0.0` and `+0.0` and `false` for all other values.

negate

negate(): void

mutating func negate()

Negates this decimal.

nextUp

get nextUp(): Decimal

var nextUp: Decimal { get }

The least representable value that is greater than this decimal.

init

static initSignOfMagnitudeOf(signOf: Decimal, magnitude: Decimal): Decimal

init(signOf: Decimal, magnitudeOf magnitude: Decimal)

Creates and initializes a decimal with the sign and magnitude of the given decimals. - Parameters: - signOf: A `Decimal` to use for the sign of the newly-created `Decimal`. - magnitude: A `Decimal` to use for the magnitude of the newly-created `Decimal`.

init

static initStringLocale(string: string, locale?: (Locale) | null): (Decimal) | null

init?(string: String, locale: Locale? = nil)

Creates and initializes a decimal by parsing a string according to the provided locale's conventions. - Parameters: - string: A string containing a formatted decimal value. - locale: A locale that indicates the formatting conventions used by `string`.

init

static initExactly(source: number): (Decimal) | null

init?<T>(exactly source: T) where T : BinaryInteger

Creates a new decimal value exactly representing the provided integer. If `source` isn't representable as a `Decimal` instance, the result is `nil`. - Parameter source: The integer to convert.

isEqual

isEqual(other: Decimal): boolean

func isEqual(to other: Decimal) -> Bool

Indicates whether this decimal is equal to the specified one.

advanced

advanced(n: Decimal): Decimal

func advanced(by n: Decimal) -> Decimal

Returns a new value advanced by the given distance.

distance

distance(other: Decimal): Decimal

func distance(to other: Decimal) -> Decimal

Returns the distance from this value to the specified value.

exponent

get exponent(): number

var exponent: Int { get }

The exponent of the decimal.

isFinite

get isFinite(): boolean

var isFinite: Bool { get }

A Boolean value indicating whether this decimal is zero, subnormal, or normal (not infinity or NaN).

isNormal

get isNormal(): boolean

var isNormal: Bool { get }

A Boolean value indicating whether this decimal is normal (not zero, subnormal, infinity, or NaN).

nextDown

get nextDown(): Decimal

var nextDown: Decimal { get }

The greatest representable value that is less than this decimal.

quietNaN

static get quietNaN(): Decimal

static var quietNaN: Decimal { get }

A quiet representation of not-a-number.

formatted

formatted(): string

func formatted() -> String

Formats the decimal using a default localized format style. - Returns: A string representation of the decimal, formatted according to the default format style.

magnitude

get magnitude(): Decimal

var magnitude: Decimal { get }

The magnitude of this decimal.

init

static initFormatLenient(value: string, format: Decimal_FormatStyle_Percent, lenient?: boolean): Decimal

init(_ value: String, format: Decimal.FormatStyle.Percent, lenient: Bool = true) throws

init

static initFormatLenient97749(value: string, format: Decimal_FormatStyle_Currency, lenient?: boolean): Decimal

init(_ value: String, format: Decimal.FormatStyle.Currency, lenient: Bool = true) throws

init

static initFormatLenient99272(value: string, format: Decimal_FormatStyle, lenient?: boolean): Decimal

init(_ value: String, format: Decimal.FormatStyle, lenient: Bool = true) throws

init

static init(value: number): Decimal

init(_ value: Double)

Creates and initializes a decimal with the provided floating point value.

init

static init66917(value: number): Decimal

init(_ value: Int)

Creates and initializes a decimal with the provided integer value.

init

static init10465(value: number): Decimal

init(_ value: UInt)

Creates and initializes a decimal with the provided unsigned integer value.

init

static init67929(value: number): Decimal

init(_ value: Int8)

Creates and initializes a decimal with the provided integer value.

init

static init4129(value: number): Decimal

init(_ value: Int16)

Creates and initializes a decimal with the provided integer value.

init

static init76231(value: number): Decimal

init(_ value: Int32)

Creates and initializes a decimal with the provided integer value.

init

static init66852(value: number): Decimal

init(_ value: Int64)

Creates and initializes a decimal with the provided integer value.

init

static init41211(value: number): Decimal

init(_ value: UInt8)

Creates and initializes a decimal with the provided unsigned integer value.

init

static init80811(value: number): Decimal

init(_ value: UInt16)

Creates and initializes a decimal with the provided unsigned integer value.

init

static init74909(value: number): Decimal

init(_ value: UInt32)

Creates and initializes a decimal with the provided unsigned integer value.

init

static init26262(value: number): Decimal

init(_ value: UInt64)

Creates and initializes a decimal with the provided unsigned integer value.

init

static init47032(): Decimal

init()