Struct MPSGraphTensorData 

pub struct MPSGraphTensorData { /* private fields */ }

Available on crate features MPSGraphCore and MPSGraphTensorData only.

The representation of a compute data type.

Pass data to a graph using a tensor data, a reference will be taken to your data and used just in time when the graph is run.

See also Apple’s documentation

Implementations

impl MPSGraphTensorData

pub unsafe fn shape(&self) -> Retained<MPSShape>

Available on crate feature objc2-metal-performance-shaders only.

The shape of the tensor data.

pub unsafe fn dataType(&self) -> MPSDataType

Available on crate feature objc2-metal-performance-shaders only.

The data type of the tensor data.

pub unsafe fn device(&self) -> Retained<MPSGraphDevice>

Available on crate feature MPSGraphDevice only.

The device of the tensor data.

pub unsafe fn initWithDevice_data_shape_dataType( this: Allocated<Self>, device: &MPSGraphDevice, data: &NSData, shape: &MPSShape, data_type: MPSDataType, ) -> Retained<Self>

Available on crate features MPSGraphDevice and objc2-metal-performance-shaders only.

Initializes the tensor data with an NSData on a device.

• Parameters:
• device: MPSDevice on which the MPSGraphTensorData exists
• data: NSData from which to copy the contents
• shape: shape of the output tensor
• dataType: dataType of the placeholder tensor
• Returns: A valid MPSGraphTensorData, or nil if allocation failure.

pub unsafe fn initWithMTLBuffer_shape_dataType( this: Allocated<Self>, buffer: &ProtocolObject<dyn MTLBuffer>, shape: &MPSShape, data_type: MPSDataType, ) -> Retained<Self>

Available on crate feature objc2-metal-performance-shaders only.

Initializes an tensor data with a metal buffer.

The device of the MTLBuffer will be used to get the MPSDevice for this MPSGraphTensorData.

• Parameters:
• buffer: MTLBuffer to be used within the MPSGraphTensorData
• shape: shape of the output tensor
• dataType: dataType of the placeholder tensor
• Returns: A valid MPSGraphTensorData, or nil if allocation failure.

Safety

• buffer may need to be synchronized.
• buffer may be unretained, you must ensure it is kept alive while in use.
• buffer contents should be of the correct type.

pub unsafe fn initWithMTLBuffer_shape_dataType_rowBytes( this: Allocated<Self>, buffer: &ProtocolObject<dyn MTLBuffer>, shape: &MPSShape, data_type: MPSDataType, row_bytes: NSUInteger, ) -> Retained<Self>

Available on crate feature objc2-metal-performance-shaders only.

Initializes an tensor data with a metal buffer.

The device of the MTLBuffer will be used to get the MPSDevice for this MPSGraphTensorData.

• Parameters:
• buffer: MTLBuffer to be used within the MPSGraphTensorData
• shape: shape of the output tensor
• dataType: dataType of the placeholder tensor
• rowBytes: rowBytes for the fastest moving dimension, must be larger than or equal to sizeOf(dataType)shape[rank - 1] and must be a multiple of sizeOf(dataType)
• Returns: A valid MPSGraphTensorData, or nil if allocation failure.

Safety

• buffer may need to be synchronized.
• buffer may be unretained, you must ensure it is kept alive while in use.
• buffer contents should be of the correct type.

pub unsafe fn initWithMPSMatrix( this: Allocated<Self>, matrix: &MPSMatrix, ) -> Retained<Self>

Available on crate feature objc2-metal-performance-shaders only.

Initializes a tensor data with an MPS matrix.

The device of the MPSMatrix will be used to get the MPSDevice for this MPSGraphTensorData.

• Parameters:
• matrix: MPSMatrix to be used within the MPSGraphTensorData
• Returns: A valid MPSGraphTensorData, or nil if allocation failure.

pub unsafe fn initWithMPSMatrix_rank( this: Allocated<Self>, matrix: &MPSMatrix, rank: NSUInteger, ) -> Retained<Self>

Available on crate feature objc2-metal-performance-shaders only.

Initializes a tensor data with an MPS matrix enforcing rank of the result.

The device of the MPSMatrix will be used to get the MPSDevice for this MPSGraphTensorData.

