#[non_exhaustive]
pub enum Order { RowMajor, ColumnMajor, }
Expand description

Array order

Order refers to indexing order, or how a linear sequence is translated into a two-dimensional or multi-dimensional array.

  • RowMajor means that the index along the row is the most rapidly changing
  • ColumnMajor means that the index along the column is the most rapidly changing

Given a sequence like: 1, 2, 3, 4, 5, 6

If it is laid it out in a 2 x 3 matrix using row major ordering, it results in:

1  2  3
4  5  6

If it is laid using column major ordering, it results in:

1  3  5
2  4  6

It can be seen as filling in “rows first” or “columns first”.

Order can be used both to refer to logical ordering as well as memory ordering or memory layout. The orderings have common short names, also seen in other environments, where row major is called “C” order (after the C programming language) and column major is called “F” or “Fortran” order.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

RowMajor

Row major or “C” order

§

ColumnMajor

Column major or “F” order

Implementations§

source§

impl Order

source

pub const C: Order = Order::RowMajor

“C” is an alias for row major ordering

source

pub const F: Order = Order::ColumnMajor

“F” (for Fortran) is an alias for column major ordering

source

pub fn is_row_major(self) -> bool

Return true if input is Order::RowMajor, false otherwise

source

pub fn is_column_major(self) -> bool

Return true if input is Order::ColumnMajor, false otherwise

source

pub fn row_major(row_major: bool) -> Order

Return Order::RowMajor if the input is true, Order::ColumnMajor otherwise

source

pub fn column_major(column_major: bool) -> Order

Return Order::ColumnMajor if the input is true, Order::RowMajor otherwise

source

pub fn transpose(self) -> Order

Return the transpose: row major becomes column major and vice versa.

Trait Implementations§

source§

impl Clone for Order

source§

fn clone(&self) -> Order

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Order

source§

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

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

impl PartialEq for Order

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Copy for Order

source§

impl Eq for Order

source§

impl StructuralPartialEq for Order

Auto Trait Implementations§

§

impl Freeze for Order

§

impl RefUnwindSafe for Order

§

impl Send for Order

§

impl Sync for Order

§

impl Unpin for Order

§

impl UnwindSafe for Order

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> 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,

§

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>,

§

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>,

§

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.