Protocol

SIMD

A SIMD vector of a fixed number of elements.

Declaration

protocol SIMD

Topics

Associated Types

associatedtype MaskStorage

The mask type resulting from pointwise comparisons of this vector type.

Required.

Initializers

init<S>(S)

Creates a vector from the given sequence.

init(Self.Scalar)Deprecated
init(repeating: Self.Scalar)

A vector with the specified value in all lanes.

Instance Properties

var indices: Range<Int>

The valid indices for subscripting the vector.

var leadingZeroBitCount: Self
Available when Scalar conforms to FixedWidthInteger.
var nonzeroBitCount: Self
Available when Scalar conforms to FixedWidthInteger.
var trailingZeroBitCount: Self
Available when Scalar conforms to FixedWidthInteger.

Type Properties

static var one: Self

A vector with one in all lanes.

Available when Scalar conforms to FloatingPoint.
static var one: Self

A vector with one in all lanes.

Available when Scalar conforms to FixedWidthInteger.
static var zero: Self

A vector with zero in all lanes.

Available when Scalar conforms to FloatingPoint.
static var zero: Self

A vector with zero in all lanes.

Available when Scalar conforms to FixedWidthInteger.

Instance Methods

func addProduct(Self.Scalar, Self)
Available when Scalar conforms to FloatingPoint.
func addProduct(Self, Self.Scalar)
Available when Scalar conforms to FloatingPoint.
func addProduct(Self, Self)
Available when Scalar conforms to FloatingPoint.
func addingProduct(Self.Scalar, Self) -> Self
Available when Scalar conforms to FloatingPoint.
func addingProduct(Self, Self.Scalar) -> Self
Available when Scalar conforms to FloatingPoint.
func addingProduct(Self, Self) -> Self
Available when Scalar conforms to FloatingPoint.
func clamp(lowerBound: Self, upperBound: Self)
Available when Scalar conforms to FloatingPoint.
func clamp(lowerBound: Self, upperBound: Self)
Available when Scalar conforms to Comparable.
func clamped(lowerBound: Self, upperBound: Self) -> Self
Available when Scalar conforms to FloatingPoint.
func clamped(lowerBound: Self, upperBound: Self) -> Self
Available when Scalar conforms to Comparable.
func formSquareRoot()
Available when Scalar conforms to FloatingPoint.
func max() -> Self.Scalar

Returns the greatest scalar in the vector.

Available when Scalar conforms to FloatingPoint.
func max() -> Self.Scalar

The greatest element in the vector.

Available when Scalar conforms to Comparable.
func min() -> Self.Scalar

Returns the least scalar in the vector.

Available when Scalar conforms to FloatingPoint.
func min() -> Self.Scalar

The least element in the vector.

Available when Scalar conforms to Comparable.
func replace(with: Self.Scalar, where: SIMDMask<Self.MaskStorage>)

Replaces elements of this vector with other in the lanes where mask is true.

func replace(with: Self, where: SIMDMask<Self.MaskStorage>)

Replaces elements of this vector with elements of other in the lanes where mask is true.

func replacing(with: Self.Scalar, where: SIMDMask<Self.MaskStorage>) -> Self

Returns a copy of this vector, with elements other in the lanes where mask is true.

func replacing(with: Self, where: SIMDMask<Self.MaskStorage>) -> Self

Returns a copy of this vector, with elements replaced by elements of other in the lanes where mask is true.

func round(FloatingPointRoundingRule)
Available when Scalar conforms to FloatingPoint.
func rounded(FloatingPointRoundingRule) -> Self
Available when Scalar conforms to FloatingPoint.
func squareRoot() -> Self
Available when Scalar conforms to FloatingPoint.
func sum() -> Self.Scalar

Returns the sum of the scalars in the vector.

Available when Scalar conforms to FloatingPoint.
func wrappedSum() -> Self.Scalar

Returns the sum of the scalars in the vector, computed with wrapping addition.

Available when Scalar conforms to FixedWidthInteger.

Type Methods

static func random(in: ClosedRange<Self.Scalar>) -> Self

Returns a vector with random values from within the specified range in all lanes.