• Parameters:
• matrix: MPSMatrix to be used within the MPSGraphTensorData
• rank: The rank of the resulting TensorData tensor. NOTE: must be within { 1, … ,16 }.
• Returns: A valid MPSGraphTensorData of given rank, or nil if allocation failure.

pub unsafe fn initWithMPSVector( this: Allocated<Self>, vector: &MPSVector, ) -> Retained<Self>

Available on crate feature objc2-metal-performance-shaders only.

Initializes a tensor data with an MPS vector.

The device of the MPSVector will be used to get the MPSDevice for this MPSGraphTensorData.

• Parameters:
• vector: MPSVector to be used within the MPSGraphTensorData
• Returns: A valid MPSGraphTensorData, or nil if allocation failure.

pub unsafe fn initWithMPSVector_rank( this: Allocated<Self>, vector: &MPSVector, rank: NSUInteger, ) -> Retained<Self>

Available on crate feature objc2-metal-performance-shaders only.

Initializes a tensor data with an MPS vector enforcing rank of the result.

The device of the MPSVector will be used to get the MPSDevice for this MPSGraphTensorData.

• Parameters:
• vector: MPSVector to be used within the MPSGraphTensorData
• rank: The rank of the resulting TensorData tensor. NOTE: must be within { 1, … ,16 }.
• Returns: A valid MPSGraphTensorData, or nil if allocation failure.

pub unsafe fn initWithMPSNDArray( this: Allocated<Self>, ndarray: &MPSNDArray, ) -> Retained<Self>

Available on crate feature objc2-metal-performance-shaders only.

Initializes an MPSGraphTensorData with an MPS ndarray.

The device of the MPSNDArray will be used to get the MPSDevice for this MPSGraphTensorData.

• Parameters:
• ndarray: MPSNDArray to be used within the MPSGraphTensorData.
• Returns: A valid MPSGraphTensorData, or nil if allocation failure.

pub unsafe fn initWithMPSImageBatch( this: Allocated<Self>, image_batch: &MPSImageBatch, ) -> Retained<Self>

Available on crate feature objc2-metal-performance-shaders only.

Initializes a tensor data with an MPS image batch.

The dataLayout used will be NHWC, call a transpose or permute to change to a layout of your choice.

• Parameters:
• imageBatch: The device on which the kernel will run, unorm8 and unorm16 images will create a float32 tensorData
• Returns: A valid MPSGraphTensorData, or nil if allocation failure.

pub unsafe fn initWithMTLTensor( this: Allocated<Self>, tensor: &ProtocolObject<dyn MTLTensor>, ) -> Retained<Self>

Initializes an MPSGraphTensorData with an MTLTensor.

The internal storage of the MTLTensor will be aliased. Requires tensor to support MTLTensorUsageMachineLearning.

• Parameters:
• tensor: MTLTensor to be used within the MPSGraphTensorData
• Returns: A valid MPSGraphTensorData, or nil if allocation failure.

Safety

• tensor may need to be synchronized.
• tensor may be unretained, you must ensure it is kept alive while in use.

pub unsafe fn mpsndarray(&self) -> Retained<MPSNDArray>

Available on crate feature objc2-metal-performance-shaders only.

Return an mpsndarray object will copy contents if the contents are not stored in an MPS ndarray.

• Returns: A valid MPSNDArray, or nil if allocation fails.

impl MPSGraphTensorData

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 MPSGraphTensorData

fn as_ref(&self) -> &AnyObject

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

impl AsRef<MPSGraphObject> for MPSGraphTensorData

fn as_ref(&self) -> &MPSGraphObject

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

impl AsRef<MPSGraphTensorData> for MPSGraphTensorData

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for MPSGraphTensorData

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for MPSGraphTensorData

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<MPSGraphObject> for MPSGraphTensorData

fn borrow(&self) -> &MPSGraphObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for MPSGraphTensorData

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for MPSGraphTensorData

const NAME: &'static str = "MPSGraphTensorData"

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

type Super = MPSGraphObject

The superclass of this class.

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

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

Formats the value using the given formatter.

impl Deref for MPSGraphTensorData

type Target = MPSGraphObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for MPSGraphTensorData

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 MPSGraphTensorData

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for MPSGraphTensorData

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 MPSGraphTensorData

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 MPSGraphTensorData

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

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

impl DowncastTarget for MPSGraphTensorData

impl Eq for MPSGraphTensorData