Struct core::simd::Simd

source · [−]
#[repr(simd)]
pub struct Simd<T, const LANES: usize>(_) 
where
    T: SimdElement,
    LaneCount<LANES>: SupportedLaneCount;
🔬 This is a nightly-only experimental API. (portable_simd #86656)
Expand description

A SIMD vector of LANES elements of type T. Simd<T, N> has the same shape as [T; N], but operates like T.

Two vectors of the same type and length will, by convention, support the operators (+, *, etc.) that T does. These take the lanes at each index on the left-hand side and right-hand side, perform the operation, and return the result in the same lane in a vector of equal size. For a given operator, this is equivalent to zipping the two arrays together and mapping the operator over each lane.

let a0: [i32; 4] = [-2, 0, 2, 4];
let a1 = [10, 9, 8, 7];
let zm_add = a0.zip(a1).map(|(lhs, rhs)| lhs + rhs);
let zm_mul = a0.zip(a1).map(|(lhs, rhs)| lhs * rhs);

// `Simd<T, N>` implements `From<[T; N]>
let (v0, v1) = (Simd::from(a0), Simd::from(a1));
// Which means arrays implement `Into<Simd<T, N>>`.
assert_eq!(v0 + v1, zm_add.into());
assert_eq!(v0 * v1, zm_mul.into());
Run

Simd with integers has the quirk that these operations are also inherently wrapping, as if T was Wrapping<T>. Thus, Simd does not implement wrapping_add, because that is the default behavior. This means there is no warning on overflows, even in “debug” builds. For most applications where Simd is appropriate, it is “not a bug” to wrap, and even “debug builds” are unlikely to tolerate the loss of performance. You may want to consider using explicitly checked arithmetic if such is required. Division by zero still causes a panic, so you may want to consider using floating point numbers if that is unacceptable.

Layout

Simd<T, N> has a layout similar to [T; N] (identical “shapes”), but with a greater alignment. [T; N] is aligned to T, but Simd<T, N> will have an alignment based on both T and N. It is thus sound to transmute Simd<T, N> to [T; N], and will typically optimize to zero cost, but the reverse transmutation is more likely to require a copy the compiler cannot simply elide.

ABI “Features”

Due to Rust’s safety guarantees, Simd<T, N> is currently passed to and from functions via memory, not SIMD registers, except as an optimization. #[inline] hints are recommended on functions that accept Simd<T, N> or return it. The need for this may be corrected in the future.

Safe SIMD with Unsafe Rust

Operations with Simd are typically safe, but there are many reasons to want to combine SIMD with unsafe code. Care must be taken to respect differences between Simd and other types it may be transformed into or derived from. In particular, the layout of Simd<T, N> may be similar to [T; N], and may allow some transmutations, but references to [T; N] are not interchangeable with those to Simd<T, N>. Thus, when using unsafe Rust to read and write Simd<T, N> through raw pointers, it is a good idea to first try with read_unaligned and write_unaligned. This is because:

  • read and write require full alignment (in this case, Simd<T, N>’s alignment)
  • the likely source for reading or destination for writing Simd<T, N> is [T] and similar types, aligned to T
  • combining these actions would violate the unsafe contract and explode the program into a puff of undefined behavior
  • the compiler can implicitly adjust layouts to make unaligned reads or writes fully aligned if it sees the optimization
  • most contemporary processors suffer no performance penalty for “unaligned” reads and writes that are aligned at runtime

By imposing less obligations, unaligned functions are less likely to make the program unsound, and may be just as fast as stricter alternatives. When trying to guarantee alignment, [T]::as_simd is an option for converting [T] to [Simd<T, N>], and allows soundly operating on an aligned SIMD body, but it may cost more time when handling the scalar head and tail. If these are not sufficient, then it is most ideal to design data structures to be already aligned to the Simd<T, N> you wish to use before using unsafe Rust to read or write. More conventional ways to compensate for these facts, like materializing Simd to or from an array first, are handled by safe methods like Simd::from_array and Simd::from_slice.

Implementations

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reducing wrapping add. Returns the sum of the lanes of the vector, with wrapping addition.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reducing wrapping multiply. Returns the product of the lanes of the vector, with wrapping multiplication.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reducing maximum. Returns the maximum lane in the vector.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reducing minimum. Returns the minimum lane in the vector.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reducing wrapping add. Returns the sum of the lanes of the vector, with wrapping addition.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reducing wrapping multiply. Returns the product of the lanes of the vector, with wrapping multiplication.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reducing maximum. Returns the maximum lane in the vector.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reducing minimum. Returns the minimum lane in the vector.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reducing wrapping add. Returns the sum of the lanes of the vector, with wrapping addition.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reducing wrapping multiply. Returns the product of the lanes of the vector, with wrapping multiplication.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reducing maximum. Returns the maximum lane in the vector.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reducing minimum. Returns the minimum lane in the vector.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reducing wrapping add. Returns the sum of the lanes of the vector, with wrapping addition.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reducing wrapping multiply. Returns the product of the lanes of the vector, with wrapping multiplication.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reducing maximum. Returns the maximum lane in the vector.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reducing minimum. Returns the minimum lane in the vector.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reducing wrapping add. Returns the sum of the lanes of the vector, with wrapping addition.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reducing wrapping multiply. Returns the product of the lanes of the vector, with wrapping multiplication.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reducing maximum. Returns the maximum lane in the vector.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reducing minimum. Returns the minimum lane in the vector.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reducing wrapping add. Returns the sum of the lanes of the vector, with wrapping addition.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reducing wrapping multiply. Returns the product of the lanes of the vector, with wrapping multiplication.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reducing maximum. Returns the maximum lane in the vector.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reducing minimum. Returns the minimum lane in the vector.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reducing wrapping add. Returns the sum of the lanes of the vector, with wrapping addition.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reducing wrapping multiply. Returns the product of the lanes of the vector, with wrapping multiplication.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reducing maximum. Returns the maximum lane in the vector.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reducing minimum. Returns the minimum lane in the vector.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reducing wrapping add. Returns the sum of the lanes of the vector, with wrapping addition.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reducing wrapping multiply. Returns the product of the lanes of the vector, with wrapping multiplication.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reducing maximum. Returns the maximum lane in the vector.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reducing minimum. Returns the minimum lane in the vector.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reducing wrapping add. Returns the sum of the lanes of the vector, with wrapping addition.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reducing wrapping multiply. Returns the product of the lanes of the vector, with wrapping multiplication.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reducing maximum. Returns the maximum lane in the vector.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reducing minimum. Returns the minimum lane in the vector.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reducing wrapping add. Returns the sum of the lanes of the vector, with wrapping addition.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reducing wrapping multiply. Returns the product of the lanes of the vector, with wrapping multiplication.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reducing maximum. Returns the maximum lane in the vector.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reducing minimum. Returns the minimum lane in the vector.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reducing add. Returns the sum of the lanes of the vector.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reducing multiply. Returns the product of the lanes of the vector.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reducing maximum. Returns the maximum lane in the vector.

Returns values based on equality, so a vector containing both 0. and -0. may return either. This function will not return NaN unless all lanes are NaN.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reducing minimum. Returns the minimum lane in the vector.

Returns values based on equality, so a vector containing both 0. and -0. may return either. This function will not return NaN unless all lanes are NaN.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reducing add. Returns the sum of the lanes of the vector.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reducing multiply. Returns the product of the lanes of the vector.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reducing maximum. Returns the maximum lane in the vector.

Returns values based on equality, so a vector containing both 0. and -0. may return either. This function will not return NaN unless all lanes are NaN.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reducing minimum. Returns the minimum lane in the vector.

Returns values based on equality, so a vector containing both 0. and -0. may return either. This function will not return NaN unless all lanes are NaN.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reducing bitwise “and”. Returns the cumulative bitwise “and” across the lanes of the vector.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reducing bitwise “or”. Returns the cumulative bitwise “or” across the lanes of the vector.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reducing bitwise “xor”. Returns the cumulative bitwise “xor” across the lanes of the vector.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reverse the order of the lanes in the vector.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Rotates the vector such that the first OFFSET elements of the slice move to the end while the last LANES - OFFSET elements move to the front. After calling rotate_lanes_left, the element previously in lane OFFSET will become the first element in the slice.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Rotates the vector such that the first LANES - OFFSET elements of the vector move to the end while the last OFFSET elements move to the front. After calling rotate_lanes_right, the element previously at index LANES - OFFSET will become the first element in the slice.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Interleave two vectors.

Produces two vectors with lanes taken alternately from self and other.

The first result contains the first LANES / 2 lanes from self and other, alternating, starting with the first lane of self.

The second result contains the last LANES / 2 lanes from self and other, alternating, starting with the lane LANES / 2 from the start of self.

#![feature(portable_simd)]
let a = Simd::from_array([0, 1, 2, 3]);
let b = Simd::from_array([4, 5, 6, 7]);
let (x, y) = a.interleave(b);
assert_eq!(x.to_array(), [0, 4, 1, 5]);
assert_eq!(y.to_array(), [2, 6, 3, 7]);
Run
🔬 This is a nightly-only experimental API. (portable_simd #86656)

Deinterleave two vectors.

The first result takes every other lane of self and then other, starting with the first lane.

The second result takes every other lane of self and then other, starting with the second lane.

#![feature(portable_simd)]
let a = Simd::from_array([0, 4, 1, 5]);
let b = Simd::from_array([2, 6, 3, 7]);
let (x, y) = a.deinterleave(b);
assert_eq!(x.to_array(), [0, 1, 2, 3]);
assert_eq!(y.to_array(), [4, 5, 6, 7]);
Run
🔬 This is a nightly-only experimental API. (portable_simd #86656)

Test if each lane is equal to the corresponding lane in other.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Test if each lane is not equal to the corresponding lane in other.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Test if each lane is less than the corresponding lane in other.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Test if each lane is greater than the corresponding lane in other.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Test if each lane is less than or equal to the corresponding lane in other.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Test if each lane is greater than or equal to the corresponding lane in other.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns the lane-wise minimum with other.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns the lane-wise maximum with other.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Restrict each lane to a certain interval.

For each lane, returns max if self is greater than max, and min if self is less than min. Otherwise returns self.

Panics

Panics if min > max on any lane.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns the lane-wise minimum with other.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns the lane-wise maximum with other.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Restrict each lane to a certain interval.

For each lane, returns max if self is greater than max, and min if self is less than min. Otherwise returns self.

Panics

Panics if min > max on any lane.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns the lane-wise minimum with other.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns the lane-wise maximum with other.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Restrict each lane to a certain interval.

For each lane, returns max if self is greater than max, and min if self is less than min. Otherwise returns self.

Panics

Panics if min > max on any lane.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns the lane-wise minimum with other.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns the lane-wise maximum with other.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Restrict each lane to a certain interval.

For each lane, returns max if self is greater than max, and min if self is less than min. Otherwise returns self.

Panics

Panics if min > max on any lane.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns the lane-wise minimum with other.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns the lane-wise maximum with other.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Restrict each lane to a certain interval.

For each lane, returns max if self is greater than max, and min if self is less than min. Otherwise returns self.

Panics

Panics if min > max on any lane.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns the lane-wise minimum with other.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns the lane-wise maximum with other.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Restrict each lane to a certain interval.

For each lane, returns max if self is greater than max, and min if self is less than min. Otherwise returns self.

Panics

Panics if min > max on any lane.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns the lane-wise minimum with other.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns the lane-wise maximum with other.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Restrict each lane to a certain interval.

For each lane, returns max if self is greater than max, and min if self is less than min. Otherwise returns self.

Panics

Panics if min > max on any lane.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns the lane-wise minimum with other.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns the lane-wise maximum with other.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Restrict each lane to a certain interval.

For each lane, returns max if self is greater than max, and min if self is less than min. Otherwise returns self.

Panics

Panics if min > max on any lane.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns the lane-wise minimum with other.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns the lane-wise maximum with other.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Restrict each lane to a certain interval.

For each lane, returns max if self is greater than max, and min if self is less than min. Otherwise returns self.

Panics

Panics if min > max on any lane.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns the lane-wise minimum with other.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns the lane-wise maximum with other.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Restrict each lane to a certain interval.

For each lane, returns max if self is greater than max, and min if self is less than min. Otherwise returns self.

Panics

Panics if min > max on any lane.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Lanewise saturating add.

Examples
let x = Simd::from_array([2, 1, 0, MAX]);
let max = Simd::splat(MAX);
let unsat = x + max;
let sat = x.saturating_add(max);
assert_eq!(unsat, Simd::from_array([1, 0, MAX, MAX - 1]));
assert_eq!(sat, max);
Run
🔬 This is a nightly-only experimental API. (portable_simd #86656)

Lanewise saturating subtract.

Examples
let x = Simd::from_array([2, 1, 0, MAX]);
let max = Simd::splat(MAX);
let unsat = x - max;
let sat = x.saturating_sub(max);
assert_eq!(unsat, Simd::from_array([3, 2, 1, 0]));
assert_eq!(sat, Simd::splat(0));
Run
🔬 This is a nightly-only experimental API. (portable_simd #86656)

Lanewise saturating add.

Examples
let x = Simd::from_array([2, 1, 0, MAX]);
let max = Simd::splat(MAX);
let unsat = x + max;
let sat = x.saturating_add(max);
assert_eq!(unsat, Simd::from_array([1, 0, MAX, MAX - 1]));
assert_eq!(sat, max);
Run
🔬 This is a nightly-only experimental API. (portable_simd #86656)

Lanewise saturating subtract.

Examples
let x = Simd::from_array([2, 1, 0, MAX]);
let max = Simd::splat(MAX);
let unsat = x - max;
let sat = x.saturating_sub(max);
assert_eq!(unsat, Simd::from_array([3, 2, 1, 0]));
assert_eq!(sat, Simd::splat(0));
Run
🔬 This is a nightly-only experimental API. (portable_simd #86656)

Lanewise saturating add.

Examples
let x = Simd::from_array([2, 1, 0, MAX]);
let max = Simd::splat(MAX);
let unsat = x + max;
let sat = x.saturating_add(max);
assert_eq!(unsat, Simd::from_array([1, 0, MAX, MAX - 1]));
assert_eq!(sat, max);
Run
🔬 This is a nightly-only experimental API. (portable_simd #86656)

Lanewise saturating subtract.

Examples
let x = Simd::from_array([2, 1, 0, MAX]);
let max = Simd::splat(MAX);
let unsat = x - max;
let sat = x.saturating_sub(max);
assert_eq!(unsat, Simd::from_array([3, 2, 1, 0]));
assert_eq!(sat, Simd::splat(0));
Run
🔬 This is a nightly-only experimental API. (portable_simd #86656)

Lanewise saturating add.

Examples
let x = Simd::from_array([2, 1, 0, MAX]);
let max = Simd::splat(MAX);
let unsat = x + max;
let sat = x.saturating_add(max);
assert_eq!(unsat, Simd::from_array([1, 0, MAX, MAX - 1]));
assert_eq!(sat, max);
Run
🔬 This is a nightly-only experimental API. (portable_simd #86656)

Lanewise saturating subtract.

Examples
let x = Simd::from_array([2, 1, 0, MAX]);
let max = Simd::splat(MAX);
let unsat = x - max;
let sat = x.saturating_sub(max);
assert_eq!(unsat, Simd::from_array([3, 2, 1, 0]));
assert_eq!(sat, Simd::splat(0));
Run
🔬 This is a nightly-only experimental API. (portable_simd #86656)

Lanewise saturating add.

Examples
let x = Simd::from_array([2, 1, 0, MAX]);
let max = Simd::splat(MAX);
let unsat = x + max;
let sat = x.saturating_add(max);
assert_eq!(unsat, Simd::from_array([1, 0, MAX, MAX - 1]));
assert_eq!(sat, max);
Run
🔬 This is a nightly-only experimental API. (portable_simd #86656)

Lanewise saturating subtract.

Examples
let x = Simd::from_array([2, 1, 0, MAX]);
let max = Simd::splat(MAX);
let unsat = x - max;
let sat = x.saturating_sub(max);
assert_eq!(unsat, Simd::from_array([3, 2, 1, 0]));
assert_eq!(sat, Simd::splat(0));
Run
🔬 This is a nightly-only experimental API. (portable_simd #86656)

Lanewise saturating add.

Examples
let x = Simd::from_array([MIN, 0, 1, MAX]);
let max = Simd::splat(MAX);
let unsat = x + max;
let sat = x.saturating_add(max);
assert_eq!(unsat, Simd::from_array([-1, MAX, MIN, -2]));
assert_eq!(sat, Simd::from_array([-1, MAX, MAX, MAX]));
Run
🔬 This is a nightly-only experimental API. (portable_simd #86656)

Lanewise saturating subtract.

Examples
let x = Simd::from_array([MIN, -2, -1, MAX]);
let max = Simd::splat(MAX);
let unsat = x - max;
let sat = x.saturating_sub(max);
assert_eq!(unsat, Simd::from_array([1, MAX, MIN, 0]));
assert_eq!(sat, Simd::from_array([MIN, MIN, MIN, 0]));
Run
🔬 This is a nightly-only experimental API. (portable_simd #86656)

Lanewise absolute value, implemented in Rust. Every lane becomes its absolute value.

Examples
let xs = Simd::from_array([MIN, MIN +1, -5, 0]);
assert_eq!(xs.abs(), Simd::from_array([MIN, MAX, 5, 0]));
Run
🔬 This is a nightly-only experimental API. (portable_simd #86656)

Lanewise saturating absolute value, implemented in Rust. As abs(), except the MIN value becomes MAX instead of itself.

Examples
let xs = Simd::from_array([MIN, -2, 0, 3]);
let unsat = xs.abs();
let sat = xs.saturating_abs();
assert_eq!(unsat, Simd::from_array([MIN, 2, 0, 3]));
assert_eq!(sat, Simd::from_array([MAX, 2, 0, 3]));
Run
🔬 This is a nightly-only experimental API. (portable_simd #86656)

Lanewise saturating negation, implemented in Rust. As neg(), except the MIN value becomes MAX instead of itself.

Examples
let x = Simd::from_array([MIN, -2, 3, MAX]);
let unsat = -x;
let sat = x.saturating_neg();
assert_eq!(unsat, Simd::from_array([MIN, 2, -3, MIN + 1]));
assert_eq!(sat, Simd::from_array([MAX, 2, -3, MIN + 1]));
Run
🔬 This is a nightly-only experimental API. (portable_simd #86656)

Lanewise saturating add.

Examples
let x = Simd::from_array([MIN, 0, 1, MAX]);
let max = Simd::splat(MAX);
let unsat = x + max;
let sat = x.saturating_add(max);
assert_eq!(unsat, Simd::from_array([-1, MAX, MIN, -2]));
assert_eq!(sat, Simd::from_array([-1, MAX, MAX, MAX]));
Run
🔬 This is a nightly-only experimental API. (portable_simd #86656)

Lanewise saturating subtract.

Examples
let x = Simd::from_array([MIN, -2, -1, MAX]);
let max = Simd::splat(MAX);
let unsat = x - max;
let sat = x.saturating_sub(max);
assert_eq!(unsat, Simd::from_array([1, MAX, MIN, 0]));
assert_eq!(sat, Simd::from_array([MIN, MIN, MIN, 0]));
Run
🔬 This is a nightly-only experimental API. (portable_simd #86656)

Lanewise absolute value, implemented in Rust. Every lane becomes its absolute value.

Examples
let xs = Simd::from_array([MIN, MIN +1, -5, 0]);
assert_eq!(xs.abs(), Simd::from_array([MIN, MAX, 5, 0]));
Run
🔬 This is a nightly-only experimental API. (portable_simd #86656)

Lanewise saturating absolute value, implemented in Rust. As abs(), except the MIN value becomes MAX instead of itself.

Examples
let xs = Simd::from_array([MIN, -2, 0, 3]);
let unsat = xs.abs();
let sat = xs.saturating_abs();
assert_eq!(unsat, Simd::from_array([MIN, 2, 0, 3]));
assert_eq!(sat, Simd::from_array([MAX, 2, 0, 3]));
Run
🔬 This is a nightly-only experimental API. (portable_simd #86656)

Lanewise saturating negation, implemented in Rust. As neg(), except the MIN value becomes MAX instead of itself.

Examples
let x = Simd::from_array([MIN, -2, 3, MAX]);
let unsat = -x;
let sat = x.saturating_neg();
assert_eq!(unsat, Simd::from_array([MIN, 2, -3, MIN + 1]));
assert_eq!(sat, Simd::from_array([MAX, 2, -3, MIN + 1]));
Run
🔬 This is a nightly-only experimental API. (portable_simd #86656)

Lanewise saturating add.

Examples
let x = Simd::from_array([MIN, 0, 1, MAX]);
let max = Simd::splat(MAX);
let unsat = x + max;
let sat = x.saturating_add(max);
assert_eq!(unsat, Simd::from_array([-1, MAX, MIN, -2]));
assert_eq!(sat, Simd::from_array([-1, MAX, MAX, MAX]));
Run
🔬 This is a nightly-only experimental API. (portable_simd #86656)

Lanewise saturating subtract.

Examples
let x = Simd::from_array([MIN, -2, -1, MAX]);
let max = Simd::splat(MAX);
let unsat = x - max;
let sat = x.saturating_sub(max);
assert_eq!(unsat, Simd::from_array([1, MAX, MIN, 0]));
assert_eq!(sat, Simd::from_array([MIN, MIN, MIN, 0]));
Run
🔬 This is a nightly-only experimental API. (portable_simd #86656)

Lanewise absolute value, implemented in Rust. Every lane becomes its absolute value.

Examples
let xs = Simd::from_array([MIN, MIN +1, -5, 0]);
assert_eq!(xs.abs(), Simd::from_array([MIN, MAX, 5, 0]));
Run
🔬 This is a nightly-only experimental API. (portable_simd #86656)

Lanewise saturating absolute value, implemented in Rust. As abs(), except the MIN value becomes MAX instead of itself.

Examples
let xs = Simd::from_array([MIN, -2, 0, 3]);
let unsat = xs.abs();
let sat = xs.saturating_abs();
assert_eq!(unsat, Simd::from_array([MIN, 2, 0, 3]));
assert_eq!(sat, Simd::from_array([MAX, 2, 0, 3]));
Run
🔬 This is a nightly-only experimental API. (portable_simd #86656)

Lanewise saturating negation, implemented in Rust. As neg(), except the MIN value becomes MAX instead of itself.

Examples
let x = Simd::from_array([MIN, -2, 3, MAX]);
let unsat = -x;
let sat = x.saturating_neg();
assert_eq!(unsat, Simd::from_array([MIN, 2, -3, MIN + 1]));
assert_eq!(sat, Simd::from_array([MAX, 2, -3, MIN + 1]));
Run
🔬 This is a nightly-only experimental API. (portable_simd #86656)

Lanewise saturating add.

Examples
let x = Simd::from_array([MIN, 0, 1, MAX]);
let max = Simd::splat(MAX);
let unsat = x + max;
let sat = x.saturating_add(max);
assert_eq!(unsat, Simd::from_array([-1, MAX, MIN, -2]));
assert_eq!(sat, Simd::from_array([-1, MAX, MAX, MAX]));
Run
🔬 This is a nightly-only experimental API. (portable_simd #86656)

Lanewise saturating subtract.

Examples
let x = Simd::from_array([MIN, -2, -1, MAX]);
let max = Simd::splat(MAX);
let unsat = x - max;
let sat = x.saturating_sub(max);
assert_eq!(unsat, Simd::from_array([1, MAX, MIN, 0]));
assert_eq!(sat, Simd::from_array([MIN, MIN, MIN, 0]));
Run
🔬 This is a nightly-only experimental API. (portable_simd #86656)

Lanewise absolute value, implemented in Rust. Every lane becomes its absolute value.

Examples
let xs = Simd::from_array([MIN, MIN +1, -5, 0]);
assert_eq!(xs.abs(), Simd::from_array([MIN, MAX, 5, 0]));
Run
🔬 This is a nightly-only experimental API. (portable_simd #86656)

Lanewise saturating absolute value, implemented in Rust. As abs(), except the MIN value becomes MAX instead of itself.

Examples
let xs = Simd::from_array([MIN, -2, 0, 3]);
let unsat = xs.abs();
let sat = xs.saturating_abs();
assert_eq!(unsat, Simd::from_array([MIN, 2, 0, 3]));
assert_eq!(sat, Simd::from_array([MAX, 2, 0, 3]));
Run
🔬 This is a nightly-only experimental API. (portable_simd #86656)

Lanewise saturating negation, implemented in Rust. As neg(), except the MIN value becomes MAX instead of itself.

Examples
let x = Simd::from_array([MIN, -2, 3, MAX]);
let unsat = -x;
let sat = x.saturating_neg();
assert_eq!(unsat, Simd::from_array([MIN, 2, -3, MIN + 1]));
assert_eq!(sat, Simd::from_array([MAX, 2, -3, MIN + 1]));
Run
🔬 This is a nightly-only experimental API. (portable_simd #86656)

Lanewise saturating add.

Examples
let x = Simd::from_array([MIN, 0, 1, MAX]);
let max = Simd::splat(MAX);
let unsat = x + max;
let sat = x.saturating_add(max);
assert_eq!(unsat, Simd::from_array([-1, MAX, MIN, -2]));
assert_eq!(sat, Simd::from_array([-1, MAX, MAX, MAX]));
Run
🔬 This is a nightly-only experimental API. (portable_simd #86656)

Lanewise saturating subtract.

Examples
let x = Simd::from_array([MIN, -2, -1, MAX]);
let max = Simd::splat(MAX);
let unsat = x - max;
let sat = x.saturating_sub(max);
assert_eq!(unsat, Simd::from_array([1, MAX, MIN, 0]));
assert_eq!(sat, Simd::from_array([MIN, MIN, MIN, 0]));
Run
🔬 This is a nightly-only experimental API. (portable_simd #86656)

Lanewise absolute value, implemented in Rust. Every lane becomes its absolute value.

Examples
let xs = Simd::from_array([MIN, MIN +1, -5, 0]);
assert_eq!(xs.abs(), Simd::from_array([MIN, MAX, 5, 0]));
Run
🔬 This is a nightly-only experimental API. (portable_simd #86656)

Lanewise saturating absolute value, implemented in Rust. As abs(), except the MIN value becomes MAX instead of itself.

Examples
let xs = Simd::from_array([MIN, -2, 0, 3]);
let unsat = xs.abs();
let sat = xs.saturating_abs();
assert_eq!(unsat, Simd::from_array([MIN, 2, 0, 3]));
assert_eq!(sat, Simd::from_array([MAX, 2, 0, 3]));
Run
🔬 This is a nightly-only experimental API. (portable_simd #86656)

Lanewise saturating negation, implemented in Rust. As neg(), except the MIN value becomes MAX instead of itself.

Examples
let x = Simd::from_array([MIN, -2, 3, MAX]);
let unsat = -x;
let sat = x.saturating_neg();
assert_eq!(unsat, Simd::from_array([MIN, 2, -3, MIN + 1]));
assert_eq!(sat, Simd::from_array([MAX, 2, -3, MIN + 1]));
Run
🔬 This is a nightly-only experimental API. (portable_simd #86656)

Rounds toward zero and converts to the same-width integer type, assuming that the value is finite and fits in that type.

Safety

The value must:

  • Not be NaN
  • Not be infinite
  • Be representable in the return type, after truncating off its fractional part

If these requirements are infeasible or costly, consider using the safe function cast, which saturates on conversion.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Rounds toward zero and converts to the same-width integer type, assuming that the value is finite and fits in that type.

Safety

The value must:

  • Not be NaN
  • Not be infinite
  • Be representable in the return type, after truncating off its fractional part

If these requirements are infeasible or costly, consider using the safe function cast, which saturates on conversion.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Raw transmutation to an unsigned integer vector type with the same size and number of lanes.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Raw transmutation from an unsigned integer vector type with the same size and number of lanes.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Produces a vector where every lane has the absolute value of the equivalently-indexed lane in self.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Takes the reciprocal (inverse) of each lane, 1/x.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Converts each lane from radians to degrees.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Converts each lane from degrees to radians.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns true for each lane if it has a positive sign, including +0.0, NaNs with positive sign bit and positive infinity.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns true for each lane if it has a negative sign, including -0.0, NaNs with negative sign bit and negative infinity.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns true for each lane if its value is NaN.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns true for each lane if its value is positive infinity or negative infinity.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns true for each lane if its value is neither infinite nor NaN.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns true for each lane if its value is subnormal.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns true for each lane if its value is neither zero, infinite, subnormal, nor NaN.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Replaces each lane with a number that represents its sign.

  • 1.0 if the number is positive, +0.0, or INFINITY
  • -1.0 if the number is negative, -0.0, or NEG_INFINITY
  • NAN if the number is NAN
🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns each lane with the magnitude of self and the sign of sign.

If any lane is a NAN, then a NAN with the sign of sign is returned.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns the minimum of each lane.

If one of the values is NAN, then the other value is returned.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns the maximum of each lane.

If one of the values is NAN, then the other value is returned.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Restrict each lane to a certain interval unless it is NaN.

For each lane in self, returns the corresponding lane in max if the lane is greater than max, and the corresponding lane in min if the lane is less than min. Otherwise returns the lane in self.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Raw transmutation to an unsigned integer vector type with the same size and number of lanes.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Raw transmutation from an unsigned integer vector type with the same size and number of lanes.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Produces a vector where every lane has the absolute value of the equivalently-indexed lane in self.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Takes the reciprocal (inverse) of each lane, 1/x.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Converts each lane from radians to degrees.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Converts each lane from degrees to radians.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns true for each lane if it has a positive sign, including +0.0, NaNs with positive sign bit and positive infinity.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns true for each lane if it has a negative sign, including -0.0, NaNs with negative sign bit and negative infinity.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns true for each lane if its value is NaN.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns true for each lane if its value is positive infinity or negative infinity.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns true for each lane if its value is neither infinite nor NaN.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns true for each lane if its value is subnormal.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns true for each lane if its value is neither zero, infinite, subnormal, nor NaN.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Replaces each lane with a number that represents its sign.

  • 1.0 if the number is positive, +0.0, or INFINITY
  • -1.0 if the number is negative, -0.0, or NEG_INFINITY
  • NAN if the number is NAN
🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns each lane with the magnitude of self and the sign of sign.

If any lane is a NAN, then a NAN with the sign of sign is returned.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns the minimum of each lane.

If one of the values is NAN, then the other value is returned.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns the maximum of each lane.

If one of the values is NAN, then the other value is returned.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Restrict each lane to a certain interval unless it is NaN.

For each lane in self, returns the corresponding lane in max if the lane is greater than max, and the corresponding lane in min if the lane is less than min. Otherwise returns the lane in self.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns true for each positive lane and false if it is zero or negative.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns true for each negative lane and false if it is zero or positive.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns numbers representing the sign of each lane.

  • 0 if the number is zero
  • 1 if the number is positive
  • -1 if the number is negative
🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns true for each positive lane and false if it is zero or negative.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns true for each negative lane and false if it is zero or positive.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns numbers representing the sign of each lane.

  • 0 if the number is zero
  • 1 if the number is positive
  • -1 if the number is negative
🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns true for each positive lane and false if it is zero or negative.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns true for each negative lane and false if it is zero or positive.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns numbers representing the sign of each lane.

  • 0 if the number is zero
  • 1 if the number is positive
  • -1 if the number is negative
🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns true for each positive lane and false if it is zero or negative.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns true for each negative lane and false if it is zero or positive.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns numbers representing the sign of each lane.

  • 0 if the number is zero
  • 1 if the number is positive
  • -1 if the number is negative
🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns true for each positive lane and false if it is zero or negative.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns true for each negative lane and false if it is zero or positive.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns numbers representing the sign of each lane.

  • 0 if the number is zero
  • 1 if the number is positive
  • -1 if the number is negative
🔬 This is a nightly-only experimental API. (portable_simd #86656)

Number of lanes in this vector.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Get the number of lanes in this vector.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Construct a SIMD vector by setting all lanes to the given value.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns an array reference containing the entire SIMD vector.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Returns a mutable array reference containing the entire SIMD vector.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Converts an array to a SIMD vector.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Converts a SIMD vector to an array.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Converts a slice to a SIMD vector containing slice[..LANES]

Panics

from_slice will panic if the slice’s len is less than the vector’s Simd::LANES.

🔬 This is a nightly-only experimental API. (portable_simd #86656)

Performs lanewise conversion of a SIMD vector’s elements to another SIMD-valid type. This follows the semantics of Rust’s as conversion for casting integers to unsigned integers (interpreting as the other type, so -1 to MAX), and from floats to integers (truncating, or saturating at the limits) for each lane, or vice versa.

Examples
let floats: Simd<f32, 4> = Simd::from_array([1.9, -4.5, f32::INFINITY, f32::NAN]);
let ints = floats.cast::<i32>();
assert_eq!(ints, Simd::from_array([1, -4, i32::MAX, 0]));

// Formally equivalent, but `Simd::cast` can optimize better.
assert_eq!(ints, Simd::from_array(floats.to_array().map(|x| x as i32)));

// The float conversion does not round-trip.
let floats_again = ints.cast();
assert_ne!(floats, floats_again);
assert_eq!(floats_again, Simd::from_array([1.0, -4.0, 2147483647.0, 0.0]));
Run
🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reads from potentially discontiguous indices in slice to construct a SIMD vector. If an index is out-of-bounds, the lane is instead selected from the or vector.

Examples
let vec: Vec<i32> = vec![10, 11, 12, 13, 14, 15, 16, 17, 18];
let idxs = Simd::from_array([9, 3, 0, 5]);
let alt = Simd::from_array([-5, -4, -3, -2]);

let result = Simd::gather_or(&vec, idxs, alt); // Note the lane that is out-of-bounds.
assert_eq!(result, Simd::from_array([-5, 13, 10, 15]));
Run
🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reads from potentially discontiguous indices in slice to construct a SIMD vector. If an index is out-of-bounds, the lane is set to the default value for the type.

Examples
let vec: Vec<i32> = vec![10, 11, 12, 13, 14, 15, 16, 17, 18];
let idxs = Simd::from_array([9, 3, 0, 5]);

let result = Simd::gather_or_default(&vec, idxs); // Note the lane that is out-of-bounds.
assert_eq!(result, Simd::from_array([0, 13, 10, 15]));
Run
🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reads from potentially discontiguous indices in slice to construct a SIMD vector. The mask enables all true lanes and disables all false lanes. If an index is disabled or is out-of-bounds, the lane is selected from the or vector.

Examples
let vec: Vec<i32> = vec![10, 11, 12, 13, 14, 15, 16, 17, 18];
let idxs = Simd::from_array([9, 3, 0, 5]);
let alt = Simd::from_array([-5, -4, -3, -2]);
let enable = Mask::from_array([true, true, true, false]); // Note the mask of the last lane.

let result = Simd::gather_select(&vec, enable, idxs, alt); // Note the lane that is out-of-bounds.
assert_eq!(result, Simd::from_array([-5, 13, 10, -2]));
Run
🔬 This is a nightly-only experimental API. (portable_simd #86656)

Reads from potentially discontiguous indices in slice to construct a SIMD vector. The mask enables all true lanes and disables all false lanes. If an index is disabled, the lane is selected from the or vector.

Safety

Calling this function with an enabled out-of-bounds index is undefined behavior even if the resulting value is not used.

Examples
let vec: Vec<i32> = vec![10, 11, 12, 13, 14, 15, 16, 17, 18];
let idxs = Simd::from_array([9, 3, 0, 5]);
let alt = Simd::from_array([-5, -4, -3, -2]);
let enable = Mask::from_array([true, true, true, false]); // Note the final mask lane.
// If this mask was used to gather, it would be unsound. Let's fix that.
let enable = enable & idxs.lanes_lt(Simd::splat(vec.len()));

// We have masked the OOB lane, so it's safe to gather now.
let result = unsafe { Simd::gather_select_unchecked(&vec, enable, idxs, alt) };
assert_eq!(result, Simd::from_array([-5, 13, 10, -2]));
Run
🔬 This is a nightly-only experimental API. (portable_simd #86656)

Writes the values in a SIMD vector to potentially discontiguous indices in slice. If two lanes in the scattered vector would write to the same index only the last lane is guaranteed to actually be written.

Examples
let mut vec: Vec<i32> = vec![10, 11, 12, 13, 14, 15, 16, 17, 18];
let idxs = Simd::from_array([9, 3, 0, 0]);
let vals = Simd::from_array([-27, 82, -41, 124]);

vals.scatter(&mut vec, idxs); // index 0 receives two writes.
assert_eq!(vec, vec![124, 11, 12, 82, 14, 15, 16, 17, 18]);
Run
🔬 This is a nightly-only experimental API. (portable_simd #86656)

Writes the values in a SIMD vector to multiple potentially discontiguous indices in slice. The mask enables all true lanes and disables all false lanes. If an enabled index is out-of-bounds, the lane is not written. If two enabled lanes in the scattered vector would write to the same index, only the last lane is guaranteed to actually be written.

Examples
let mut vec: Vec<i32> = vec![10, 11, 12, 13, 14, 15, 16, 17, 18];
let idxs = Simd::from_array([9, 3, 0, 0]);
let vals = Simd::from_array([-27, 82, -41, 124]);
let enable = Mask::from_array([true, true, true, false]); // Note the mask of the last lane.

vals.scatter_select(&mut vec, enable, idxs); // index 0's second write is masked, thus omitted.
assert_eq!(vec, vec![-41, 11, 12, 82, 14, 15, 16, 17, 18]);
Run
🔬 This is a nightly-only experimental API. (portable_simd #86656)

Writes the values in a SIMD vector to multiple potentially discontiguous indices in slice. The mask enables all true lanes and disables all false lanes. If two enabled lanes in the scattered vector would write to the same index, only the last lane is guaranteed to actually be written.

Safety

Calling this function with an enabled out-of-bounds index is undefined behavior, and may lead to memory corruption.

Examples
let mut vec: Vec<i32> = vec![10, 11, 12, 13, 14, 15, 16, 17, 18];
let idxs = Simd::from_array([9, 3, 0, 0]);
let vals = Simd::from_array([-27, 82, -41, 124]);
let enable = Mask::from_array([true, true, true, false]); // Note the mask of the last lane.
// If this mask was used to scatter, it would be unsound. Let's fix that.
let enable = enable & idxs.lanes_lt(Simd::splat(vec.len()));

// We have masked the OOB lane, so it's safe to scatter now.
unsafe { vals.scatter_select_unchecked(&mut vec, enable, idxs); }
// index 0's second write is masked, thus was omitted.
assert_eq!(vec, vec![-41, 11, 12, 82, 14, 15, 16, 17, 18]);
Run

Trait Implementations

The resulting type after applying the + operator.

Performs the + operation. Read more

The resulting type after applying the + operator.

Performs the + operation. Read more

The resulting type after applying the + operator.

Performs the + operation. Read more

The resulting type after applying the + operator.

Performs the + operation. Read more

The resulting type after applying the + operator.

Performs the + operation. Read more

The resulting type after applying the + operator.

Performs the + operation. Read more

The resulting type after applying the + operator.

Performs the + operation. Read more

The resulting type after applying the + operator.

Performs the + operation. Read more

The resulting type after applying the + operator.

Performs the + operation. Read more

The resulting type after applying the + operator.

Performs the + operation. Read more

The resulting type after applying the + operator.

Performs the + operation. Read more

The resulting type after applying the + operator.

Performs the + operation. Read more

The resulting type after applying the + operator.

Performs the + operation. Read more

The resulting type after applying the + operator.

Performs the + operation. Read more

The resulting type after applying the + operator.

Performs the + operation. Read more

Performs the += operation. Read more

Converts this type into a mutable reference of the (usually inferred) input type.

Converts this type into a mutable reference of the (usually inferred) input type.

Converts this type into a shared reference of the (usually inferred) input type.

Converts this type into a shared reference of the (usually inferred) input type.

Formats the value using the given formatter.

The resulting type after applying the & operator.

Performs the & operation. Read more

The resulting type after applying the & operator.

Performs the & operation. Read more

The resulting type after applying the & operator.

Performs the & operation. Read more

The resulting type after applying the & operator.

Performs the & operation. Read more

The resulting type after applying the & operator.

Performs the & operation. Read more

The resulting type after applying the & operator.

Performs the & operation. Read more

The resulting type after applying the & operator.

Performs the & operation. Read more

The resulting type after applying the & operator.

Performs the & operation. Read more

The resulting type after applying the & operator.

Performs the & operation. Read more

The resulting type after applying the & operator.

Performs the & operation. Read more

The resulting type after applying the & operator.

Performs the & operation. Read more

The resulting type after applying the & operator.

Performs the & operation. Read more

The resulting type after applying the & operator.

Performs the & operation. Read more

Performs the &= operation. Read more

The resulting type after applying the | operator.

Performs the | operation. Read more

The resulting type after applying the | operator.

Performs the | operation. Read more

The resulting type after applying the | operator.

Performs the | operation. Read more

The resulting type after applying the | operator.

Performs the | operation. Read more

The resulting type after applying the | operator.

Performs the | operation. Read more

The resulting type after applying the | operator.

Performs the | operation. Read more

The resulting type after applying the | operator.

Performs the | operation. Read more

The resulting type after applying the | operator.

Performs the | operation. Read more

The resulting type after applying the | operator.

Performs the | operation. Read more

The resulting type after applying the | operator.

Performs the | operation. Read more

The resulting type after applying the | operator.

Performs the | operation. Read more

The resulting type after applying the | operator.

Performs the | operation. Read more

The resulting type after applying the | operator.

Performs the | operation. Read more

Performs the |= operation. Read more

The resulting type after applying the ^ operator.

Performs the ^ operation. Read more

The resulting type after applying the ^ operator.

Performs the ^ operation. Read more

The resulting type after applying the ^ operator.

Performs the ^ operation. Read more

The resulting type after applying the ^ operator.

Performs the ^ operation. Read more

The resulting type after applying the ^ operator.

Performs the ^ operation. Read more

The resulting type after applying the ^ operator.

Performs the ^ operation. Read more

The resulting type after applying the ^ operator.

Performs the ^ operation. Read more

The resulting type after applying the ^ operator.

Performs the ^ operation. Read more

The resulting type after applying the ^ operator.

Performs the ^ operation. Read more

The resulting type after applying the ^ operator.

Performs the ^ operation. Read more

The resulting type after applying the ^ operator.

Performs the ^ operation. Read more

The resulting type after applying the ^ operator.

Performs the ^ operation. Read more

The resulting type after applying the ^ operator.

Performs the ^ operation. Read more

Performs the ^= operation. Read more

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Returns the “default value” for a type. Read more

The resulting type after applying the / operator.

Performs the / operation. Read more

The resulting type after applying the / operator.

Performs the / operation. Read more

The resulting type after applying the / operator.

Performs the / operation. Read more

The resulting type after applying the / operator.

Performs the / operation. Read more

The resulting type after applying the / operator.

Performs the / operation. Read more

The resulting type after applying the / operator.

Performs the / operation. Read more

The resulting type after applying the / operator.

Performs the / operation. Read more

The resulting type after applying the / operator.

Performs the / operation. Read more

The resulting type after applying the / operator.

Performs the / operation. Read more

The resulting type after applying the / operator.

Performs the / operation. Read more

The resulting type after applying the / operator.

Performs the / operation. Read more

The resulting type after applying the / operator.

Performs the / operation. Read more

The resulting type after applying the / operator.

Performs the / operation. Read more

The resulting type after applying the / operator.

Performs the / operation. Read more

The resulting type after applying the / operator.

Performs the / operation. Read more

Performs the /= operation. Read more

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Feeds this value into the given Hasher. Read more

Feeds a slice of this type into the given Hasher. Read more

The returned type after indexing.

Performs the indexing (container[index]) operation. Read more

Performs the mutable indexing (container[index]) operation. Read more

Formats the value using the given formatter.

Formats the value using the given formatter.

The resulting type after applying the * operator.

Performs the * operation. Read more

The resulting type after applying the * operator.

Performs the * operation. Read more

The resulting type after applying the * operator.

Performs the * operation. Read more

The resulting type after applying the * operator.

Performs the * operation. Read more

The resulting type after applying the * operator.

Performs the * operation. Read more

The resulting type after applying the * operator.

Performs the * operation. Read more

The resulting type after applying the * operator.

Performs the * operation. Read more

The resulting type after applying the * operator.

Performs the * operation. Read more

The resulting type after applying the * operator.

Performs the * operation. Read more

The resulting type after applying the * operator.

Performs the * operation. Read more

The resulting type after applying the * operator.

Performs the * operation. Read more

The resulting type after applying the * operator.

Performs the * operation. Read more

The resulting type after applying the * operator.

Performs the * operation. Read more

The resulting type after applying the * operator.

Performs the * operation. Read more

The resulting type after applying the * operator.

Performs the * operation. Read more

Performs the *= operation. Read more

The resulting type after applying the - operator.

Performs the unary - operation. Read more

The resulting type after applying the - operator.

Performs the unary - operation. Read more

The resulting type after applying the - operator.

Performs the unary - operation. Read more

The resulting type after applying the - operator.

Performs the unary - operation. Read more

The resulting type after applying the - operator.

Performs the unary - operation. Read more

The resulting type after applying the - operator.

Performs the unary - operation. Read more

The resulting type after applying the - operator.

Performs the unary - operation. Read more

The resulting type after applying the ! operator.

Performs the unary ! operation. Read more

The resulting type after applying the ! operator.

Performs the unary ! operation. Read more

The resulting type after applying the ! operator.

Performs the unary ! operation. Read more

The resulting type after applying the ! operator.

Performs the unary ! operation. Read more

The resulting type after applying the ! operator.

Performs the unary ! operation. Read more

The resulting type after applying the ! operator.

Performs the unary ! operation. Read more

The resulting type after applying the ! operator.

Performs the unary ! operation. Read more

The resulting type after applying the ! operator.

Performs the unary ! operation. Read more

The resulting type after applying the ! operator.

Performs the unary ! operation. Read more

The resulting type after applying the ! operator.

Performs the unary ! operation. Read more

Formats the value using the given formatter.

This method returns an Ordering between self and other. Read more

Compares and returns the maximum of two values. Read more

Compares and returns the minimum of two values. Read more

Restrict a value to a certain interval. Read more

This method tests for self and other values to be equal, and is used by ==. Read more

This method tests for !=.

This method returns an ordering between self and other values if one exists. Read more

This method tests less than (for self and other) and is used by the < operator. Read more

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

This method tests greater than (for self and other) and is used by the > operator. Read more

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

Method which takes an iterator and generates Self from the elements by multiplying the items. Read more

Method which takes an iterator and generates Self from the elements by multiplying the items. Read more

Method which takes an iterator and generates Self from the elements by multiplying the items. Read more

Method which takes an iterator and generates Self from the elements by multiplying the items. Read more

Method which takes an iterator and generates Self from the elements by multiplying the items. Read more

Method which takes an iterator and generates Self from the elements by multiplying the items. Read more

Method which takes an iterator and generates Self from the elements by multiplying the items. Read more

Method which takes an iterator and generates Self from the elements by multiplying the items. Read more

Method which takes an iterator and generates Self from the elements by multiplying the items. Read more

Method which takes an iterator and generates Self from the elements by multiplying the items. Read more

Method which takes an iterator and generates Self from the elements by multiplying the items. Read more

Method which takes an iterator and generates Self from the elements by multiplying the items. Read more

Method which takes an iterator and generates Self from the elements by multiplying the items. Read more

Method which takes an iterator and generates Self from the elements by multiplying the items. Read more

Method which takes an iterator and generates Self from the elements by multiplying the items. Read more

Method which takes an iterator and generates Self from the elements by multiplying the items. Read more

Method which takes an iterator and generates Self from the elements by multiplying the items. Read more

Method which takes an iterator and generates Self from the elements by multiplying the items. Read more

Method which takes an iterator and generates Self from the elements by multiplying the items. Read more

Method which takes an iterator and generates Self from the elements by multiplying the items. Read more

Method which takes an iterator and generates Self from the elements by multiplying the items. Read more

Method which takes an iterator and generates Self from the elements by multiplying the items. Read more

Method which takes an iterator and generates Self from the elements by multiplying the items. Read more

Method which takes an iterator and generates Self from the elements by multiplying the items. Read more

The resulting type after applying the % operator.

Performs the % operation. Read more

The resulting type after applying the % operator.

Performs the % operation. Read more

The resulting type after applying the % operator.

Performs the % operation. Read more

The resulting type after applying the % operator.

Performs the % operation. Read more

The resulting type after applying the % operator.

Performs the % operation. Read more

The resulting type after applying the % operator.

Performs the % operation. Read more

The resulting type after applying the % operator.

Performs the % operation. Read more

The resulting type after applying the % operator.

Performs the % operation. Read more

The resulting type after applying the % operator.

Performs the % operation. Read more

The resulting type after applying the % operator.

Performs the % operation. Read more

The resulting type after applying the % operator.

Performs the % operation. Read more

The resulting type after applying the % operator.

Performs the % operation. Read more

The resulting type after applying the % operator.

Performs the % operation. Read more

The resulting type after applying the % operator.

Performs the % operation. Read more

The resulting type after applying the % operator.

Performs the % operation. Read more

Performs the %= operation. Read more

The resulting type after applying the << operator.

Performs the << operation. Read more

The resulting type after applying the << operator.

Performs the << operation. Read more

The resulting type after applying the << operator.

Performs the << operation. Read more

The resulting type after applying the << operator.

Performs the << operation. Read more

The resulting type after applying the << operator.

Performs the << operation. Read more

The resulting type after applying the << operator.

Performs the << operation. Read more

The resulting type after applying the << operator.

Performs the << operation. Read more

The resulting type after applying the << operator.

Performs the << operation. Read more

The resulting type after applying the << operator.

Performs the << operation. Read more

The resulting type after applying the << operator.

Performs the << operation. Read more

The resulting type after applying the << operator.

Performs the << operation. Read more

The resulting type after applying the << operator.

Performs the << operation. Read more

The resulting type after applying the << operator.

Performs the << operation. Read more

Performs the <<= operation. Read more

The resulting type after applying the >> operator.

Performs the >> operation. Read more

The resulting type after applying the >> operator.

Performs the >> operation. Read more

The resulting type after applying the >> operator.

Performs the >> operation. Read more

The resulting type after applying the >> operator.

Performs the >> operation. Read more

The resulting type after applying the >> operator.

Performs the >> operation. Read more

The resulting type after applying the >> operator.

Performs the >> operation. Read more

The resulting type after applying the >> operator.

Performs the >> operation. Read more

The resulting type after applying the >> operator.

Performs the >> operation. Read more

The resulting type after applying the >> operator.

Performs the >> operation. Read more

The resulting type after applying the >> operator.

Performs the >> operation. Read more

The resulting type after applying the >> operator.

Performs the >> operation. Read more

The resulting type after applying the >> operator.

Performs the >> operation. Read more

The resulting type after applying the >> operator.

Performs the >> operation. Read more

Performs the >>= operation. Read more

The resulting type after applying the - operator.

Performs the - operation. Read more

The resulting type after applying the - operator.

Performs the - operation. Read more

The resulting type after applying the - operator.

Performs the - operation. Read more

The resulting type after applying the - operator.

Performs the - operation. Read more

The resulting type after applying the - operator.

Performs the - operation. Read more

The resulting type after applying the - operator.

Performs the - operation. Read more

The resulting type after applying the - operator.

Performs the - operation. Read more

The resulting type after applying the - operator.

Performs the - operation. Read more

The resulting type after applying the - operator.

Performs the - operation. Read more

The resulting type after applying the - operator.

Performs the - operation. Read more

The resulting type after applying the - operator.

Performs the - operation. Read more

The resulting type after applying the - operator.

Performs the - operation. Read more

The resulting type after applying the - operator.

Performs the - operation. Read more

The resulting type after applying the - operator.

Performs the - operation. Read more

The resulting type after applying the - operator.

Performs the - operation. Read more

Performs the -= operation. Read more

Method which takes an iterator and generates Self from the elements by “summing up” the items. Read more

Method which takes an iterator and generates Self from the elements by “summing up” the items. Read more

Method which takes an iterator and generates Self from the elements by “summing up” the items. Read more

Method which takes an iterator and generates Self from the elements by “summing up” the items. Read more

Method which takes an iterator and generates Self from the elements by “summing up” the items. Read more

Method which takes an iterator and generates Self from the elements by “summing up” the items. Read more

Method which takes an iterator and generates Self from the elements by “summing up” the items. Read more

Method which takes an iterator and generates Self from the elements by “summing up” the items. Read more

Method which takes an iterator and generates Self from the elements by “summing up” the items. Read more

Method which takes an iterator and generates Self from the elements by “summing up” the items. Read more

Method which takes an iterator and generates Self from the elements by “summing up” the items. Read more

Method which takes an iterator and generates Self from the elements by “summing up” the items. Read more

Method which takes an iterator and generates Self from the elements by “summing up” the items. Read more

Method which takes an iterator and generates Self from the elements by “summing up” the items. Read more

Method which takes an iterator and generates Self from the elements by “summing up” the items. Read more

Method which takes an iterator and generates Self from the elements by “summing up” the items. Read more

Method which takes an iterator and generates Self from the elements by “summing up” the items. Read more

Method which takes an iterator and generates Self from the elements by “summing up” the items. Read more

Method which takes an iterator and generates Self from the elements by “summing up” the items. Read more

Method which takes an iterator and generates Self from the elements by “summing up” the items. Read more

Method which takes an iterator and generates Self from the elements by “summing up” the items. Read more

Method which takes an iterator and generates Self from the elements by “summing up” the items. Read more

Method which takes an iterator and generates Self from the elements by “summing up” the items. Read more

Method which takes an iterator and generates Self from the elements by “summing up” the items. Read more

Formats the value using the given formatter.

Formats the value using the given formatter.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

This documentation is an old archive. Please see https://rust.docs.kernel.org instead.