Available when Scalar conforms to BinaryFloatingPoint and Scalar.RawSignificand conforms to FixedWidthInteger.
static func random(in: Range<Self.Scalar>) -> Self

Returns a vector with random values from within the specified range in all lanes.

Available when Scalar conforms to BinaryFloatingPoint and Scalar.RawSignificand conforms to FixedWidthInteger.
static func random(in: ClosedRange<Self.Scalar>) -> Self

Returns a vector with random values from within the specified range in all lanes.

Available when Scalar conforms to FixedWidthInteger.
static func random(in: Range<Self.Scalar>) -> Self

Returns a vector with random values from within the specified range in all lanes.

Available when Scalar conforms to FixedWidthInteger.
static func random<T>(in: ClosedRange<Self.Scalar>, using: inout T) -> Self

Returns a vector with random values from within the specified range in all lanes, using the given generator as a source for randomness.

Available when Scalar conforms to BinaryFloatingPoint and Scalar.RawSignificand conforms to FixedWidthInteger.
static func random<T>(in: Range<Self.Scalar>, using: inout T) -> Self

Returns a vector with random values from within the specified range in all lanes, using the given generator as a source for randomness.

Available when Scalar conforms to BinaryFloatingPoint and Scalar.RawSignificand conforms to FixedWidthInteger.
static func random<T>(in: ClosedRange<Self.Scalar>, using: inout T) -> Self

Returns a vector with random values from within the specified range in all lanes, using the given generator as a source for randomness.

Available when Scalar conforms to FixedWidthInteger.
static func random<T>(in: Range<Self.Scalar>, using: inout T) -> Self

Returns a vector with random values from within the specified range in all lanes, using the given generator as a source for randomness.

Available when Scalar conforms to FixedWidthInteger.

Operator Functions

