Struct safe_arch::m256

#[repr(transparent)]pub struct m256(pub __m256);

The data for a 256-bit AVX register of eight f32 lanes.

• This is very similar to having [f32; 8]. The main difference is that it's aligned to 32 instead of just 4, and of course you can perform various intrinsic operations on it.

Implementations

impl m256

#[must_use]pub fn to_array(self) -> [f32; 8]

Transmutes the m256 to an array.

Same as m.into(), just lets you be more explicit about what's happening.

#[must_use]pub fn from_array(f: [f32; 8]) -> Self

Transmutes an array into m256.

Same as m256::from(arr), it just lets you be more explicit about what's happening.

#[must_use]pub fn to_bits(self) -> [u32; 8]

Converts into the bit patterns of these floats ([u32;8]).

Like f32::to_bits, but all eight lanes at once.

#[must_use]pub fn from_bits(bits: [u32; 8]) -> Self

Converts from the bit patterns of these floats ([u32;8]).

Like f32::from_bits, but all eight lanes at once.

Trait Implementations

impl Add<m256> for m256

type Output = Self

The resulting type after applying the + operator.

#[must_use]fn add(self, rhs: Self) -> Self

Performs the + operation.

impl AddAssign<m256> for m256

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Binary for m256

fn fmt(&self, f: &mut Formatter) -> Result

Binary formats each float's bit pattern (via f32::to_bits).

let f = format!("{:b}", m256::default());
assert_eq!(&f, "(0, 0, 0, 0, 0, 0, 0, 0)");

impl BitAnd<m256> for m256

type Output = Self

The resulting type after applying the & operator.

#[must_use]fn bitand(self, rhs: Self) -> Self

Performs the & operation.

impl BitAndAssign<m256> for m256

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl BitOr<m256> for m256

type Output = Self

The resulting type after applying the | operator.

#[must_use]fn bitor(self, rhs: Self) -> Self

Performs the | operation.

impl BitOrAssign<m256> for m256

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl BitXor<m256> for m256

type Output = Self

The resulting type after applying the ^ operator.

#[must_use]fn bitxor(self, rhs: Self) -> Self

Performs the ^ operation.

impl BitXorAssign<m256> for m256

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl Clone for m256

#[must_use]fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for m256

impl Debug for m256

fn fmt(&self, f: &mut Formatter) -> Result

Debug formats each float.

let f = format!("{:?}", m256::default());
assert_eq!(&f, "m256(0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0)");

impl Default for m256

#[must_use]fn default() -> Self

Returns the "default value" for a type.

impl Display for m256

fn fmt(&self, f: &mut Formatter) -> Result

Display formats each float, and leaves the type name off of the font.

let f = format!("{}", m256::default());
assert_eq!(&f, "(0, 0, 0, 0, 0, 0, 0, 0)");

impl Div<m256> for m256

type Output = Self

The resulting type after applying the / operator.

#[must_use]fn div(self, rhs: Self) -> Self

Performs the / operation.

impl DivAssign<m256> for m256

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl From<[f32; 8]> for m256

#[must_use]fn from(arr: [f32; 8]) -> Self

Performs the conversion.

impl From<m256> for [f32; 8]

#[must_use]fn from(m: m256) -> Self

Performs the conversion.

impl LowerExp for m256

fn fmt(&self, f: &mut Formatter) -> Result

LowerExp formats each float.

let f = format!("{:e}", m256::default());
assert_eq!(&f, "(0e0, 0e0, 0e0, 0e0, 0e0, 0e0, 0e0, 0e0)");

impl LowerHex for m256

fn fmt(&self, f: &mut Formatter) -> Result

LowerHex formats each float's bit pattern (via f32::to_bits).

let f = format!("{:x}", m256::default());
assert_eq!(&f, "(0, 0, 0, 0, 0, 0, 0, 0)");

impl Mul<m256> for m256

type Output = Self

The resulting type after applying the * operator.

#[must_use]fn mul(self, rhs: Self) -> Self

Performs the * operation.

impl MulAssign<m256> for m256

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl Neg for m256

type Output = Self

The resulting type after applying the - operator.

#[must_use]fn neg(self) -> Self

Performs the unary - operation.

impl Not for m256

type Output = Self

The resulting type after applying the ! operator.

#[must_use]fn not(self) -> Self

Not a direct intrinsic, but it's very useful and the implementation is simple enough.

Negates the bits by performing an xor with an all-1s bit pattern.

impl Octal for m256

fn fmt(&self, f: &mut Formatter) -> Result

Octal formats each float's bit pattern (via f32::to_bits).

let f = format!("{:o}", m256::default());
assert_eq!(&f, "(0, 0, 0, 0, 0, 0, 0, 0)");

impl PartialEq<m256> for m256

#[must_use]fn eq(&self, other: &Self) -> bool

let a = m256::from([1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0]);
let b = m256::from([9.0, 10.0, 11.0, 12.0, 13.0, 14.0, 15.0, 16.0]);
assert!(a == a);
assert!(a != b);

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Pod for m256

impl Sub<m256> for m256

type Output = Self

The resulting type after applying the - operator.

#[must_use]fn sub(self, rhs: Self) -> Self

Performs the - operation.

impl SubAssign<m256> for m256

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl TransparentWrapper<__m256> for m256

fn wrap_ref(s: &Wrapped) -> &Self

Convert a reference to a wrapped type into a reference to the wrapper.

fn wrap_mut(s: &mut Wrapped) -> &mut Self

Convert a mut reference to a wrapped type into a mut reference to the wrapper.

impl UpperExp for m256

fn fmt(&self, f: &mut Formatter) -> Result

UpperExp formats each float.

let f = format!("{:E}", m256::default());
assert_eq!(&f, "(0E0, 0E0, 0E0, 0E0, 0E0, 0E0, 0E0, 0E0)");

impl UpperHex for m256

fn fmt(&self, f: &mut Formatter) -> Result

UpperHex formats each float's bit pattern (via f32::to_bits).

let f = format!("{:X}", m256::default());
assert_eq!(&f, "(0, 0, 0, 0, 0, 0, 0, 0)");

impl Zeroable for m256

fn zeroed() -> Self

Calls zeroed.