Struct MPSMatrixCopyDescriptor 

pub struct MPSMatrixCopyDescriptor { /* private fields */ }

Available on crate feature MPSMatrixCombination only.

A list of copy operations

The MPSMatrixCopy filter can do multiple copy operations. For RNN filters, these copies are often small, and are more efficient when grouped together. The MPSMatriceCopyDescriptor provides a container to list the operations. The operations occur in any order, and may not alias.

See also Apple’s documentation

Implementations

impl MPSMatrixCopyDescriptor

pub unsafe fn descriptorWithSourceMatrix_destinationMatrix_offsets( source_matrix: &MPSMatrix, destination_matrix: &MPSMatrix, offsets: MPSMatrixCopyOffsets, ) -> Retained<Self>

Available on crate features MPSMatrix and MPSCore only.

convenience allocator for single copies

pub unsafe fn initWithDevice_count( this: Allocated<Self>, device: &ProtocolObject<dyn MTLDevice>, count: NSUInteger, ) -> Retained<Self>

Available on crate feature MPSMatrix only.

initialize a MPSMatrixCopyDescriptor with default values.

Use -setCopyOperationAtIndex:sourceMatrix:destinationMatrix:copyOffsets to initialize. All indices must be initialized before use.

Parameter device: The device on which the copy will be performed

Parameter count: The number of copy operations the object will encode

Returns: A MPSMatrixCopyDescriptor. It still needs to be initialized with -setCopyOperationAtIndex:sourceMatrix:destinationMatrix:copyOffsets

pub unsafe fn setCopyOperationAtIndex_sourceMatrix_destinationMatrix_offsets( &self, index: NSUInteger, source_matrix: &MPSMatrix, destination_matrix: &MPSMatrix, offsets: MPSMatrixCopyOffsets, )

Available on crate features MPSMatrix and MPSCore only.

Initialize a MPSMatrixCopyDescriptor using offsets generated on the CPU

This is for one at a time intialization of the copy operations

Parameter index: The index of the copy operation

Parameter sourceMatrix: The source matrix for this copy operation

Parameter destinationMatrix: The destination matrix for this copy operation

Parameter offsets: The offsets to use for the copy operation

pub unsafe fn initWithSourceMatrices_destinationMatrices_offsetVector_offset( this: Allocated<Self>, source_matrices: &NSArray<MPSMatrix>, destination_matrices: &NSArray<MPSMatrix>, offsets: Option<&MPSVector>, byte_offset: NSUInteger, ) -> Retained<Self>

Available on crate features MPSMatrix and MPSCore only.

Initialize a MPSMatrixCopyDescriptor using offsets generated on the GPU

Use this method when the offsets needed are coming from GPU based computation.

Parameter sourceMatrices: A list of matrices from which the matrix data is read

Parameter destinationMatrices: A list of matrices to which to write the data. The count must match the number of source matrices.

Parameter offsets: A MPSVector of type MPSDataTypeUInt32 containing the list of offsets, stored as a packed array of MPSMatrixCopyOffsets.

Parameter byteOffset: A byte offset into the offsets vector where the data starts in ‘offsets’. This value must be a multiple of 16.

Returns: A valid MPSMatrixCopyDescriptor to represent the list of copy operations

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

Available on crate feature MPSMatrix only.

impl MPSMatrixCopyDescriptor

Methods declared on superclass NSObject.

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

Available on crate feature MPSMatrix only.

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 MPSMatrixCopyDescriptor

Available on crate feature MPSMatrix only.

fn as_ref(&self) -> &AnyObject

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

impl AsRef<MPSMatrixCopyDescriptor> for MPSMatrixCopyDescriptor

Available on crate feature MPSMatrix only.

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for MPSMatrixCopyDescriptor

Available on crate feature MPSMatrix only.

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for MPSMatrixCopyDescriptor

Available on crate feature MPSMatrix only.

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for MPSMatrixCopyDescriptor

Available on crate feature MPSMatrix only.

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for MPSMatrixCopyDescriptor

Available on crate feature MPSMatrix only.

const NAME: &'static str = "MPSMatrixCopyDescriptor"

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

type Super = NSObject

The superclass of this class.

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

Available on crate feature MPSMatrix only.

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

Formats the value using the given formatter.

impl Deref for MPSMatrixCopyDescriptor

Available on crate feature MPSMatrix only.

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for MPSMatrixCopyDescriptor

Available on crate feature MPSMatrix only.

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 MPSMatrixCopyDescriptor

Available on crate feature MPSMatrix only.

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for MPSMatrixCopyDescriptor

Available on crate feature MPSMatrix only.

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 MPSMatrixCopyDescriptor

Available on crate feature MPSMatrix only.

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 MPSMatrixCopyDescriptor

Available on crate feature MPSMatrix only.

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

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

impl DowncastTarget for MPSMatrixCopyDescriptor

Available on crate feature MPSMatrix only.

impl Eq for MPSMatrixCopyDescriptor

Available on crate feature MPSMatrix only.