Struct MTLTensorDescriptor 

pub struct MTLTensorDescriptor { /* private fields */ }

Available on crate feature MTLTensor only.

A configuration type for creating new tensor instances.

See also Apple’s documentation

Implementations

impl MTLTensorDescriptor

pub fn dimensions(&self) -> Retained<MTLTensorExtents>

An array of sizes, in elements, one for each dimension of the tensors you create with this descriptor.

The default value of this property is a rank one extents with size one.

pub fn setDimensions(&self, dimensions: &MTLTensorExtents)

Setter for dimensions.

This is copied when set.

pub fn strides(&self) -> Option<Retained<MTLTensorExtents>>

An array of strides, in elements, one for each dimension in the tensors you create with this descriptor, if applicable.

This property only applies to tensors you create from a buffer, otherwise it is nil. You are responsible for ensuring strides meets the following requirements:

• Elements of stridesare in monotonically non-decreasing order.
• The first element of strides is one.
• For any i larger than zero, strides[i] is greater than or equal to strides[i-1] * dimensions[i-1].
• If usage contains MTLTensorUsage/MTLTensorUsageMachineLearning, the second element of strides is aligned to 64 bytes, and for any i larger than one, strides[i] is equal to strides[i-1] * dimensions[i-1].

pub fn setStrides(&self, strides: Option<&MTLTensorExtents>)

Setter for strides.

This is copied when set.

pub fn dataType(&self) -> MTLTensorDataType

A data format for the tensors you create with this descriptor.

The default value of this property is MTLTensorDataType/MTLTensorDataTypeFloat32.

pub fn setDataType(&self, data_type: MTLTensorDataType)

Setter for dataType.

pub fn usage(&self) -> MTLTensorUsage

A set of contexts in which you can use tensors you create with this descriptor.

The default value for this property is a bitwise OR of:

• MTLTensorUsage/MTLTensorUsageRender
• MTLTensorUsage/MTLTensorUsageCompute

pub fn setUsage(&self, usage: MTLTensorUsage)

Setter for usage.

pub fn resourceOptions(&self) -> MTLResourceOptions

Available on crate feature MTLResource only.

A packed set of the storageMode, cpuCacheMode and hazardTrackingMode properties.

pub fn setResourceOptions(&self, resource_options: MTLResourceOptions)

Available on crate feature MTLResource only.

Setter for resourceOptions.

pub fn cpuCacheMode(&self) -> MTLCPUCacheMode

Available on crate feature MTLResource only.

A value that configures the cache mode of CPU mapping of tensors you create with this descriptor.

The default value of this property is MTLCPUCacheMode/MTLCPUCacheModeDefaultCache.

pub fn setCpuCacheMode(&self, cpu_cache_mode: MTLCPUCacheMode)

Available on crate feature MTLResource only.

Setter for cpuCacheMode.

pub fn storageMode(&self) -> MTLStorageMode

Available on crate feature MTLResource only.

A value that configures the memory location and access permissions of tensors you create with this descriptor.

The default value of this property defaults to MTLStorageMode/MTLStorageModeShared.

pub fn setStorageMode(&self, storage_mode: MTLStorageMode)

Available on crate feature MTLResource only.

Setter for storageMode.

pub fn hazardTrackingMode(&self) -> MTLHazardTrackingMode

Available on crate feature MTLResource only.

A value that configures the hazard tracking of tensors you create with this descriptor.

The default value of this property is MTLHazardTrackingMode/MTLHazardTrackingModeDefault.

pub fn setHazardTrackingMode(&self, hazard_tracking_mode: MTLHazardTrackingMode)

Available on crate feature MTLResource only.

Setter for hazardTrackingMode.

impl MTLTensorDescriptor

Methods declared on superclass NSObject.

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

pub 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 MTLTensorDescriptor

fn as_ref(&self) -> &AnyObject

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

impl AsRef<MTLTensorDescriptor> for MTLTensorDescriptor

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for MTLTensorDescriptor

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for MTLTensorDescriptor

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for MTLTensorDescriptor

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for MTLTensorDescriptor

const NAME: &'static str = "MTLTensorDescriptor"

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

type Super = NSObject

The superclass of this class.

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

type Result = MTLTensorDescriptor

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

impl Debug for MTLTensorDescriptor

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

Formats the value using the given formatter.

impl DefaultRetained for MTLTensorDescriptor

fn default_retained() -> Retained<Self>

The default Retained for a type.

impl Deref for MTLTensorDescriptor

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for MTLTensorDescriptor

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 MTLTensorDescriptor

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCopying for MTLTensorDescriptor

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 MTLTensorDescriptor

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 MTLTensorDescriptor

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 MTLTensorDescriptor

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

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

impl DowncastTarget for MTLTensorDescriptor

impl Eq for MTLTensorDescriptor