static func % (Self.Scalar, Self) -> Self
Available when Scalar conforms to FixedWidthInteger.
static func % (Self, Self.Scalar) -> Self
Available when Scalar conforms to FixedWidthInteger.
static func % (Self, Self) -> Self
Available when Scalar conforms to FixedWidthInteger.
static func %= (inout Self, Self.Scalar)
Available when Scalar conforms to FixedWidthInteger.
static func %= (inout Self, Self)
Available when Scalar conforms to FixedWidthInteger.
static func & (Self.Scalar, Self) -> Self
Available when Scalar conforms to FixedWidthInteger.
static func & (Self, Self.Scalar) -> Self
Available when Scalar conforms to FixedWidthInteger.
static func & (Self, Self) -> Self
Available when Scalar conforms to FixedWidthInteger.
static func &* (Self.Scalar, Self) -> Self
Available when Scalar conforms to FixedWidthInteger.
static func &* (Self, Self.Scalar) -> Self
Available when Scalar conforms to FixedWidthInteger.
static func &* (Self, Self) -> Self
Available when Scalar conforms to FixedWidthInteger.
static func &*= (inout Self, Self.Scalar)
Available when Scalar conforms to FixedWidthInteger.
static func &*= (inout Self, Self)
Available when Scalar conforms to FixedWidthInteger.
static func &+ (Self.Scalar, Self) -> Self
Available when Scalar conforms to FixedWidthInteger.
static func &+ (Self, Self.Scalar) -> Self
Available when Scalar conforms to FixedWidthInteger.
static func &+ (Self, Self) -> Self
Available when Scalar conforms to FixedWidthInteger.
static func &+= (inout Self, Self.Scalar)
Available when Scalar conforms to FixedWidthInteger.
static func &+= (inout Self, Self)
Available when Scalar conforms to FixedWidthInteger.
static func &- (Self.Scalar, Self) -> Self
Available when Scalar conforms to FixedWidthInteger.
static func &- (Self, Self.Scalar) -> Self
Available when Scalar conforms to FixedWidthInteger.
static func &- (Self, Self) -> Self
Available when Scalar conforms to FixedWidthInteger.
static func &-= (inout Self, Self.Scalar)
Available when Scalar conforms to FixedWidthInteger.
static func &-= (inout Self, Self)
Available when Scalar conforms to FixedWidthInteger.
static func &<< (Self.Scalar, Self) -> Self
Available when Scalar conforms to FixedWidthInteger.
static func &<< (Self, Self.Scalar) -> Self
Available when Scalar conforms to FixedWidthInteger.
static func &<< (Self, Self) -> Self
Available when Scalar conforms to FixedWidthInteger.
static func &<<= (inout Self, Self.Scalar)
Available when Scalar conforms to FixedWidthInteger.
static func &<<= (inout Self, Self)
Available when Scalar conforms to FixedWidthInteger.
static func &= (inout Self, Self.Scalar)
Available when Scalar conforms to FixedWidthInteger.
static func &= (inout Self, Self)
Available when Scalar conforms to FixedWidthInteger.
static func &>> (Self.Scalar, Self) -> Self
Available when Scalar conforms to FixedWidthInteger.
static func &>> (Self, Self.Scalar) -> Self
Available when Scalar conforms to FixedWidthInteger.
static func &>> (Self, Self) -> Self
Available when Scalar conforms to FixedWidthInteger.
static func &>>= (inout Self, Self.Scalar)
Available when Scalar conforms to FixedWidthInteger.
static func &>>= (inout Self, Self)
Available when Scalar conforms to FixedWidthInteger.
static func * (Self.Scalar, Self) -> Self
Available when Scalar conforms to FloatingPoint.
static func * (Self, Self.Scalar) -> Self
Available when Scalar conforms to FloatingPoint.
static func * (Self, Self) -> Self
Available when Scalar conforms to FloatingPoint.
static func *= (inout Self, Self.Scalar)
Available when Scalar conforms to FloatingPoint.
static func *= (inout Self, Self)
Available when Scalar conforms to FloatingPoint.
static func + (Self.Scalar, Self) -> Self
Available when Scalar conforms to FloatingPoint.
static func + (Self, Self.Scalar) -> Self
Available when Scalar conforms to FloatingPoint.
static func + (Self, Self) -> Self
Available when Scalar conforms to FloatingPoint.
static func += (inout Self, Self.Scalar)
Available when Scalar conforms to FloatingPoint.
static func += (inout Self, Self)
Available when Scalar conforms to FloatingPoint.
static func - (Self) -> Self
Available when Scalar conforms to FloatingPoint.
static func - (Self) -> Self
Available when Scalar conforms to FixedWidthInteger.
Deprecated
static func - (Self.Scalar, Self) -> Self
Available when Scalar conforms to FloatingPoint.
static func - (Self, Self.Scalar) -> Self
Available when Scalar conforms to FloatingPoint.
static func - (Self, Self) -> Self
Available when Scalar conforms to FloatingPoint.
static func -= (inout Self, Self.Scalar)
Available when Scalar conforms to FloatingPoint.
static func -= (inout Self, Self)
Available when Scalar conforms to FloatingPoint.
static func .!= (Self.Scalar, Self) -> SIMDMask<Self.MaskStorage>

Returns a vector mask with the result of a pointwise inequality comparison.

static func .!= (Self, Self.Scalar) -> SIMDMask<Self.MaskStorage>

Returns a vector mask with the result of a pointwise inequality comparison.

static func .!= (Self, Self) -> SIMDMask<Self.MaskStorage>

Returns a vector mask with the result of a pointwise inequality comparison.

static func .< (Self.Scalar, Self) -> SIMDMask<Self.MaskStorage>

Returns a vector mask with the result of a pointwise less than comparison.

Available when Scalar conforms to Comparable.
static func .< (Self, Self.Scalar) -> SIMDMask<Self.MaskStorage>

Returns a vector mask with the result of a pointwise less than comparison.

Available when Scalar conforms to Comparable.
static func .< (Self, Self) -> SIMDMask<Self.MaskStorage>

Returns a vector mask with the result of a pointwise less than comparison.

Available when Scalar conforms to Comparable.
static func .<= (Self.Scalar, Self) -> SIMDMask<Self.MaskStorage>

Returns a vector mask with the result of a pointwise less than or equal comparison.

Available when Scalar conforms to Comparable.
static func .<= (Self, Self.Scalar) -> SIMDMask<Self.MaskStorage>

Returns a vector mask with the result of a pointwise less than or equal comparison.

Available when Scalar conforms to Comparable.
static func .<= (Self, Self) -> SIMDMask<Self.MaskStorage>

