Struct MLCLSTMLayer

#[repr(C)]
pub struct MLCLSTMLayer { /* private fields */ }

👎Deprecated

Available on crate features MLCLSTMLayer and MLCLayer only.

A LSTM layer

The hidden and cell state for inputs and outputs have a layout of [numberOfLayers, numberOfDirections, batchSize, hiddenSize].

See also Apple’s documentation

Implementations

impl MLCLSTMLayer

pub unsafe fn descriptor(&self) -> Retained<MLCLSTMDescriptor>

👎Deprecated

Available on crate feature MLCLSTMDescriptor only.

The LSTM descriptor

pub unsafe fn gateActivations( &self, ) -> Retained<NSArray<MLCActivationDescriptor>>

👎Deprecated

Available on crate feature MLCActivationDescriptor only.

The array of gate activations for input, hidden, cell and output gates

The default gate activations are: sigmoid, sigmoid, tanh, sigmoid

pub unsafe fn outputResultActivation(&self) -> Retained<MLCActivationDescriptor>

👎Deprecated

Available on crate feature MLCActivationDescriptor only.

The output activation descriptor

pub unsafe fn inputWeights(&self) -> Retained<NSArray<MLCTensor>>

👎Deprecated

Available on crate feature MLCTensor only.

The array of tensors describing the input weights for the input, hidden, cell and output gates

pub unsafe fn hiddenWeights(&self) -> Retained<NSArray<MLCTensor>>

👎Deprecated

Available on crate feature MLCTensor only.

The array of tensors describing the hidden weights for the input, hidden, cell and output gates

pub unsafe fn peepholeWeights(&self) -> Option<Retained<NSArray<MLCTensor>>>

👎Deprecated

Available on crate feature MLCTensor only.

The array of tensors describing the peephole weights for the input, hidden, cell and output gates

pub unsafe fn biases(&self) -> Option<Retained<NSArray<MLCTensor>>>

👎Deprecated

Available on crate feature MLCTensor only.

The array of tensors describing the bias terms for the input, hidden, cell and output gates

pub unsafe fn inputWeightsParameters( &self, ) -> Retained<NSArray<MLCTensorParameter>>

👎Deprecated

Available on crate feature MLCTensorParameter only.

The input weights tensor parameters used for optimizer update

pub unsafe fn hiddenWeightsParameters( &self, ) -> Retained<NSArray<MLCTensorParameter>>

👎Deprecated

Available on crate feature MLCTensorParameter only.

The hidden weights tensor parameters used for optimizer update

pub unsafe fn peepholeWeightsParameters( &self, ) -> Option<Retained<NSArray<MLCTensorParameter>>>

👎Deprecated

Available on crate feature MLCTensorParameter only.

The peephole weights tensor parameters used for optimizer update

pub unsafe fn biasesParameters( &self, ) -> Option<Retained<NSArray<MLCTensorParameter>>>

👎Deprecated

Available on crate feature MLCTensorParameter only.

The bias tensor parameter used for optimizer update

pub unsafe fn layerWithDescriptor_inputWeights_hiddenWeights_biases( descriptor: &MLCLSTMDescriptor, input_weights: &NSArray<MLCTensor>, hidden_weights: &NSArray<MLCTensor>, biases: Option<&NSArray<MLCTensor>>, ) -> Option<Retained<Self>>

👎Deprecated

Available on crate features MLCLSTMDescriptor and MLCTensor only.

Create a LSTM layer

Parameter descriptor: The LSTM descriptor

Parameter inputWeights: An array of (layerCount * 4) tensors describing the input weights for the input, hidden, cell and output gates for layer0, layer1.. layer(n-1) for layerCount=n.

Parameter hiddenWeights: An array of (layerCount * 4) tensors describing the hidden weights for the input, hidden, cell and output gates for layer0, layer1.. layer(n-1) for layerCount=n.

Returns: A new LSTM layer.

pub unsafe fn layerWithDescriptor_inputWeights_hiddenWeights_peepholeWeights_biases( descriptor: &MLCLSTMDescriptor, input_weights: &NSArray<MLCTensor>, hidden_weights: &NSArray<MLCTensor>, peephole_weights: Option<&NSArray<MLCTensor>>, biases: Option<&NSArray<MLCTensor>>, ) -> Option<Retained<Self>>

👎Deprecated

Available on crate features MLCLSTMDescriptor and MLCTensor only.

Create a LSTM layer

Parameter descriptor: The LSTM descriptor

Parameter inputWeights: An array of (layerCount * 4) tensors describing the input weights for the input, hidden, cell and output gates for layer0, layer1.. layer(n-1) for layerCount=n.

Parameter hiddenWeights: An array of (layerCount * 4) tensors describing the hidden weights for the input, hidden, cell and output gates for layer0, layer1.. layer(n-1) for layerCount=n.

