Skip to main content

ArrayFlags

Struct ArrayFlags 

Source
pub struct ArrayFlags {
    pub c_contiguous: bool,
    pub f_contiguous: bool,
    pub owndata: bool,
    pub writeable: bool,
    pub aligned: bool,
}
Expand description

Flags describing the memory properties of an array.

Mirrors NumPy’s arr.flags field: a flat collection of independent boolean memory-layout properties. The names map 1:1 to NumPy and are accessed individually by callers, so a bitfield-style enum would hurt ergonomics rather than help.

Fields§

§c_contiguous: bool

Whether the data is C-contiguous (row-major).

§f_contiguous: bool

Whether the data is Fortran-contiguous (column-major).

§owndata: bool

Whether the array owns its data.

§writeable: bool

Whether the array is writeable.

§aligned: bool

Whether the underlying data pointer is properly aligned for the element type (#345). Mirrors numpy’s NPY_ARRAY_ALIGNED flag.

Owned arrays produced through ferray’s safe constructors are always aligned because they go through Vec<T> which the allocator guarantees to align for T. Views constructed via from_shape_ptr from a raw pointer can be misaligned and will report aligned = false here so callers can detect the degenerate case before passing into a SIMD path.

Trait Implementations§

Source§

impl Clone for ArrayFlags

Source§

fn clone(&self) -> ArrayFlags

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for ArrayFlags

Source§

impl Debug for ArrayFlags

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for ArrayFlags

Source§

impl PartialEq for ArrayFlags

Source§

fn eq(&self, other: &ArrayFlags) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for ArrayFlags

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.