Struct MPSGraphLSTMDescriptor 

pub struct MPSGraphLSTMDescriptor { /* private fields */ }

Available on crate features MPSGraphCore and MPSGraphRNNOps only.

The class that defines the parameters for a long short-term memory (LSTM) operation.

Use this descriptor with the following MPSGraph methods:

• MPSGraph/LSTMWithSourceTensor:recurrentWeight:initState:initCell:descriptor:name:
• MPSGraph/LSTMWithSourceTensor:recurrentWeight:inputWeight:bias:initState:initCell:descriptor:name:
• MPSGraph/LSTMWithSourceTensor:recurrentWeight:inputWeight:bias:initState:initCell:mask:peephole:descriptor:name:
• MPSGraph/LSTMGradientsWithSourceTensor:recurrentWeight:sourceGradient:zState:cellOutputFwd:descriptor:name:
• MPSGraph/LSTMGradientsWithSourceTensor:recurrentWeight:sourceGradient:zState:cellOutputFwd:inputWeight:bias:initState:initCell:descriptor:name:
• MPSGraph/LSTMGradientsWithSourceTensor:recurrentWeight:sourceGradient:zState:cellOutputFwd:inputWeight:bias:initState:initCell:mask:descriptor:name:
• MPSGraph/LSTMGradientsWithSourceTensor:recurrentWeight:sourceGradient:zState:cellOutputFwd:stateGradient:cellGradient:inputWeight:bias:initState:initCell:mask:peephole:descriptor:name:

See also Apple’s documentation

Implementations

impl MPSGraphLSTMDescriptor

pub unsafe fn reverse(&self) -> bool

A parameter that defines time direction of the input sequence.

If set to YES then the input sequence is passed in reverse time order to the layer. Note: Ignored when bidirectional = YES. Default value: NO.

pub unsafe fn setReverse(&self, reverse: bool)

Setter for reverse.

pub unsafe fn bidirectional(&self) -> bool

A parameter that defines a bidirectional LSTM layer.

If set to YES then the input sequence is traversed in both directions and the two results are concatenated together on the channel-axis. Default value: NO.

pub unsafe fn setBidirectional(&self, bidirectional: bool)

Setter for bidirectional.

pub unsafe fn produceCell(&self) -> bool

A parameter that controls whether or not to return the output cell from the LSTM layer.

If set to YES then this layer will produce the internal cell of the LSTM unit as secondary output. Default value: NO.

pub unsafe fn setProduceCell(&self, produce_cell: bool)

Setter for produceCell.

pub unsafe fn training(&self) -> bool

A parameter that enables the LSTM layer to support training.

If set to YES then the layer will produce training state tensor as a secondary output. Default value: NO.

pub unsafe fn setTraining(&self, training: bool)

Setter for training.

pub unsafe fn forgetGateLast(&self) -> bool

A parameter that controls the internal order of the LSTM gates.

If set to YES then the layer will use the gate-ordering [ i, z, f, o ] instead of default [ i, f, z, o ]. Default value: NO

pub unsafe fn setForgetGateLast(&self, forget_gate_last: bool)

Setter for forgetGateLast.

pub unsafe fn inputGateActivation(&self) -> MPSGraphRNNActivation

A parameter that defines the activation function used with the input gate of the LSTM operation.

Default value: MPSGraphRNNActivationSigmoid.

pub unsafe fn setInputGateActivation( &self, input_gate_activation: MPSGraphRNNActivation, )

Setter for inputGateActivation.

pub unsafe fn forgetGateActivation(&self) -> MPSGraphRNNActivation

A parameter that defines the activation function used with the forget gate of the LSTM operation.

Default value: MPSGraphRNNActivationSigmoid.

pub unsafe fn setForgetGateActivation( &self, forget_gate_activation: MPSGraphRNNActivation, )

Setter for forgetGateActivation.

pub unsafe fn cellGateActivation(&self) -> MPSGraphRNNActivation

A parameter that defines the activation function used with the cell gate of the LSTM operation.

Default value: MPSGraphRNNActivationTanh.

pub unsafe fn setCellGateActivation( &self, cell_gate_activation: MPSGraphRNNActivation, )

Setter for cellGateActivation.

pub unsafe fn outputGateActivation(&self) -> MPSGraphRNNActivation

A parameter that defines the activation function used with the output gate of the LSTM operation.

Default value: MPSGraphRNNActivationSigmoid.

pub unsafe fn setOutputGateActivation( &self, output_gate_activation: MPSGraphRNNActivation, )

Setter for outputGateActivation.

pub unsafe fn activation(&self) -> MPSGraphRNNActivation

A parameter that defines the activation function used with the current cell value of the LSTM operation.

Default value: MPSGraphRNNActivationTanh.

pub unsafe fn setActivation(&self, activation: MPSGraphRNNActivation)

Setter for activation.

pub unsafe fn descriptor() -> Option<Retained<Self>>

Creates an LSTM descriptor with default values.

impl MPSGraphLSTMDescriptor

Methods declared on superclass NSObject.

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

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

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 MPSGraphLSTMDescriptor

fn as_ref(&self) -> &AnyObject

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

impl AsRef<MPSGraphLSTMDescriptor> for MPSGraphLSTMDescriptor

fn as_ref(&self) -> &Self

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

impl AsRef<MPSGraphObject> for MPSGraphLSTMDescriptor

fn as_ref(&self) -> &MPSGraphObject

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

impl AsRef<NSObject> for MPSGraphLSTMDescriptor

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for MPSGraphLSTMDescriptor

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<MPSGraphObject> for MPSGraphLSTMDescriptor

fn borrow(&self) -> &MPSGraphObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for MPSGraphLSTMDescriptor

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for MPSGraphLSTMDescriptor

const NAME: &'static str = "MPSGraphLSTMDescriptor"

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

type Super = MPSGraphObject

The superclass of this class.

type ThreadKind = <<MPSGraphLSTMDescriptor 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 CopyingHelper for MPSGraphLSTMDescriptor

type Result = MPSGraphLSTMDescriptor

The immutable counterpart of the type, or Self if the type has no immutable counterpart.

impl Debug for MPSGraphLSTMDescriptor

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

Formats the value using the given formatter.

impl Deref for MPSGraphLSTMDescriptor

type Target = MPSGraphObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for MPSGraphLSTMDescriptor

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 MPSGraphLSTMDescriptor

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCopying for MPSGraphLSTMDescriptor

fn copy(&self) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

unsafe fn copyWithZone(&self, zone: *mut NSZone) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

impl NSObjectProtocol for MPSGraphLSTMDescriptor

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 MPSGraphLSTMDescriptor

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 MPSGraphLSTMDescriptor

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

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

impl DowncastTarget for MPSGraphLSTMDescriptor

impl Eq for MPSGraphLSTMDescriptor