Skip to content

[5.0] NSDecimalValue: Dont use .doubleValue for integer properties. #1912

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 14, 2019
Merged

[5.0] NSDecimalValue: Dont use .doubleValue for integer properties. #1912

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 64 additions & 3 deletions Foundation/Decimal.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2016 Apple Inc. and the Swift project authors
// Copyright (c) 2016 - 2019 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See http://swift.org/LICENSE.txt for license information
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//

import CoreFoundation
Expand Down Expand Up @@ -226,6 +226,66 @@ extension Decimal : Hashable, Comparable {
return _isNegative != 0 ? -d : d
}

// Return the low 64bits of the integer part
private var _unsignedInt64Value: UInt64 {
if _exponent < -20 || _exponent > 20 {
return 0
}

if _length == 0 || isZero || magnitude < Decimal(0) {
return 0
}

var copy = self.significand

if _exponent < 0 {
for _ in _exponent..<0 {
_ = divideByShort(&copy, 10)
}
} else if _exponent > 0 {
for _ in 0..<_exponent {
_ = multiplyByShort(&copy, 10)
}
}
let uint64 = UInt64(copy._mantissa.3) << 48 | UInt64(copy._mantissa.2) << 32 | UInt64(copy._mantissa.1) << 16 | UInt64(copy._mantissa.0)
return uint64
}

// Perform a best effort conversion of the integer value, trying to match Darwin for
// values outside of UInt64.min .. UInt64.max. Used by NSDecimalNumber.
internal var uint64Value: UInt64 {
let value = _unsignedInt64Value
if !self.isNegative {
return value
}

if value == Int64.max.magnitude + 1 {
return UInt64(bitPattern: Int64.min)
} else if value <= Int64.max.magnitude {
var value = Int64(value)
value.negate()
return UInt64(bitPattern: value)
} else {
return value
}
}

// Perform a best effort conversion of the integer value, trying to match Darwin for
// values outside of Int64.min .. Int64.max. Used by NSDecimalNumber.
internal var int64Value: Int64 {
let uint64Value = _unsignedInt64Value
if self.isNegative {
if uint64Value == Int64.max.magnitude + 1 {
return Int64.min
} else if uint64Value <= Int64.max.magnitude {
var value = Int64(uint64Value)
value.negate()
return value
}
}
return Int64(bitPattern: uint64Value)
}

public var hashValue: Int {
return Int(bitPattern: __CFHashDouble(doubleValue))
}
Expand All @@ -250,6 +310,7 @@ extension Decimal : Hashable, Comparable {
var rhsVal = rhs
return NSDecimalCompare(&lhsVal, &rhsVal) == .orderedSame
}

public static func <(lhs: Decimal, rhs: Decimal) -> Bool {
var lhsVal = lhs
var rhsVal = rhs
Expand Down
38 changes: 25 additions & 13 deletions Foundation/NSDecimalNumber.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2016 Apple Inc. and the Swift project authors
// Copyright (c) 2014 - 2019 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See http://swift.org/LICENSE.txt for license information
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//

/*************** Exceptions ***********/
Expand Down Expand Up @@ -358,43 +358,55 @@ open class NSDecimalNumber : NSNumber {
// return 'd' for double

open override var int8Value: Int8 {
return Int8(exactly: decimal.doubleValue) ?? 0 as Int8
return Int8(truncatingIfNeeded: decimal.int64Value)
}

open override var uint8Value: UInt8 {
return UInt8(exactly: decimal.doubleValue) ?? 0 as UInt8
return UInt8(truncatingIfNeeded: decimal.uint64Value)
}

open override var int16Value: Int16 {
return Int16(exactly: decimal.doubleValue) ?? 0 as Int16
return Int16(truncatingIfNeeded: decimal.int64Value)
}

open override var uint16Value: UInt16 {
return UInt16(exactly: decimal.doubleValue) ?? 0 as UInt16
return UInt16(truncatingIfNeeded: decimal.uint64Value)
}

open override var int32Value: Int32 {
return Int32(exactly: decimal.doubleValue) ?? 0 as Int32
return Int32(truncatingIfNeeded: decimal.int64Value)
}

open override var uint32Value: UInt32 {
return UInt32(exactly: decimal.doubleValue) ?? 0 as UInt32
return UInt32(truncatingIfNeeded: decimal.uint64Value)
}

open override var int64Value: Int64 {
return Int64(exactly: decimal.doubleValue) ?? 0 as Int64
return decimal.int64Value
}

open override var uint64Value: UInt64 {
return UInt64(exactly: decimal.doubleValue) ?? 0 as UInt64
return decimal.uint64Value
}

open override var floatValue: Float {
return Float(decimal.doubleValue)
}

open override var doubleValue: Double {
return decimal.doubleValue
}

open override var boolValue: Bool {
return !decimal.isZero
}

open override var intValue: Int {
return Int(exactly: decimal.doubleValue) ?? 0 as Int
return Int(truncatingIfNeeded: decimal.int64Value)
}

open override var uintValue: UInt {
return UInt(exactly: decimal.doubleValue) ?? 0 as UInt
return UInt(truncatingIfNeeded: decimal.uint64Value)
}

open override func isEqual(_ value: Any?) -> Bool {
Expand Down
195 changes: 194 additions & 1 deletion TestFoundation/TestDecimal.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@ class TestDecimal: XCTestCase {
("test_SimpleMultiplication", test_SimpleMultiplication),
("test_SmallerNumbers", test_SmallerNumbers),
("test_ZeroPower", test_ZeroPower),
("test_doubleValue", test_doubleValue)
("test_doubleValue", test_doubleValue),
("test_NSDecimalNumberValues", test_NSDecimalNumberValues),
]
}

Expand Down Expand Up @@ -822,4 +823,196 @@ class TestDecimal: XCTestCase {
XCTAssertEqual(nf.string(from: NSDecimalNumber(decimal: a)), "0.00")
XCTAssertEqual(nf.string(from: NSDecimalNumber(decimal: b)), "0.00")
}

func test_NSDecimalNumberValues() {
let uint64MaxDecimal = Decimal(string: UInt64.max.description)!

// int8Value
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(0)).int8Value, 0)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(-1)).int8Value, -1)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(1)).int8Value, 1)