Returns a vector mask with the result of a pointwise less than or equal comparison.

Available when Scalar conforms to Comparable.
static func .== (Self.Scalar, Self) -> SIMDMask<Self.MaskStorage>

Returns a vector mask with the result of a pointwise equality comparison.

static func .== (Self, Self.Scalar) -> SIMDMask<Self.MaskStorage>

Returns a vector mask with the result of a pointwise equality comparison.

static func .== (Self, Self) -> SIMDMask<Self.MaskStorage>

Returns a vector mask with the result of a pointwise equality comparison.

static func .> (Self.Scalar, Self) -> SIMDMask<Self.MaskStorage>

Returns a vector mask with the result of a pointwise greater than comparison.

Available when Scalar conforms to Comparable.
static func .> (Self, Self.Scalar) -> SIMDMask<Self.MaskStorage>

Returns a vector mask with the result of a pointwise greater than comparison.

Available when Scalar conforms to Comparable.
static func .> (Self, Self) -> SIMDMask<Self.MaskStorage>

Returns a vector mask with the result of a pointwise greater than comparison.

Available when Scalar conforms to Comparable.
static func .>= (Self.Scalar, Self) -> SIMDMask<Self.MaskStorage>

Returns a vector mask with the result of a pointwise greater than or equal comparison.

Available when Scalar conforms to Comparable.
static func .>= (Self, Self.Scalar) -> SIMDMask<Self.MaskStorage>

Returns a vector mask with the result of a pointwise greater than or equal comparison.

Available when Scalar conforms to Comparable.
static func .>= (Self, Self) -> SIMDMask<Self.MaskStorage>

Returns a vector mask with the result of a pointwise greater than or equal comparison.

Available when Scalar conforms to Comparable.
static func / (Self.Scalar, Self) -> Self
Available when Scalar conforms to FloatingPoint.
static func / (Self, Self.Scalar) -> Self
Available when Scalar conforms to FloatingPoint.
static func / (Self, Self) -> Self
Available when Scalar conforms to FloatingPoint.
static func / (Self.Scalar, Self) -> Self
Available when Scalar conforms to FixedWidthInteger.
static func / (Self, Self.Scalar) -> Self
Available when Scalar conforms to FixedWidthInteger.
static func / (Self, Self) -> Self
Available when Scalar conforms to FixedWidthInteger.
static func /= (inout Self, Self.Scalar)
Available when Scalar conforms to FloatingPoint.
static func /= (inout Self, Self)
Available when Scalar conforms to FloatingPoint.
static func /= (inout Self, Self.Scalar)
Available when Scalar conforms to FixedWidthInteger.
static func /= (inout Self, Self)
Available when Scalar conforms to FixedWidthInteger.
static func == (Self, Self) -> Bool

Returns a Boolean value indicating whether two vectors are equal.

static func ^ (Self.Scalar, Self) -> Self
Available when Scalar conforms to FixedWidthInteger.
static func ^ (Self, Self.Scalar) -> Self
Available when Scalar conforms to FixedWidthInteger.
static func ^ (Self, Self) -> Self
Available when Scalar conforms to FixedWidthInteger.
static func ^= (inout Self, Self.Scalar)
Available when Scalar conforms to FixedWidthInteger.
static func ^= (inout Self, Self)
Available when Scalar conforms to FixedWidthInteger.
static func | (Self.Scalar, Self) -> Self
Available when Scalar conforms to FixedWidthInteger.
static func | (Self, Self.Scalar) -> Self
Available when Scalar conforms to FixedWidthInteger.
static func | (Self, Self) -> Self
Available when Scalar conforms to FixedWidthInteger.
static func |= (inout Self, Self.Scalar)
Available when Scalar conforms to FixedWidthInteger.
static func |= (inout Self, Self)
Available when Scalar conforms to FixedWidthInteger.
static func ~ (Self) -> Self
Available when Scalar conforms to FixedWidthInteger.

Relationships

Inherits From

Conforming Types

See Also

Supporting Types

protocol SIMDScalar

A type that can be used as an element in a SIMD vector.

protocol SIMDStorage

A type that can function as storage for a SIMD vector type.

struct SIMDMask