Skip to main content

GridPos

Struct GridPos 

Source
pub struct GridPos { /* private fields */ }
Expand description

Context for grid position within a stencil kernel.

This is a marker type that gets translated to CUDA index calculations. In Rust, it provides the API; in generated CUDA, it becomes inline code.

Implementations§

Source§

impl GridPos

Source

pub fn idx(&self) -> usize

Get the current cell’s linear index.

In CUDA: idx

Source

pub fn north<T: Copy>(&self, _buf: &[T]) -> T

Access the north neighbor (y - 1).

In CUDA: buf[idx - buffer_width]

Source

pub fn south<T: Copy>(&self, _buf: &[T]) -> T

Access the south neighbor (y + 1).

In CUDA: buf[idx + buffer_width]

Source

pub fn east<T: Copy>(&self, _buf: &[T]) -> T

Access the east neighbor (x + 1).

In CUDA: buf[idx + 1]

Source

pub fn west<T: Copy>(&self, _buf: &[T]) -> T

Access the west neighbor (x - 1).

In CUDA: buf[idx - 1]

Source

pub fn at<T: Copy>(&self, _buf: &[T], _dx: i32, _dy: i32) -> T

Access a neighbor at arbitrary offset.

In CUDA: buf[idx + dy * buffer_width + dx]

Source

pub fn up<T: Copy>(&self, _buf: &[T]) -> T

Access the neighbor above (z - 1, 3D only).

In CUDA: buf[idx - buffer_slice]

Source

pub fn down<T: Copy>(&self, _buf: &[T]) -> T

Access the neighbor below (z + 1, 3D only).

In CUDA: buf[idx + buffer_slice]

Trait Implementations§

Source§

impl Clone for GridPos

Source§

fn clone(&self) -> GridPos

Returns a duplicate 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 GridPos

Source§

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

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

impl Copy for GridPos

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.