Struct MPSNNGradientStateNode 

pub struct MPSNNGradientStateNode { /* private fields */ }

Available on crate feature MPSNNGraphNodes only.

During training, each MPSNNFilterNode has a corresponding MPSNNGradientFilterNode for the gradient computation for trainable parameter update. The two communicate through a MPSNNGradientStateNode or subclass which carries information about the inference pass settings to the gradient pass. You can avoid managing these – there will be many! – by using -[MPSNNFilterNode gradientFilterWithSources:] to make the MPSNNGradientFilterNodes. That method will append the necessary extra information like MPSNNGradientState nodes and inference filter source image nodes to the object as needed.

See also Apple’s documentation

Implementations

impl MPSNNGradientStateNode

Methods declared on superclass MPSNNStateNode.

pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>

Available on crate feature MPSNeuralNetwork only.

impl MPSNNGradientStateNode

Methods declared on superclass NSObject.

pub unsafe fn new() -> Retained<Self>

Available on crate feature MPSNeuralNetwork only.

Methods from Deref<Target = MPSNNStateNode>

pub unsafe fn handle(&self) -> Option<Retained<ProtocolObject<dyn MPSHandle>>>

Available on crate feature MPSNeuralNetwork only.

MPS resource identification

See MPSHandle protocol reference. Default: nil

pub unsafe fn setHandle(&self, handle: Option<&ProtocolObject<dyn MPSHandle>>)

Available on crate feature MPSNeuralNetwork only.

Setter for handle.

pub unsafe fn exportFromGraph(&self) -> bool

Available on crate feature MPSNeuralNetwork only.

Tag a state node for view later

Most state nodes are private to the graph. These alias memory heavily and consequently generally have invalid state when the graph exits. When exportFromGraph = YES, the image is preserved and made available through the [MPSNNGraph encode… resultStates:… list.

CAUTION: exporting an state from a graph prevents MPS from recycling memory. It will nearly always cause the amount of memory used by the graph to increase by the size of the state. There will probably be a performance regression accordingly. This feature should generally be used only when the node is needed as an input for further work and recomputing it is prohibitively costly.

Default: NO

pub unsafe fn setExportFromGraph(&self, export_from_graph: bool)

Available on crate feature MPSNeuralNetwork only.

Setter for exportFromGraph.

pub unsafe fn synchronizeResource(&self) -> bool

Available on crate feature MPSNeuralNetwork only.

Set to true to cause the resource to be synchronized with the CPU

Ignored on non-MacOS.

pub unsafe fn setSynchronizeResource(&self, synchronize_resource: bool)

Available on crate feature MPSNeuralNetwork only.

Setter for synchronizeResource.

Methods from Deref<Target = NSObject>

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>

pub fn class(&self) -> &'static AnyClass

Dynamically find the class of this object.

Panics

May panic if the object is invalid (which may be the case for objects returned from unavailable init/new methods).

Example

Check that an instance of NSObject has the precise class NSObject.

use objc2::ClassType;
use objc2::runtime::NSObject;

let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T

where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load instead.

Use Ivar::load instead.

Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

pub fn downcast_ref<T>(&self) -> Option<&T>

where T: DowncastTarget,

Attempt to downcast the object to a class of type T.

This is the reference-variant. Use Retained::downcast if you want to convert a retained object to another type.

Mutable classes

Some classes have immutable and mutable variants, such as NSString and NSMutableString.

When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.

So using this method to convert a NSString to a NSMutableString, while not unsound, is generally frowned upon unless you created the string yourself, or the API explicitly documents the string to be mutable.

See Apple’s documentation on mutability and on isKindOfClass: for more details.

Generic classes

Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.

You can, however, safely downcast to generic collections where all the type-parameters are AnyObject.

Panics

This works internally by calling isKindOfClass:. That means that the object must have the instance method of that name, and an exception will be thrown (if CoreFoundation is linked) or the process will abort if that is not the case. In the vast majority of cases, you don’t need to worry about this, since both root objects NSObject and NSProxy implement this method.

Examples

Cast an NSString back and forth from NSObject.

use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};

let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();

Try (and fail) to cast an NSObject to an NSString.

use objc2_foundation::{NSObject, NSString};

let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());

Try to cast to an array of strings.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();

This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.

Downcast when processing each element instead.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);

for elem in arr {
    if let Some(data) = elem.downcast_ref::<NSString>() {
        // handle `data`
    }
}

Trait Implementations

