Enum hip_sys::hiprt::hipMemoryAdvise

#[non_exhaustive]
#[repr(u32)]
pub enum hipMemoryAdvise {
    hipMemAdviseSetReadMostly,
    hipMemAdviseUnsetReadMostly,
    hipMemAdviseSetPreferredLocation,
    hipMemAdviseUnsetPreferredLocation,
    hipMemAdviseSetAccessedBy,
    hipMemAdviseUnsetAccessedBy,
    hipMemAdviseSetCoarseGrain,
    hipMemAdviseUnsetCoarseGrain,
}

Variants (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.

hipMemAdviseSetReadMostly

< Data will mostly be read and only occassionally < be written to

hipMemAdviseUnsetReadMostly

< Undo the effect of hipMemAdviseSetReadMostly

hipMemAdviseSetPreferredLocation

< Set the preferred location for the data as < the specified device

hipMemAdviseUnsetPreferredLocation

< Clear the preferred location for the data

hipMemAdviseSetAccessedBy

< Data will be accessed by the specified device, < so prevent page faults as much as possible

hipMemAdviseUnsetAccessedBy

< Let HIP to decide on the page faulting policy < for the specified device

hipMemAdviseSetCoarseGrain

< The default memory model is fine-grain. That allows < coherent operations between host and device, while < executing kernels. The coarse-grain can be used < for data that only needs to be coherent at dispatch < boundaries for better performance

hipMemAdviseUnsetCoarseGrain

< Restores cache coherency policy back to fine-grain

Trait Implementations

impl Clone for hipMemoryAdvise

fn clone(&self) -> hipMemoryAdvise

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for hipMemoryAdvise

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

Formats the value using the given formatter.

impl Hash for hipMemoryAdvise

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 Ord for hipMemoryAdvise

fn cmp(&self, other: &hipMemoryAdvise) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<hipMemoryAdvise> for hipMemoryAdvise

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

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

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.

impl PartialOrd<hipMemoryAdvise> for hipMemoryAdvise

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for hipMemoryAdvise

impl Eq for hipMemoryAdvise

impl StructuralEq for hipMemoryAdvise

impl StructuralPartialEq for hipMemoryAdvise