Struct MPSGraphPooling2DOpDescriptor 

pub struct MPSGraphPooling2DOpDescriptor { /* private fields */ }

Available on crate features MPSGraphCore and MPSGraphPoolingOps only.

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

Use this descriptor with the following methods:

• MPSGraph/maxPooling2DWithSourceTensor:descriptor:name:
• MPSGraph/maxPooling2DReturnIndicesWithSourceTensor:descriptor:name:
• MPSGraph/maxPooling2DGradientWithGradientTensor:sourceTensor:descriptor:name:
• MPSGraph/maxPooling2DGradientWithGradientTensor:indicesTensor:outputShape:descriptor:name:
• MPSGraph/maxPooling2DGradientWithGradientTensor:indicesTensor:outputShapeTensor:descriptor:name:
• MPSGraph/avgPooling2DWithSourceTensor:descriptor:name:
• MPSGraph/avgPooling2DGradientWithGradientTensor:sourceTensor:descriptor:name:

See also Apple’s documentation

Implementations

impl MPSGraphPooling2DOpDescriptor

pub unsafe fn kernelWidth(&self) -> NSUInteger

Defines the pooling window size for the width dimension.

pub unsafe fn setKernelWidth(&self, kernel_width: NSUInteger)

Setter for kernelWidth.

pub unsafe fn kernelHeight(&self) -> NSUInteger

Defines the pooling window size for the height dimension.

pub unsafe fn setKernelHeight(&self, kernel_height: NSUInteger)

Setter for kernelHeight.

pub unsafe fn strideInX(&self) -> NSUInteger

Defines the stride for the width dimension.

Default value: 1.

pub unsafe fn setStrideInX(&self, stride_in_x: NSUInteger)

Setter for strideInX.

pub unsafe fn strideInY(&self) -> NSUInteger

Defines the stride for the height dimension.

Default value: 1.

pub unsafe fn setStrideInY(&self, stride_in_y: NSUInteger)

Setter for strideInY.

pub unsafe fn dilationRateInX(&self) -> NSUInteger

Defines the dilation rate for the width dimension.

Default value: 1.

pub unsafe fn setDilationRateInX(&self, dilation_rate_in_x: NSUInteger)

Setter for dilationRateInX.

pub unsafe fn dilationRateInY(&self) -> NSUInteger

Defines the dilation rate for the height dimension.

Default value: 1.

pub unsafe fn setDilationRateInY(&self, dilation_rate_in_y: NSUInteger)

Setter for dilationRateInY.

pub unsafe fn paddingLeft(&self) -> NSUInteger

Defines the explicit padding value for the width dimension to add before the data.

Default value: 0.

pub unsafe fn setPaddingLeft(&self, padding_left: NSUInteger)

Setter for paddingLeft.

pub unsafe fn paddingRight(&self) -> NSUInteger

Defines the explicit padding value for the width dimension to add after the data.

Default value: 0.

pub unsafe fn setPaddingRight(&self, padding_right: NSUInteger)

Setter for paddingRight.

pub unsafe fn paddingTop(&self) -> NSUInteger

Defines the explicit padding value for the height dimension to add before the data.

Default value: 0.

pub unsafe fn setPaddingTop(&self, padding_top: NSUInteger)

Setter for paddingTop.

pub unsafe fn paddingBottom(&self) -> NSUInteger

Defines the explicit padding value for the height dimension to add after the data.

Default value: 0.

pub unsafe fn setPaddingBottom(&self, padding_bottom: NSUInteger)

Setter for paddingBottom.

pub unsafe fn paddingStyle(&self) -> MPSGraphPaddingStyle

Defines what kind of padding graph applies to the operation.

Default value: MPSGraphPaddingStyleExplicit.

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

Setter for paddingStyle.

pub unsafe fn dataLayout(&self) -> MPSGraphTensorNamedDataLayout

Defines the data layout of the input data in the forward pass. See: MPSGraphTensorNamedDataLayout.

pub unsafe fn setDataLayout(&self, data_layout: MPSGraphTensorNamedDataLayout)

Setter for dataLayout.

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/maxPooling2DReturnIndicesWithSourceTensor:descriptor:name: API. If returnIndicesMode = MPSGraphPoolingReturnIndicesNone then only the first result MPSGraph returns from MPSGraph/maxPooling2DReturnIndicesWithSourceTensor:descriptor:name: will be valid and using the second result will assert. Default value: MPSGraphPoolingReturnIndicesNone.

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

Setter for returnIndicesMode.

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/maxPooling2DReturnIndicesWithSourceTensor:descriptor:name: API. Currently MPSGraph supports the following datatypes: MPSDataTypeInt32. Default value: MPSDataTypeInt32.

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

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

