Struct MPSGraphPooling4DOpDescriptor

Source

pub struct MPSGraphPooling4DOpDescriptor { /* private fields */ }

Available on crate features MPSGraphCore and MPSGraphPoolingOps only.

Expand description

The class that defines the parameters for a 4D pooling operation.

Use this descriptor with the following methods:

MPSGraph/maxPooling4DWithSourceTensor:descriptor:name:
MPSGraph/maxPooling4DReturnIndicesWithSourceTensor:descriptor:name:
MPSGraph/maxPooling4DGradientWithGradientTensor:sourceTensor:descriptor:name:
MPSGraph/maxPooling4DGradientWithGradientTensor:indicesTensor:outputShape:descriptor:name:
MPSGraph/maxPooling4DGradientWithGradientTensor:indicesTensor:outputShapeTensor:descriptor:name:
MPSGraph/avgPooling4DWithSourceTensor:descriptor:name:
MPSGraph/avgPooling4DGradientWithGradientTensor:sourceTensor:descriptor:name:
MPSGraph/L2NormPooling4DWithSourceTensor:descriptor:name:
MPSGraph/L2NormPooling4DGradientWithGradientTensor:sourceTensor:descriptor:name:

Implementations§

Source §

impl MPSGraphPooling4DOpDescriptor

Source

pub unsafe fn kernelSizes(&self) -> Retained<NSArray<NSNumber>>

Defines the pooling window size.

Must be four numbers, one for each spatial dimension, fastest running index last.

Source

pub unsafe fn setKernelSizes(&self, kernel_sizes: &NSArray<NSNumber>)

Setter for kernelSizes.

This is copied when set.

Source

pub unsafe fn strides(&self) -> Retained<NSArray<NSNumber>>

Defines strides for spatial dimensions. Must be four numbers, one for each spatial dimension, fastest running index last.

Default value: @ [ @ 1, @ 1, @ 1, @ 1 ]

Source

pub unsafe fn setStrides(&self, strides: &NSArray<NSNumber>)

Setter for strides.

This is copied when set.

Source

pub unsafe fn dilationRates(&self) -> Retained<NSArray<NSNumber>>

Defines dilation rates for spatial dimensions. Must be four numbers, one for each spatial dimension, fastest running index last.

Default value: @ [ @ 1, @ 1, @ 1, @ 1 ]

Source

pub unsafe fn setDilationRates(&self, dilation_rates: &NSArray<NSNumber>)

Setter for dilationRates.

This is copied when set.

Source

pub unsafe fn paddingValues(&self) -> Retained<NSArray<NSNumber>>

Defines padding values for spatial dimensions which must be eight numbers, two for each spatial dimension.

For example paddingValues[0] defines the explicit padding amount before the first spatial dimension (slowest running index of spatial dimensions), paddingValues[1] defines the padding amount after the first spatial dimension etc. Used only when paddingStyle = MPSGraphPaddingStyleExplicit. Default value: @ [ @ 0, @ 0, @ 0, @ 0, @ 0, @ 0, @ 0, @ 0 ]

Source

pub unsafe fn setPaddingValues(&self, padding_values: &NSArray<NSNumber>)

Setter for paddingValues.

This is copied when set.

Source

pub unsafe fn paddingStyle(&self) -> MPSGraphPaddingStyle

Defines what kind of padding graph applies to the operation.

Default value: MPSGraphPaddingStyleExplicit.

Source

pub unsafe fn setPaddingStyle(&self, padding_style: MPSGraphPaddingStyle)

Setter for paddingStyle.

Source

pub unsafe fn ceilMode(&self) -> bool

Affects how MPSGraph computes the output size: if set to YES then output size is computed by rounding up instead of down when dividing input size by stride.

Default value: NO.

Source

pub unsafe fn setCeilMode(&self, ceil_mode: bool)

Setter for ceilMode.

Source

pub unsafe fn includeZeroPadToAverage(&self) -> bool

Defines a mode for average pooling, where samples outside the input tensor count as zeroes in the average computation.

Otherwise the result is sum over samples divided by number of samples that didn’t come from padding. Default value: NO.

Source

pub unsafe fn setIncludeZeroPadToAverage( &self, include_zero_pad_to_average: bool, )

Setter for includeZeroPadToAverage.

Source

pub unsafe fn returnIndicesMode(&self) -> MPSGraphPoolingReturnIndicesMode

Defines the mode for returned indices of maximum values within each pooling window.

Use this in conjunction with MPSGraph/maxPooling4DReturnIndicesWithSourceTensor:descriptor:name: API. If returnIndicesMode = MPSGraphPoolingReturnIndicesNone then only the first result MPSGraph returns from MPSGraph/maxPooling4DReturnIndicesWithSourceTensor:descriptor:name: will be valid and using the second result will assert. Default value: MPSGraphPoolingReturnIndicesNone.

Source

pub unsafe fn setReturnIndicesMode( &self, return_indices_mode: MPSGraphPoolingReturnIndicesMode, )

Setter for returnIndicesMode.

Source

pub unsafe fn returnIndicesDataType(&self) -> MPSDataType

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

Defines the data type for returned indices.

Use this in conjunction with MPSGraph/maxPooling4DReturnIndicesWithSourceTensor:descriptor:name: API. Currently MPSGraph supports the following datatypes: MPSDataTypeInt32. Default value: MPSDataTypeInt32.

Source

pub unsafe fn setReturnIndicesDataType( &self, return_indices_data_type: MPSDataType, )

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

Setter for returnIndicesDataType.

Source

pub unsafe fn descriptorWithKernelSizes_strides_dilationRates_paddingValues_paddingStyle( kernel_sizes: &NSArray<NSNumber>, strides: &NSArray<NSNumber>, dilation_rates: &NSArray<NSNumber>, padding_values: &NSArray<NSNumber>, padding_style: MPSGraphPaddingStyle, ) -> Option<Retained<Self>>

Creates a 4D pooling descriptor with given values.

Parameters:
kernelSizes: See kernelSizes property.
strides: See strides property.
dilationRates: See dilationRates property.
paddingValues: See paddingValues property.
paddingStyle: See paddingStyle property.
Returns: The descriptor on autoreleasepool.

Source

pub unsafe fn descriptorWithKernelSizes_paddingStyle( kernel_sizes: &NSArray<NSNumber>, padding_style: MPSGraphPaddingStyle, ) -> Option<Retained<Self>>

Creates a 4D pooling descriptor with default values.

Parameters:
kernelSizes: See kernelSizes property.
paddingStyle: See paddingStyle property.
Returns: The descriptor on autoreleasepool.

Source §

impl MPSGraphPooling4DOpDescriptor

Methods declared on superclass NSObject.

Source

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

Source

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

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