Required Instance Methodswift 6.0.1Swift
formTruncatingRemainder(dividingBy:)
Replaces this value with the remainder of itself divided by the given value using truncating division.
mutating func formTruncatingRemainder(dividingBy other: Self) Parameters
- other
The value to use when dividing this value.
Performing truncating division with floating-point values results in a truncated integer quotient and a remainder. For values x and y and their truncated integer quotient q, the remainder r satisfies x == y * q + r.
The following example calculates the truncating remainder of dividing 8.625 by 0.75:
var x = 8.625
print(x / 0.75)
// Prints "11.5"
let q = (x / 0.75).rounded(.towardZero)
// q == 11.0
x.formTruncatingRemainder(dividingBy: 0.75)
// x == 0.375
let x1 = 0.75 * q + x
// x1 == 8.625If this value and other are both finite numbers, the truncating remainder has the same sign as this value and is strictly smaller in magnitude than other. The formTruncatingRemainder(dividingBy:) method is always exact.
Other requirements
Type members
associatedtype ExponentA type that can represent any written exponent.
init(Int) Creates a new value, rounded to the closest possible representation.
init<Source>(Source) Creates a new value, rounded to the closest possible representation.
init?<Source>(exactly: Source) Creates a new value, if the given integer can be represented exactly.
init(sign: FloatingPointSign, exponent: Self.Exponent, significand: Self) Creates a new value from the given sign, exponent, and significand.
init(signOf: Self, magnitudeOf: Self) Creates a new floating-point value using the sign of one value and the magnitude of another.
static var greatestFiniteMagnitude: SelfThe greatest finite number representable by this type.
static var infinity: SelfPositive infinity.
static var leastNonzeroMagnitude: SelfThe least positive number.
static var leastNormalMagnitude: SelfThe least positive normal number.
static var nan: SelfA quiet NaN (“not a number”).
static var pi: SelfThe mathematical constant pi (π), approximately equal to 3.14159.
static var radix: IntThe radix, or base of exponentiation, for a floating-point type.
static var signalingNaN: SelfA signaling NaN (“not a number”).
static var ulpOfOne: SelfThe unit in the last place of 1.0.
static func maximum(Self, Self) -> Self Returns the greater of the two given values.
static func maximumMagnitude(Self, Self) -> Self Returns the value with greater magnitude.
static func minimum(Self, Self) -> Self Returns the lesser of the two given values.
static func minimumMagnitude(Self, Self) -> Self Returns the value with lesser magnitude.
static func * (lhs: Self, rhs: Self) -> Self Multiplies two values and produces their product, rounding to a representable value.
static func *= (lhs: inout Self, rhs: Self) Multiplies two values and stores the result in the left-hand-side variable, rounding to a representable value.
static func + (lhs: Self, rhs: Self) -> Self Adds two values and produces their sum, rounded to a representable value.
static func += (lhs: inout Self, rhs: Self) Adds two values and stores the result in the left-hand-side variable, rounded to a representable value.
static func - (operand: Self) -> Self Calculates the additive inverse of a value.
static func - (lhs: Self, rhs: Self) -> Self Subtracts one value from another and produces their difference, rounded to a representable value.
static func -= (lhs: inout Self, rhs: Self) Subtracts the second value from the first and stores the difference in the left-hand-side variable, rounding to a representable value.
static func / (lhs: Self, rhs: Self) -> Self Returns the quotient of dividing the first value by the second, rounded to a representable value.
static func /= (lhs: inout Self, rhs: Self) Divides the first value by the second and stores the quotient in the left-hand-side variable, rounding to a representable value.
Instance members
var exponent: Self.ExponentThe exponent of the floating-point value.
var floatingPointClass: FloatingPointClassificationThe classification of this value.
var isCanonical: BoolA Boolean value indicating whether the instance’s representation is in its canonical form.
var isFinite: BoolA Boolean value indicating whether this instance is finite.
var isInfinite: BoolA Boolean value indicating whether the instance is infinite.
var isNaN: BoolA Boolean value indicating whether the instance is NaN (“not a number”).
var isNormal: BoolA Boolean value indicating whether this instance is normal.
var isSignalingNaN: BoolA Boolean value indicating whether the instance is a signaling NaN.
var isSubnormal: BoolA Boolean value indicating whether the instance is subnormal.
var isZero: BoolA Boolean value indicating whether the instance is equal to zero.
var nextDown: SelfThe greatest representable value that compares less than this value.
var nextUp: SelfThe least representable value that compares greater than this value.
var sign: FloatingPointSignThe sign of the floating-point value.
var significand: SelfThe significand of the floating-point value.
var ulp: SelfThe unit in the last place of this value.
func addProduct(Self, Self) Adds the product of the two given values to this value in place, computed without intermediate rounding.
func addingProduct(Self, Self) -> Self Returns the result of adding the product of the two given values to this value, computed without intermediate rounding.
func formRemainder(dividingBy: Self) Replaces this value with the remainder of itself divided by the given value.
func formSquareRoot() Replaces this value with its square root, rounded to a representable value.
func isEqual(to: Self) -> Bool Returns a Boolean value indicating whether this instance is equal to the given value.
func isLess(than: Self) -> Bool Returns a Boolean value indicating whether this instance is less than the given value.
func isLessThanOrEqualTo(Self) -> Bool Returns a Boolean value indicating whether this instance is less than or equal to the given value.
func isTotallyOrdered(belowOrEqualTo: Self) -> Bool Returns a Boolean value indicating whether this instance should precede or tie positions with the given value in an ascending sort.
func negate() Replaces this value with its additive inverse.
func remainder(dividingBy: Self) -> Self Returns the remainder of this value divided by the given value.
func round(FloatingPointRoundingRule) Rounds the value to an integral value using the specified rounding rule.
func rounded(FloatingPointRoundingRule) -> Self Returns this value rounded to an integral value using the specified rounding rule.
func squareRoot() -> Self Returns the square root of the value, rounded to a representable value.
func truncatingRemainder(dividingBy: Self) -> Self Returns the remainder of this value divided by the given value using truncating division.