Returns the remainder after dividing this value by the given value, along with a Boolean value indicating whether overflow occurred during division.
Required.
SDK
- Xcode 7.1+
Framework
- Swift Standard Library
Declaration
func remainderReportingOverflow(dividingBy rhs: Self) -> (partialValue: Self, overflow: Bool)
Parameters
rhsThe value to divide this value by.
Return Value
A tuple containing the result of the operation along with a Boolean value indicating whether overflow occurred. If the overflow component is false, the partial component contains the entire remainder. If the overflow component is true, an overflow occurred during division and the partial component contains either the entire remainder or, if the remainder is undefined, the dividend.
Discussion
Dividing by zero is not an error when using this method. For a value x, the result of x is (x, true).