A structure representing a base-10 number.
SDKs
- iOS 2.0+
- macOS 10.0+
- UIKit for Mac 13.0+Beta
- tvOS 9.0+
- watchOS 2.0+
Framework
- Foundation
Declaration
struct Decimal
Structure
Decimal
Topics
Creating an Empty Decimal
init()Creates a decimal initialized to 0.
Creating a Decimal from Components
init(sign: FloatingCreates a decimal initialized with the given sign, exponent, and significand.
init(_exponent: Int32, _length: UInt32, _isCreates a decimal initialized according to the provided characteristics.
Creating a Decimal from a Floating Point Number
init(Double)Creates and initializes a decimal with the provided floating point value.
init(floatCreates and initializes a decimal with the provided floating point value.
Creating a Decimal from an Integer
init?<T>(exactly: T)Creates a new decimal value exactly representing the provided integer.
init(Int)Creates and initializes a decimal with the provided integer value.
init(Int8)Creates and initializes a decimal with the provided integer value.
init(Int16)Creates and initializes a decimal with the provided integer value.
init(Int32)Creates and initializes a decimal with the provided integer value.
init(Int64)Creates and initializes a decimal with the provided integer value.
init(integerCreates and initializes a decimal with the provided integer value.
Creating a Decimal from an Unsigned Integer
init(UInt)Creates and initializes a decimal with the provided unsigned integer value.
init(UInt8)Creates and initializes a decimal with the provided unsigned integer value.
init(UInt16)Creates and initializes a decimal with the provided unsigned integer value.
init(UInt32)Creates and initializes a decimal with the provided unsigned integer value.
init(UInt64)Creates and initializes a decimal with the provided unsigned integer value.
Creating a Decimal from Another Decimal
init(signCreates and initializes a decimal with the sign and magnitude of the given decimals.
func NSDecimalCopies the value of a decimal number.
Converting Between Decimals and Strings
func NSDecimalReturns a string representation of the decimal value appropriate for the specified locale.
Performing Arithmetic
static func * (Decimal, Decimal) -> DecimalMultiplies two decimal numbers.
static func *= (inout Decimal, Decimal)Multiplies two decimal numbers, storing the result in the first number.
static func + (Decimal, Decimal) -> DecimalAdds two decimal numbers.
static func += (inout Decimal, Decimal)Adds two decimal numbers, storing the result in the first number.
static func - (Decimal, Decimal) -> DecimalSubtracts one decimal number from another.
static func -= (inout Decimal, Decimal)Subtracts one decimal number from another, storing the result in the first number.
static func / (Decimal, Decimal) -> DecimalDivides one decimal number by another.
static func /= (inout Decimal, Decimal)Divides one decimal number by another, storing the result in the first number.
func pow(Decimal, Int) -> DecimalReturns a decimal number raised to a given power.
func negate()Negates this decimal.
Performing Arithmetic Using References
func NSDecimalCompacts the decimal structure for efficiency.
func NSDecimalMultiplies a decimal by the specified power of 10.
func NSDecimalRounds off the decimal value.
func NSDecimalRaises the decimal value to the specified power.
func NSDecimalNormalizes the internal format of two decimal numbers to simplify later operations.
typealias DecimalAn alias for an enumeration that specifies possible rounding modes.
enum NSDecimalThese constants specify rounding behaviors.
typealias DecimalAn alias for a type that specifies possible calculation errors.
enum NSDecimalCalculation error constants used to describe an error in exception.
Getting a Decimal's Characteristics
var sign: FloatingThe sign of the decimal.
var exponent: IntThe exponent of the decimal.
var significand: DecimalThe significand of the decimal.
var magnitude: DecimalThe magnitude of this decimal.
var floatingThe IEEE 754 class of this type.
var isA Boolean value indicating whether the representation of this decimal is canonical.
var isA Boolean value indicating whether this decimal is zero, subnormal, or normal (not infinity or NaN).
var isA Boolean value indicating whether this decimal is infinity.
var isA Boolean value indicating whether this decimal is NaN.
var isA Boolean value indicating whether this decimal is normal (not zero, subnormal, infinity, or NaN).
var isA Boolean value indicating whether this decimal has a negative sign.
var isA Boolean value indicating whether this decimal is a signaling NaN.
var isA Boolean value indicating whether this decimal is a signaling NaN.
var isA Boolean value indicating whether this decimal is subnormal.
var isA Boolean value indicating whether this value is zero.
var nextThe greatest representable value that is less than this decimal.
var nextThe least representable value that is greater than this decimal.
var ulp: DecimalThe unit in the last place of the decimal.
Getting Particular Decimals
static let greatestThe decimal that contains the largest possible non-infinite magnitude for the underlying representation.
static let leastThe decimal that contains the smallest possible non-infinite magnitude for the underlying representation.
static let leastThe decimal value that represents the smallest possible non-zero value for the underlying representation.
static let leastThe decimal value that represents the smallest possible normal magnitude for the underlying representation.
static let pi: DecimalThe mathematical constant pi.
static var nan: DecimalThe value that represents "not a number."
static var quietA quiet representation of not-a-number.
static var radix: IntThe radix used by decimal numbers.
var NSDecimalThe maximum size of Decimal.
var NSDecimalSpecifies that the number of digits allowed after the decimal separator in a decimal number should not be limited.
Comparing Decimals
static func < (Decimal, Decimal) -> BoolReturns a Boolean value indicating whether one decimal number is strictly less than another.
static func == (Decimal, Decimal) -> BoolReturns a Boolean value indicating whether two decimal numbers are equal.
func isIndicates whether this decimal is equal to the specified one.
func isIndicates whether this decimal is less than the specified one.
func isIndicates whether this decimal is less than or equal to the specified one.
func isReturns a Boolean value indicating whether this instance should precede the given value in an ascending sort.
func distance(to: Decimal) -> DecimalReturns the distance from this value to the specified value.
func advanced(by: Decimal) -> DecimalReturns a new value advanced by the given distance.
func NSDecimalCompares two decimal values.
Encoding and Decoding
func encode(to: Encoder)Encodes this decimal value into the given encoder.
init(from: Decoder)Creates a new decimal value by decoding from the given decoder.
Describing a Decimal
var description: StringA textual description of the decimal.
Using Reference Types
class NSDecimalAn object for representing and performing arithmetic on base-10 numbers that bridges to Decimal; use NSDecimal when you need reference semantics or other Foundation-specific behavior.
Initializers
Instance Methods
See Also
Numbers
struct IntA signed integer value type.
struct DoubleA double-precision, floating-point value type.
class NumberA formatter that converts between numeric values and their textual representations.
Beta Software
This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.
Learn more about using Apple's beta software