Struct MPSCNNConvolutionGradientOption 

#[repr(transparent)]
pub struct MPSCNNConvolutionGradientOption(pub NSUInteger);

Available on crate feature MPSCNNConvolution only.

Apple’s documentation

Tuple Fields

0: NSUInteger

Implementations

impl MPSCNNConvolutionGradientOption

pub const GradientWithData: Self

Available on crate feature MPSNeuralNetwork only.

pub const GradientWithWeightsAndBias: Self

Available on crate feature MPSNeuralNetwork only.

pub const All: Self

Available on crate feature MPSNeuralNetwork only.

impl MPSCNNConvolutionGradientOption

pub const fn empty() -> Self

Available on crate feature MPSNeuralNetwork only.

Get a flags value with all bits unset.

pub const fn all() -> Self

Available on crate feature MPSNeuralNetwork only.

Get a flags value with all known bits set.

pub const fn bits(&self) -> NSUInteger

Available on crate feature MPSNeuralNetwork only.

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: NSUInteger) -> Option<Self>

Available on crate feature MPSNeuralNetwork only.

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: NSUInteger) -> Self

Available on crate feature MPSNeuralNetwork only.

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: NSUInteger) -> Self

Available on crate feature MPSNeuralNetwork only.

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<Self>

Available on crate feature MPSNeuralNetwork only.

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Available on crate feature MPSNeuralNetwork only.

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Available on crate feature MPSNeuralNetwork only.

Whether all known bits in this flags value are set.

pub const fn intersects(&self, other: Self) -> bool

Available on crate feature MPSNeuralNetwork only.

Whether any set bits in a source flags value are also set in a target flags value.

pub const fn contains(&self, other: Self) -> bool

Available on crate feature MPSNeuralNetwork only.

Whether all set bits in a source flags value are also set in a target flags value.

pub fn insert(&mut self, other: Self)

Available on crate feature MPSNeuralNetwork only.

The bitwise or (|) of the bits in two flags values.

pub fn remove(&mut self, other: Self)

Available on crate feature MPSNeuralNetwork only.

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

pub fn toggle(&mut self, other: Self)

Available on crate feature MPSNeuralNetwork only.

The bitwise exclusive-or (^) of the bits in two flags values.

pub fn set(&mut self, other: Self, value: bool)

Available on crate feature MPSNeuralNetwork only.

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: Self) -> Self

Available on crate feature MPSNeuralNetwork only.

The bitwise and (&) of the bits in two flags values.

pub const fn union(self, other: Self) -> Self

Available on crate feature MPSNeuralNetwork only.

The bitwise or (|) of the bits in two flags values.

pub const fn difference(self, other: Self) -> Self

Available on crate feature MPSNeuralNetwork only.

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference(self, other: Self) -> Self

Available on crate feature MPSNeuralNetwork only.

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> Self

Available on crate feature MPSNeuralNetwork only.

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl MPSCNNConvolutionGradientOption

pub const fn iter(&self) -> Iter<MPSCNNConvolutionGradientOption>

Available on crate feature MPSNeuralNetwork only.

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<MPSCNNConvolutionGradientOption>

Available on crate feature MPSNeuralNetwork only.

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

Trait Implementations

impl Binary for MPSCNNConvolutionGradientOption

Available on crate feature MPSNeuralNetwork only.

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

Formats the value using the given formatter.

impl BitAnd for MPSCNNConvolutionGradientOption

Available on crate feature MPSNeuralNetwork only.

