Struct MTL4MachineLearningPipelineDescriptor

Source

pub struct MTL4MachineLearningPipelineDescriptor { /* private fields */ }

Available on crate features MTL4MachineLearningPipeline and MTL4PipelineState only.

Expand description

Description for a machine learning pipeline state.

Implementations§

Source §

impl MTL4MachineLearningPipelineDescriptor

Source

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

Assigns an optional string that helps identify pipeline states you create from this descriptor.

Source

pub fn setLabel(&self, label: Option<&NSString>)

Setter for label.

This is copied when set.

Source

pub fn machineLearningFunctionDescriptor( &self, ) -> Option<Retained<MTL4FunctionDescriptor>>

Available on crate feature MTL4FunctionDescriptor only.

Assigns the function that the machine learning pipeline you create from this descriptor executes.

Source

pub fn setMachineLearningFunctionDescriptor( &self, machine_learning_function_descriptor: Option<&MTL4FunctionDescriptor>, )

Available on crate feature MTL4FunctionDescriptor only.

Setter for machineLearningFunctionDescriptor.

This is copied when set.

Source

pub unsafe fn setInputDimensions_atBufferIndex( &self, dimensions: Option<&MTLTensorExtents>, buffer_index: NSInteger, )

Available on crate feature MTLTensor only.

Sets the dimension of an input tensor at a buffer index.

Parameters:
dimensions: the dimensions of the tensor.
bufferIndex: Index of the tensor to modify.

§Safety

bufferIndex might not be bounds-checked.

Source

pub unsafe fn setInputDimensions_withRange( &self, dimensions: &NSArray<MTLTensorExtents>, range: NSRange, )

Available on crate feature MTLTensor only.

Sets the dimensions of multiple input tensors on a range of buffer bindings.

Use this method to specify the dimensions of multiple input tensors at a range of indices in a single call.

You can indicate that any tensors in the range have unspecified dimensions by providing NSNull at the their corresponding index location in the array.

Important: The range’s length property needs to match the number of dimensions you provide. Specifically, range.length needs to match dimensions.count.
Parameters:
dimensions: An array of tensor extents.
range: The range of inputs of the dimensions argument. The range’s length needs to match the dimensions’ count property.

§Safety

range might not be bounds-checked.

Source

pub unsafe fn inputDimensionsAtBufferIndex( &self, buffer_index: NSInteger, ) -> Option<Retained<MTLTensorExtents>>

Available on crate feature MTLTensor only.

Obtains the dimensions of the input tensor at bufferIndex if set, nil otherwise.

§Safety

bufferIndex might not be bounds-checked.

Source

pub fn reset(&self)

Resets the descriptor to its default values.

Source §

impl MTL4MachineLearningPipelineDescriptor

Methods declared on superclass NSObject.

Source

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

Source

pub fn new() -> Retained<Self>

Methods from Deref<Target = MTL4PipelineDescriptor>§

Source

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

Assigns an optional string that uniquely identifies a pipeline descriptor.

After you provide this label, you can use it to look up a pipeline state object by name in a binary archive.

Source

pub fn setLabel(&self, label: Option<&NSString>)

Setter for label.

This is copied when set.

Source

pub fn options(&self) -> Option<Retained<MTL4PipelineOptions>>

Provides compile-time options when you build the pipeline.

Source

pub fn setOptions(&self, options: Option<&MTL4PipelineOptions>)

Setter for options.

Methods from Deref<Target = NSObject>§

Source

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>§

Source

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());

Source

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.

Source

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`
    }
}