impl AsRef<AnyObject> for MPSNNGradientStateNode

Available on crate feature MPSNeuralNetwork only.

fn as_ref(&self) -> &AnyObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<MPSNNGradientStateNode> for MPSCNNConvolutionGradientStateNode

Available on crate feature MPSNeuralNetwork only.

fn as_ref(&self) -> &MPSNNGradientStateNode

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<MPSNNGradientStateNode> for MPSCNNConvolutionTransposeGradientStateNode

Available on crate feature MPSNeuralNetwork only.

fn as_ref(&self) -> &MPSNNGradientStateNode

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<MPSNNGradientStateNode> for MPSNNGradientStateNode

Available on crate feature MPSNeuralNetwork only.

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<MPSNNStateNode> for MPSNNGradientStateNode

Available on crate feature MPSNeuralNetwork only.

fn as_ref(&self) -> &MPSNNStateNode

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NSObject> for MPSNNGradientStateNode

Available on crate feature MPSNeuralNetwork only.

fn as_ref(&self) -> &NSObject

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<AnyObject> for MPSNNGradientStateNode

Available on crate feature MPSNeuralNetwork only.

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<MPSNNGradientStateNode> for MPSCNNConvolutionGradientStateNode

Available on crate feature MPSNeuralNetwork only.

fn borrow(&self) -> &MPSNNGradientStateNode

Immutably borrows from an owned value.

impl Borrow<MPSNNGradientStateNode> for MPSCNNConvolutionTransposeGradientStateNode

Available on crate feature MPSNeuralNetwork only.

fn borrow(&self) -> &MPSNNGradientStateNode

Immutably borrows from an owned value.

impl Borrow<MPSNNStateNode> for MPSNNGradientStateNode

Available on crate feature MPSNeuralNetwork only.

fn borrow(&self) -> &MPSNNStateNode

Immutably borrows from an owned value.

impl Borrow<NSObject> for MPSNNGradientStateNode

Available on crate feature MPSNeuralNetwork only.

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for MPSNNGradientStateNode

Available on crate feature MPSNeuralNetwork only.

const NAME: &'static str = "MPSNNGradientStateNode"

The name of the Objective-C class that this type represents.

type Super = MPSNNStateNode

The superclass of this class.

type ThreadKind = <<MPSNNGradientStateNode as ClassType>::Super as ClassType>::ThreadKind

Whether the type can be used from any thread, or from only the main thread.

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents.

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

impl Debug for MPSNNGradientStateNode

Available on crate feature MPSNeuralNetwork only.

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

Formats the value using the given formatter.

impl Deref for MPSNNGradientStateNode

Available on crate feature MPSNeuralNetwork only.

type Target = MPSNNStateNode

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Hash for MPSNNGradientStateNode

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 Message for MPSNNGradientStateNode

Available on crate feature MPSNeuralNetwork only.

fn retain(&self) -> Retained<Self>

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for MPSNNGradientStateNode

Available on crate feature MPSNeuralNetwork only.

fn isEqual(&self, other: Option<&AnyObject>) -> bool

where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object.

fn hash(&self) -> usize

where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure.

fn isKindOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of the class, or one of its subclasses.

fn is_kind_of<T>(&self) -> bool

where T: ClassType, Self: Sized + Message,

👎Deprecated: use isKindOfClass directly, or cast your objects with AnyObject::downcast_ref

Check if the object is an instance of the class type, or one of its subclasses.

fn isMemberOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses.

fn respondsToSelector(&self, aSelector: Sel) -> bool

where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector.

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool

where Self: Sized + Message,

Check whether the object conforms to a given protocol.

fn description(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object to use when debugging.

fn isProxy(&self) -> bool

where Self: Sized + Message,

Check whether the receiver is a subclass of the NSProxy root class instead of the usual NSObject.

fn retainCount(&self) -> usize

where Self: Sized + Message,

The reference count of the object.

impl PartialEq for MPSNNGradientStateNode

Available on crate feature MPSNeuralNetwork only.

fn eq(&self, other: &Self) -> 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 RefEncode for MPSNNGradientStateNode

Available on crate feature MPSNeuralNetwork only.

const ENCODING_REF: Encoding = <MPSNNStateNode as ::objc2::RefEncode>::ENCODING_REF

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

impl DowncastTarget for MPSNNGradientStateNode

Available on crate feature MPSNeuralNetwork only.

impl Eq for MPSNNGradientStateNode

Available on crate feature MPSNeuralNetwork only.