Parameter peepholeWeights: An array of (layerCount * 4) tensors describing the peephole weights for the input, hidden, cell and output gates for layer0, layer1.. layer(n-1) for layerCount=n.

Returns: A new LSTM layer.

pub unsafe fn layerWithDescriptor_inputWeights_hiddenWeights_peepholeWeights_biases_gateActivations_outputResultActivation( descriptor: &MLCLSTMDescriptor, input_weights: &NSArray<MLCTensor>, hidden_weights: &NSArray<MLCTensor>, peephole_weights: Option<&NSArray<MLCTensor>>, biases: Option<&NSArray<MLCTensor>>, gate_activations: &NSArray<MLCActivationDescriptor>, output_result_activation: &MLCActivationDescriptor, ) -> Option<Retained<Self>>

👎Deprecated

Available on crate features MLCActivationDescriptor and MLCLSTMDescriptor and MLCTensor only.

Create a LSTM layer

Parameter descriptor: The LSTM descriptor

Parameter inputWeights: An array of (layerCount * 4) tensors describing the input weights for the input, hidden, cell and output gates for layer0, layer1.. layer(n-1) for layerCount=n. For bidirectional LSTM, the forward time weights for all stacked layers will come first followed by backward time weights

Parameter hiddenWeights: An array of (layerCount * 4) tensors describing the hidden weights for the input, hidden, cell and output gates for layer0, layer1.. layer(n-1) for layerCount=n. For bidirectional LSTM, the forward time weights for all stacked layers will come first followed by backward time weights

Parameter peepholeWeights: An array of (layerCount * 4) tensors describing the peephole weights for the input, hidden, cell and output gates for layer0, layer1.. layer(n-1) for layerCount=n.

Parameter biases: An array of (layerCount * 4) tensors describing the input weights for the input, hidden, cell and output gates for layer0, layer1.. layer(n-1) for layerCount=n. For bidirectional LSTM, the forward time bias terms for all stacked layers will come first followed by backward time bias terms

Parameter gateActivations: An array of 4 neuron descriptors for the input, hidden, cell and output gate activations.

Parameter outputResultActivation: The neuron descriptor used for the activation function applied to output result. Default is tanh.

Returns: A new LSTM layer.

impl MLCLSTMLayer

Methods declared on superclass MLCLayer.

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

👎Deprecated

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

👎Deprecated

Methods from Deref<Target = MLCLayer>

pub unsafe fn layerID(&self) -> NSUInteger

👎Deprecated

The layer ID

A unique number to identify each layer. Assigned when the layer is created.

pub unsafe fn label(&self) -> Retained<NSString>

👎Deprecated

A string to help identify this object.

pub unsafe fn setLabel(&self, label: &NSString)

👎Deprecated

Setter for label.

pub unsafe fn isDebuggingEnabled(&self) -> bool

👎Deprecated

A flag to identify if we want to debug this layer when executing a graph that includes this layer

If this is set, we will make sure that the result tensor and gradient tensors are available for reading on CPU The default is NO. If isDebuggingEnabled is set to YES, make sure to set options to enable debugging when compiling the graph. Otherwise this property may be ignored.

pub unsafe fn setIsDebuggingEnabled(&self, is_debugging_enabled: bool)

👎Deprecated

Setter for isDebuggingEnabled.

pub unsafe fn deviceType(&self) -> MLCDeviceType

Available on crate feature MLCTypes only.

The device type where this layer will be executed

Typically the MLCDevice passed to compileWithOptions will be the device used to execute layers in the graph. If MLCDeviceTypeANE is selected, it is possible that some of the layers of the graph may not be executed on the ANE but instead on the CPU or GPU. This property can be used to determine which device type the layer will be executed on.

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 MLCLSTMLayer

fn as_ref(&self) -> &AnyObject

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

impl AsRef<MLCLSTMLayer> for MLCLSTMLayer

fn as_ref(&self) -> &Self

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

impl AsRef<MLCLayer> for MLCLSTMLayer

fn as_ref(&self) -> &MLCLayer

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

impl AsRef<NSObject> for MLCLSTMLayer

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for MLCLSTMLayer

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<MLCLayer> for MLCLSTMLayer

fn borrow(&self) -> &MLCLayer

Immutably borrows from an owned value.

impl Borrow<NSObject> for MLCLSTMLayer

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for MLCLSTMLayer

const NAME: &'static str = "MLCLSTMLayer"

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

type Super = MLCLayer

The superclass of this class.

type ThreadKind = <<MLCLSTMLayer 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 MLCLSTMLayer

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

Formats the value using the given formatter.

impl Deref for MLCLSTMLayer

type Target = MLCLayer

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for MLCLSTMLayer

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 MLCLSTMLayer

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for MLCLSTMLayer

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 MLCLSTMLayer

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 MLCLSTMLayer

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

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

impl DowncastTarget for MLCLSTMLayer

impl Eq for MLCLSTMLayer