Setter for returnIndicesDataType.

pub unsafe fn ceilMode(&self) -> bool

Affects how the graph 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.

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

Setter for ceilMode.

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.

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

Setter for includeZeroPadToAverage.

pub unsafe fn descriptorWithKernelWidth_kernelHeight_strideInX_strideInY_dilationRateInX_dilationRateInY_paddingLeft_paddingRight_paddingTop_paddingBottom_paddingStyle_dataLayout( kernel_width: NSUInteger, kernel_height: NSUInteger, stride_in_x: NSUInteger, stride_in_y: NSUInteger, dilation_rate_in_x: NSUInteger, dilation_rate_in_y: NSUInteger, padding_left: NSUInteger, padding_right: NSUInteger, padding_top: NSUInteger, padding_bottom: NSUInteger, padding_style: MPSGraphPaddingStyle, data_layout: MPSGraphTensorNamedDataLayout, ) -> Option<Retained<Self>>

Creates a 2D pooling descriptor with given values.

• Parameters:
• kernelWidth: See kernelWidth property.
• kernelHeight: See kernelHeight property.
• strideInX: See strideInX property.
• strideInY: See strideInY property.
• dilationRateInX: See dilationRateInX property.
• dilationRateInY: See dilationRateInY property.
• paddingLeft: See paddingLeft property.
• paddingRight: See paddingRight property.
• paddingTop: See paddingTop property.
• paddingBottom: See paddingBottom property.
• paddingStyle: See paddingStyle property.
• dataLayout: See dataLayout property.
• Returns: The descriptor on autoreleasepool.

pub unsafe fn descriptorWithKernelWidth_kernelHeight_strideInX_strideInY_paddingStyle_dataLayout( kernel_width: NSUInteger, kernel_height: NSUInteger, stride_in_x: NSUInteger, stride_in_y: NSUInteger, padding_style: MPSGraphPaddingStyle, data_layout: MPSGraphTensorNamedDataLayout, ) -> Option<Retained<Self>>

Creates a 2D pooling descriptor with given values.

• Parameters:
• kernelWidth: See kernelWidth property.
• kernelHeight: See `kernelHeight`` property.
• strideInX: See strideInX property.
• strideInY: See strideInY property.
• paddingStyle: See paddingStyle property.
• dataLayout: See dataLayout property.
• Returns: The descriptor on autoreleasepool.

pub unsafe fn setExplicitPaddingWithPaddingLeft_paddingRight_paddingTop_paddingBottom( &self, padding_left: NSUInteger, padding_right: NSUInteger, padding_top: NSUInteger, padding_bottom: NSUInteger, )

Sets the explicit padding values and sets padding style to explicit.

• Parameters:
• paddingLeft: See paddingLeft property.
• paddingRight: See paddingRight property.
• paddingTop: See paddingTop property.
• paddingBottom: See paddingBottom property.

impl MPSGraphPooling2DOpDescriptor

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 MPSGraphPooling2DOpDescriptor

fn as_ref(&self) -> &AnyObject

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

impl AsRef<MPSGraphObject> for MPSGraphPooling2DOpDescriptor

fn as_ref(&self) -> &MPSGraphObject

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

impl AsRef<MPSGraphPooling2DOpDescriptor> for MPSGraphPooling2DOpDescriptor

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for MPSGraphPooling2DOpDescriptor

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for MPSGraphPooling2DOpDescriptor

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<MPSGraphObject> for MPSGraphPooling2DOpDescriptor

fn borrow(&self) -> &MPSGraphObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for MPSGraphPooling2DOpDescriptor

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for MPSGraphPooling2DOpDescriptor

const NAME: &'static str = "MPSGraphPooling2DOpDescriptor"

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

type Super = MPSGraphObject

The superclass of this class.

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

type Result = MPSGraphPooling2DOpDescriptor

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

impl Debug for MPSGraphPooling2DOpDescriptor

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

Formats the value using the given formatter.

impl Deref for MPSGraphPooling2DOpDescriptor

type Target = MPSGraphObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for MPSGraphPooling2DOpDescriptor

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 MPSGraphPooling2DOpDescriptor

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCopying for MPSGraphPooling2DOpDescriptor

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 MPSGraphPooling2DOpDescriptor

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 MPSGraphPooling2DOpDescriptor

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 MPSGraphPooling2DOpDescriptor

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

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

impl DowncastTarget for MPSGraphPooling2DOpDescriptor

impl Eq for MPSGraphPooling2DOpDescriptor