fn bitand(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

type Output = MPSCNNConvolutionGradientOption

The resulting type after applying the & operator.

impl BitAndAssign for MPSCNNConvolutionGradientOption

Available on crate feature MPSNeuralNetwork only.

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

impl BitOr for MPSCNNConvolutionGradientOption

Available on crate feature MPSNeuralNetwork only.

fn bitor(self, other: MPSCNNConvolutionGradientOption) -> Self

The bitwise or (|) of the bits in two flags values.

type Output = MPSCNNConvolutionGradientOption

The resulting type after applying the | operator.

impl BitOrAssign for MPSCNNConvolutionGradientOption

Available on crate feature MPSNeuralNetwork only.

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

impl BitXor for MPSCNNConvolutionGradientOption

Available on crate feature MPSNeuralNetwork only.

fn bitxor(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = MPSCNNConvolutionGradientOption

The resulting type after applying the ^ operator.

impl BitXorAssign for MPSCNNConvolutionGradientOption

Available on crate feature MPSNeuralNetwork only.

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Clone for MPSCNNConvolutionGradientOption

Available on crate feature MPSNeuralNetwork only.

fn clone(&self) -> MPSCNNConvolutionGradientOption

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MPSCNNConvolutionGradientOption

Available on crate feature MPSNeuralNetwork only.

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

Formats the value using the given formatter.

impl Encode for MPSCNNConvolutionGradientOption

Available on crate feature MPSNeuralNetwork only.

const ENCODING: Encoding = NSUInteger::ENCODING

The Objective-C type-encoding for this type.

impl Extend<MPSCNNConvolutionGradientOption> for MPSCNNConvolutionGradientOption

Available on crate feature MPSNeuralNetwork only.

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

The bitwise or (|) of the bits in each flags value.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Flags for MPSCNNConvolutionGradientOption

Available on crate feature MPSNeuralNetwork only.

const FLAGS: &'static [Flag<MPSCNNConvolutionGradientOption>]

The set of defined flags.

type Bits = usize

The underlying bits type.

fn bits(&self) -> NSUInteger

Get the underlying bits value.

fn from_bits_retain(bits: NSUInteger) -> MPSCNNConvolutionGradientOption

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

fn intersects(&self, other: Self) -> bool

where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

fn contains(&self, other: Self) -> bool

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

fn set(&mut self, other: Self, value: bool)

where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

fn clear(&mut self)

where Self: Sized,

Unsets all bits in the flags.

fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FromIterator<MPSCNNConvolutionGradientOption> for MPSCNNConvolutionGradientOption

Available on crate feature MPSNeuralNetwork only.

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

The bitwise or (|) of the bits in each flags value.

impl Hash for MPSCNNConvolutionGradientOption

Available on crate feature MPSNeuralNetwork only.

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

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 IntoIterator for MPSCNNConvolutionGradientOption

Available on crate feature MPSNeuralNetwork only.

type Item = MPSCNNConvolutionGradientOption

The type of the elements being iterated over.

type IntoIter = Iter<MPSCNNConvolutionGradientOption>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for MPSCNNConvolutionGradientOption

Available on crate feature MPSNeuralNetwork only.

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

Formats the value using the given formatter.

impl Not for MPSCNNConvolutionGradientOption

Available on crate feature MPSNeuralNetwork only.

fn not(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = MPSCNNConvolutionGradientOption

The resulting type after applying the ! operator.

impl Octal for MPSCNNConvolutionGradientOption

Available on crate feature MPSNeuralNetwork only.

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

Formats the value using the given formatter.

impl Ord for MPSCNNConvolutionGradientOption

Available on crate feature MPSNeuralNetwork only.

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for MPSCNNConvolutionGradientOption

Available on crate feature MPSNeuralNetwork only.

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

Available on crate feature MPSNeuralNetwork only.

fn partial_cmp( &self, other: &MPSCNNConvolutionGradientOption, ) -> 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 RefEncode for MPSCNNConvolutionGradientOption

Available on crate feature MPSNeuralNetwork only.

const ENCODING_REF: Encoding

The Objective-C type-encoding for a reference of this type.

impl Sub for MPSCNNConvolutionGradientOption

Available on crate feature MPSNeuralNetwork only.

fn sub(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = MPSCNNConvolutionGradientOption

The resulting type after applying the - operator.

impl SubAssign for MPSCNNConvolutionGradientOption

Available on crate feature MPSNeuralNetwork only.

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for MPSCNNConvolutionGradientOption

Available on crate feature MPSNeuralNetwork only.

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

Formats the value using the given formatter.

impl Copy for MPSCNNConvolutionGradientOption

Available on crate feature MPSNeuralNetwork only.

impl Eq for MPSCNNConvolutionGradientOption

Available on crate feature MPSNeuralNetwork only.

impl StructuralPartialEq for MPSCNNConvolutionGradientOption

Available on crate feature MPSNeuralNetwork only.