Struct CubeDim 

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

The number of units across all 3 axis totalling to the number of working units in a cube.

Fields

x: u32

The number of units in the x axis.

y: u32

The number of units in the y axis.

z: u32

The number of units in the z axis.

Implementations

impl CubeDim

pub fn new<R>(client: &ComputeClient<R>, working_units: usize) -> CubeDim

where R: Runtime,

Creates a new CubeDim based on the maximum number of tasks that can be parellalized by units, in other words, by the maximum number of working units.

Notes

For complex problems, you probably want to have your own logic function to create the CubeDim, but for simpler problems such as elemwise-operation, this is a great default.

pub const fn new_single() -> CubeDim

Create a new cube dim with x = y = z = 1.

pub const fn new_1d(x: u32) -> CubeDim

Create a new cube dim with the given x, and y = z = 1.

pub const fn new_2d(x: u32, y: u32) -> CubeDim

Create a new cube dim with the given x and y, and z = 1.

pub const fn new_3d(x: u32, y: u32, z: u32) -> CubeDim

Create a new cube dim with the given x, y and z. This is equivalent to the new function.

pub const fn num_elems(&self) -> u32

Total numbers of units per cube

pub const fn can_contain(&self, other: CubeDim) -> bool

Whether this CubeDim can fully contain other

Trait Implementations

impl Clone for CubeDim

fn clone(&self) -> CubeDim

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CubeDim

impl Debug for CubeDim

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CubeDim

fn deserialize<__D>( __deserializer: __D, ) -> Result<CubeDim, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for CubeDim

impl From<(u32, u32, u32)> for CubeDim

fn from(value: (u32, u32, u32)) -> CubeDim

Converts to this type from the input type.

impl Hash for CubeDim

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for CubeDim

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

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CubeDim