The magnitude of this value.
SDK
- Xcode 8.3+
Framework
- Swift Standard Library
Declaration
var magnitude: Double { get }
Discussion
For any value x
, x
is .plus
. If x
is not NaN, x
is the absolute value of x
.
The global abs(_:)
function provides more familiar syntax when you need to find an absolute value. In addition, because abs(_:)
always returns a value of the same type, even in a generic context, using the function instead of the magnitude
property is encouraged.
let targetDistance: Double = 5.25
let throwDistance: Double = 5.5
let margin = targetDistance - throwDistance
// margin == -0.25
// margin.magnitude == 0.25
// Use 'abs(_:)' instead of 'magnitude'
print("Missed the target by \(abs(margin)) meters.")
// Prints "Missed the target by 0.25 meters."