Struct Grid

pub struct Grid {
    pub x: u32,
    pub y: u32,
    pub z: u32,
}

Size of Grid (grid of blocks) in CUDA thread hierarchy

Every input integer and float convert into u32 using ToPrimitive. If the conversion is impossible, e.g. negative or too large integers, the conversion will panics.

Examples

• Explicit creation

let grid1d = Grid::x(64);
assert_eq!(grid1d.x, 64);

let grid2d = Grid::xy(64, 128);
assert_eq!(grid2d.x, 64);
assert_eq!(grid2d.y, 128);

let grid3d = Grid::xyz(64, 128, 256);
assert_eq!(grid3d.x, 64);
assert_eq!(grid3d.y, 128);
assert_eq!(grid3d.z, 256);

• From single integer (unsigned and signed)

let grid1d: Grid = 64_usize.into();
assert_eq!(grid1d.x, 64);

let grid1d: Grid = 64_i32.into();
assert_eq!(grid1d.x, 64);

• From tuple

let grid1d: Grid = (64,).into();
assert_eq!(grid1d.x, 64);

let grid2d: Grid = (64, 128).into();
assert_eq!(grid2d.x, 64);
assert_eq!(grid2d.y, 128);

let grid3d: Grid = (64, 128, 256).into();
assert_eq!(grid3d.x, 64);
assert_eq!(grid3d.y, 128);
assert_eq!(grid3d.z, 256);

Fields

x: u32

y: u32

z: u32

Implementations

impl Grid

pub fn x<I: ToPrimitive>(x: I) -> Self

1D Grid

Panic

• If input values cannot convert to u32

pub fn xy<I1: ToPrimitive, I2: ToPrimitive>(x: I1, y: I2) -> Self

2D Grid

Panic

• If input values cannot convert to u32

pub fn xyz<I1: ToPrimitive, I2: ToPrimitive, I3: ToPrimitive>( x: I1, y: I2, z: I3, ) -> Self

3D Grid

Panic

• If input values cannot convert to u32

Trait Implementations

impl Clone for Grid

fn clone(&self) -> Grid

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Grid

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

Formats the value using the given formatter.

impl<I: ToPrimitive> Into<Grid> for (I,)

fn into(self) -> Grid

Converts this type into the (usually inferred) input type.

impl<I1: ToPrimitive, I2: ToPrimitive> Into<Grid> for (I1, I2)

fn into(self) -> Grid

Converts this type into the (usually inferred) input type.

impl<I1: ToPrimitive, I2: ToPrimitive, I3: ToPrimitive> Into<Grid> for (I1, I2, I3)

fn into(self) -> Grid

Converts this type into the (usually inferred) input type.

impl Into<Grid> for i128

fn into(self) -> Grid

Converts this type into the (usually inferred) input type.

impl Into<Grid> for i16

fn into(self) -> Grid

Converts this type into the (usually inferred) input type.

impl Into<Grid> for i32

fn into(self) -> Grid

Converts this type into the (usually inferred) input type.

impl Into<Grid> for i64

fn into(self) -> Grid

Converts this type into the (usually inferred) input type.

impl Into<Grid> for i8

fn into(self) -> Grid

Converts this type into the (usually inferred) input type.

impl Into<Grid> for isize

fn into(self) -> Grid

Converts this type into the (usually inferred) input type.

impl Into<Grid> for u128

fn into(self) -> Grid

Converts this type into the (usually inferred) input type.

impl Into<Grid> for u16

fn into(self) -> Grid

Converts this type into the (usually inferred) input type.

impl Into<Grid> for u32

fn into(self) -> Grid

Converts this type into the (usually inferred) input type.

impl Into<Grid> for u64

fn into(self) -> Grid

Converts this type into the (usually inferred) input type.

impl Into<Grid> for u8

fn into(self) -> Grid

Converts this type into the (usually inferred) input type.

impl Into<Grid> for usize

fn into(self) -> Grid

Converts this type into the (usually inferred) input type.

impl PartialEq for Grid

fn eq(&self, other: &Grid) -> 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 PartialOrd for Grid

fn partial_cmp(&self, other: &Grid) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Grid

impl StructuralPartialEq for Grid