XCTAssertEqual(NSDecimalNumber(decimal: Decimal(-129)).int8Value, 127)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(128)).int8Value, -128)

XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int8.min)).int8Value, Int8.min)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int16.min)).int8Value, 0)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int32.min)).int8Value, 0)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int64.min)).int8Value, 0)

XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int8.max)).int8Value, Int8.max)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int16.max)).int8Value, -1)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int32.max)).int8Value, -1)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int64.max)).int8Value, -1)

XCTAssertEqual(NSDecimalNumber(decimal: Decimal(UInt8.max)).int8Value, -1)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(UInt16.max)).int8Value, -1)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(UInt32.max)).int8Value, -1)
XCTAssertEqual(NSDecimalNumber(decimal: uint64MaxDecimal).int8Value, -1)

// uint8Value
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(0)).uint8Value, 0)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(-1)).uint8Value, UInt8.max)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(1)).uint8Value, 1)

XCTAssertEqual(NSDecimalNumber(decimal: Decimal(-129)).uint8Value, 127)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(128)).uint8Value, 128)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(256)).uint8Value, 0)

XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int8.min)).uint8Value, 128)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int16.min)).uint8Value, 0)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int32.min)).uint8Value, 0)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int64.min)).uint8Value, 0)

XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int8.max)).uint8Value, 127)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int16.max)).uint8Value, UInt8.max)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int32.max)).uint8Value, UInt8.max)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int64.max)).uint8Value, UInt8.max)

XCTAssertEqual(NSDecimalNumber(decimal: Decimal(UInt8.max)).uint8Value, UInt8.max)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(UInt16.max)).uint8Value, UInt8.max)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(UInt32.max)).uint8Value, UInt8.max)
XCTAssertEqual(NSDecimalNumber(decimal: uint64MaxDecimal).uint8Value, UInt8.max)

// int16Value
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(0)).int16Value, 0)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(-1)).int16Value, -1)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(1)).int16Value, 1)

XCTAssertEqual(NSDecimalNumber(decimal: Decimal(-32769)).int16Value, 32767)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(32768)).int16Value, -32768)

XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int8.min)).int16Value, -128)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int16.min)).int16Value, Int16.min)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int32.min)).int16Value, 0)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int64.min)).int16Value, 0)

XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int8.max)).int16Value, 127)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int16.max)).int16Value, Int16.max)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int32.max)).int16Value, -1)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int64.max)).int16Value, -1)

XCTAssertEqual(NSDecimalNumber(decimal: Decimal(UInt8.max)).int16Value, 255)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(UInt16.max)).int16Value, -1)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(UInt32.max)).int16Value, -1)
XCTAssertEqual(NSDecimalNumber(decimal: uint64MaxDecimal).int16Value, -1)

// uint16Value
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(0)).uint16Value, 0)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(-1)).uint16Value, UInt16.max)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(1)).uint16Value, 1)

XCTAssertEqual(NSDecimalNumber(decimal: Decimal(-32769)).uint16Value, 32767)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(32768)).uint16Value, 32768)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(65536)).uint16Value, 0)

XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int8.min)).uint16Value, 65408)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int16.min)).uint16Value, 32768)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int32.min)).uint16Value, 0)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int64.min)).uint16Value, 0)

XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int8.max)).uint16Value, 127)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int16.max)).uint16Value, 32767)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int32.max)).uint16Value, UInt16.max)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int64.max)).uint16Value, UInt16.max)

XCTAssertEqual(NSDecimalNumber(decimal: Decimal(UInt8.max)).uint16Value, 255)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(UInt16.max)).uint16Value, UInt16.max)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(UInt32.max)).uint16Value, UInt16.max)
XCTAssertEqual(NSDecimalNumber(decimal: uint64MaxDecimal).uint16Value, UInt16.max)

// int32Value
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(0)).int32Value, 0)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(-1)).int32Value, -1)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(1)).int32Value, 1)

XCTAssertEqual(NSDecimalNumber(decimal: Decimal(-32769)).int32Value, -32769)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(32768)).int32Value, 32768)

XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int8.min)).int32Value, -128)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int16.min)).int32Value, -32768)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int32.min)).int32Value, Int32.min)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int64.min)).int32Value, 0)

XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int8.max)).int32Value, 127)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int16.max)).int32Value, 32767)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int32.max)).int32Value, Int32.max)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int64.max)).int32Value, -1)

XCTAssertEqual(NSDecimalNumber(decimal: Decimal(UInt8.max)).int32Value, 255)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(UInt16.max)).int32Value, 65535)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(UInt32.max)).int32Value, -1)
XCTAssertEqual(NSDecimalNumber(decimal: uint64MaxDecimal).int32Value, -1)

// uint32Value
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(0)).uint32Value, 0)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(-1)).uint32Value, UInt32.max)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(1)).uint32Value, 1)

XCTAssertEqual(NSDecimalNumber(decimal: Decimal(-32769)).uint32Value, 4294934527)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(32768)).uint32Value, 32768)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(65536)).uint32Value, 65536)

XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int8.min)).uint32Value, 4294967168)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int16.min)).uint32Value, 4294934528)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int32.min)).uint32Value, 2147483648)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int64.min)).uint32Value, 0)

XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int8.max)).uint32Value, 127)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int16.max)).uint32Value, 32767)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int32.max)).uint32Value, UInt32(Int32.max))
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int64.max)).uint32Value, UInt32.max)

XCTAssertEqual(NSDecimalNumber(decimal: Decimal(UInt8.max)).uint32Value, 255)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(UInt16.max)).uint32Value, 65535)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(UInt32.max)).uint32Value, UInt32.max)
XCTAssertEqual(NSDecimalNumber(decimal: uint64MaxDecimal).uint32Value, UInt32.max)

// int64Value
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(0)).int64Value, 0)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(-1)).int64Value, -1)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(1)).int64Value, 1)

XCTAssertEqual(NSDecimalNumber(decimal: Decimal(-32769)).int64Value, -32769)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(32768)).int64Value, 32768)

XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int8.min)).int64Value, -128)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int16.min)).int64Value, -32768)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int32.min)).int64Value, -2147483648)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int64.min)).int64Value, Int64.min)

XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int8.max)).int64Value, 127)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int16.max)).int64Value, 32767)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int32.max)).int64Value, 2147483647)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int64.max)).int64Value, Int64.max)

XCTAssertEqual(NSDecimalNumber(decimal: Decimal(UInt8.max)).int64Value, 255)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(UInt16.max)).int64Value, 65535)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(UInt32.max)).int64Value, 4294967295)
XCTAssertEqual(NSDecimalNumber(decimal: uint64MaxDecimal).int64Value, -1)

// uint64Value
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(0)).uint64Value, 0)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(-1)).uint64Value, UInt64.max)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(1)).uint64Value, 1)

XCTAssertEqual(NSDecimalNumber(decimal: Decimal(-32769)).uint64Value, 18446744073709518847)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(32768)).uint64Value, 32768)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(65536)).uint64Value, 65536)

XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int8.min)).uint64Value, 18446744073709551488)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int16.min)).uint64Value, 18446744073709518848)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int32.min)).uint64Value, 18446744071562067968)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int64.min)).uint64Value, 9223372036854775808)

XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int8.max)).uint64Value, 127)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int16.max)).uint64Value, 32767)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int32.max)).uint64Value, UInt64(Int32.max))
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(Int64.max)).uint64Value, UInt64(Int64.max))

XCTAssertEqual(NSDecimalNumber(decimal: Decimal(UInt8.max)).uint64Value, 255)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(UInt16.max)).uint64Value, 65535)
XCTAssertEqual(NSDecimalNumber(decimal: Decimal(UInt32.max)).uint64Value, 4294967295)
XCTAssertEqual(NSDecimalNumber(decimal: uint64MaxDecimal).uint64Value, UInt64.max)
}
}