Struct MLCLSTMDescriptor

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

👎Deprecated

Available on crate feature MLCLSTMDescriptor only.

The MLCLSTMDescriptor specifies a LSTM descriptor

See also Apple’s documentation

Implementations

impl MLCLSTMDescriptor

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

👎Deprecated

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

👎Deprecated

pub unsafe fn inputSize(&self) -> NSUInteger

👎Deprecated

The number of expected feature channels in the input

pub unsafe fn hiddenSize(&self) -> NSUInteger

👎Deprecated

The number of feature channels in the hidden state

pub unsafe fn layerCount(&self) -> NSUInteger

👎Deprecated

The number of recurrent layers. Default is 1.

pub unsafe fn usesBiases(&self) -> bool

👎Deprecated

If NO, the layer does not use bias terms. Default is YES.

pub unsafe fn batchFirst(&self) -> bool

👎Deprecated

LSTM only supports batchFirst=YES. This means the input and output will have shape [batch size, time steps, feature]. Default is YES.

pub unsafe fn isBidirectional(&self) -> bool

👎Deprecated

If YES, becomes a bidirectional LSTM. Default is NO.

pub unsafe fn returnsSequences(&self) -> bool

👎Deprecated

if YES return output for all sequences else return output only for the last sequences. Default: YES

pub unsafe fn dropout(&self) -> c_float

👎Deprecated

If non-zero, intrdouces a dropout layer on the outputs of each LSTM layer except the last layer, with dropout probablity equal to dropout. Default is 0.0.

pub unsafe fn resultMode(&self) -> MLCLSTMResultMode

👎Deprecated

Available on crate feature MLCTypes only.

MLCLSTMResultModeOutput returns output data. MLCLSTMResultModeOutputAndStates returns output data, last hidden state h_n, and last cell state c_n. Default MLCLSTMResultModeOutput.

pub unsafe fn descriptorWithInputSize_hiddenSize_layerCount( input_size: NSUInteger, hidden_size: NSUInteger, layer_count: NSUInteger, ) -> Retained<Self>

👎Deprecated

Creates a LSTM descriptor with batchFirst = YES

Parameter inputSize: The number of expected features in the input

Parameter hiddenSize: The number of features in the hidden state

Parameter layerCount: Number of recurrent layers

Returns: A valid MLCLSTMDescriptor object or nil, if failure.

pub unsafe fn descriptorWithInputSize_hiddenSize_layerCount_usesBiases_isBidirectional_dropout( input_size: NSUInteger, hidden_size: NSUInteger, layer_count: NSUInteger, uses_biases: bool, is_bidirectional: bool, dropout: c_float, ) -> Retained<Self>

👎Deprecated

Creates a LSTM descriptor descriptor with batchFirst = YES

Parameter inputSize: The number of expected features in the input

Parameter hiddenSize: The number of features in the hidden state

Parameter layerCount: Number of recurrent layers

Parameter usesBiases: If NO, the layer does not use bias weights. Default: YES

Parameter isBidirectional: If YES, becomes a bi-directional LSTM. Default: NO

Parameter dropout: If non-zero, introduces a dropout layer on the outputs of each LSTM layer except the last layer with dropout probability equal to dropout.

Returns: A valid MLCLSTMDescriptor object or nil, if failure.

pub unsafe fn descriptorWithInputSize_hiddenSize_layerCount_usesBiases_batchFirst_isBidirectional_dropout( input_size: NSUInteger, hidden_size: NSUInteger, layer_count: NSUInteger, uses_biases: bool, batch_first: bool, is_bidirectional: bool, dropout: c_float, ) -> Retained<Self>

👎Deprecated

pub unsafe fn descriptorWithInputSize_hiddenSize_layerCount_usesBiases_batchFirst_isBidirectional_returnsSequences_dropout( input_size: NSUInteger, hidden_size: NSUInteger, layer_count: NSUInteger, uses_biases: bool, batch_first: bool, is_bidirectional: bool, returns_sequences: bool, dropout: c_float, ) -> Retained<Self>

👎Deprecated

pub unsafe fn descriptorWithInputSize_hiddenSize_layerCount_usesBiases_batchFirst_isBidirectional_returnsSequences_dropout_resultMode( input_size: NSUInteger, hidden_size: NSUInteger, layer_count: NSUInteger, uses_biases: bool, batch_first: bool, is_bidirectional: bool, returns_sequences: bool, dropout: c_float, result_mode: MLCLSTMResultMode, ) -> Retained<Self>

👎Deprecated

Available on crate feature MLCTypes only.

Creates a LSTM descriptor.

Parameter inputSize: The number of expected features in the input

Parameter hiddenSize: The number of features in the hidden state

Parameter layerCount: Number of recurrent layers

Parameter usesBiases: If NO, the layer does not use bias weights. Default: YES

Parameter batchFirst: LSTM only supports batchFirst=YES. This means the input and output will have shape [batch size, time steps, feature]. Default is YES.

Parameter isBidirectional: If YES, becomes a bi-directional LSTM. Default: NO

Parameter returnsSequences: if YES return output for all sequences else return output only for the last sequences. Default: YES

Parameter dropout: If non-zero, introduces a dropout layer on the outputs of each LSTM layer except the last layer with dropout probability equal to dropout.

Parameter resultMode: expected result tensors. MLCLSTMResultModeOutput returns output data. MLCLSTMResultModeOutputAndStates returns output data, last hidden state h_n, and last cell state c_n. Default: MLCLSTMResultModeOutput.

Returns: A valid MLCLSTMDescriptor object or nil, if failure.

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 MLCLSTMDescriptor

fn as_ref(&self) -> &AnyObject

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

impl AsRef<MLCLSTMDescriptor> for MLCLSTMDescriptor

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for MLCLSTMDescriptor

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for MLCLSTMDescriptor

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for MLCLSTMDescriptor

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for MLCLSTMDescriptor

const NAME: &'static str = "MLCLSTMDescriptor"

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

type Super = NSObject

The superclass of this class.

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

type Result = MLCLSTMDescriptor

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

impl Debug for MLCLSTMDescriptor

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

Formats the value using the given formatter.

impl Deref for MLCLSTMDescriptor

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for MLCLSTMDescriptor

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 MLCLSTMDescriptor

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCopying for MLCLSTMDescriptor

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 MLCLSTMDescriptor

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 MLCLSTMDescriptor

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 MLCLSTMDescriptor

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

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

impl DowncastTarget for MLCLSTMDescriptor

impl Eq for MLCLSTMDescriptor