Struct Dim4

pub struct Dim4 { /* private fields */ }

Dim4 is used to store Array dimensions

Implementations

impl Dim4

pub fn new(dims: &[u64; 4]) -> Self

Create Dim4 object

Examples

use arrayfire::Dim4;
let dims = Dim4::new(&[4, 4, 2, 1]);

pub fn elements(&self) -> u64

Get the number of elements represented by Dim4 object

pub fn ndims(&self) -> usize

Get the number of dimensions of Dim4

pub fn get(&self) -> &[u64; 4]

Get the dimensions as a slice of 4 values

Trait Implementations

impl Clone for Dim4

fn clone(&self) -> Dim4

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Dim4

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

Formats the value using the given formatter.

impl Default for Dim4

Default trait for Dim4 returns an Array of dimensions [1, 1, 1, 1]

fn default() -> Self

Returns the “default value” for a type.

impl Display for Dim4

Enables use of Dim4 objects for printing it to display

Examples

use arrayfire::Dim4;

let dims = Dim4::new(&[4, 4, 2, 1]);
println!("0th Dimension length is {}", dims[0]); // -> 4

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

Formats the value using the given formatter.

impl Index<usize> for Dim4

Enables index operation for Dim4

Examples

use arrayfire::Dim4;

let dims = Dim4::new(&[4, 4, 2, 1]);
println!("0th Dimension length is {}", dims[0]); // -> 4
println!("1th Dimension length is {}", dims[1]); // -> 4
println!("2th Dimension length is {}", dims[2]); // -> 2
println!("3th Dimension length is {}", dims[3]); // -> 1

type Output = u64

The returned type after indexing.

fn index(&self, _index: usize) -> &u64

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for Dim4

Enables index operation for Dim4 to modify dimensions

Examples

use arrayfire::Dim4;

let mut dims = Dim4::new(&[4, 4, 2, 1]);
dims[2] = 4;
println!("Dimensions: {}", dims); // note that third dimension changed to 4

fn index_mut(&mut self, _index: usize) -> &mut Self::Output

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

impl PartialEq for Dim4

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for Dim4

impl StructuralPartialEq for Dim4