Struct MLCPoolingDescriptor

#[repr(C)]
pub struct MLCPoolingDescriptor { /* private fields */ }

👎Deprecated

Available on crate feature MLCPoolingDescriptor only.

The MLCPoolingDescriptor specifies a pooling descriptor.

See also Apple’s documentation

Implementations

impl MLCPoolingDescriptor

pub unsafe fn poolingType(&self) -> MLCPoolingType

👎Deprecated

Available on crate feature MLCTypes only.

The pooling operation

pub unsafe fn kernelWidth(&self) -> NSUInteger

👎Deprecated

The pooling kernel size in x.

pub unsafe fn kernelHeight(&self) -> NSUInteger

👎Deprecated

The pooling kernel size in y.

pub unsafe fn strideInX(&self) -> NSUInteger

👎Deprecated

The stride of the kernel in x.

pub unsafe fn strideInY(&self) -> NSUInteger

👎Deprecated

The stride of the kernel in y.

pub unsafe fn dilationRateInX(&self) -> NSUInteger

👎Deprecated

The dilation rate i.e. stride of elements in the kernel in x.

pub unsafe fn dilationRateInY(&self) -> NSUInteger

👎Deprecated

The dilation rate i.e. stride of elements in the kernel in y.

pub unsafe fn paddingPolicy(&self) -> MLCPaddingPolicy

👎Deprecated

Available on crate feature MLCTypes only.

The padding policy to use.

pub unsafe fn paddingSizeInX(&self) -> NSUInteger

👎Deprecated

The padding size in x (left and right) to use if paddingPolicy is MLCPaddingPolicyUsePaddingSize

pub unsafe fn paddingSizeInY(&self) -> NSUInteger

👎Deprecated

The padding size in y (top and bottom) to use if paddingPolicy is MLCPaddingPolicyUsePaddingSize

pub unsafe fn countIncludesPadding(&self) -> bool

👎Deprecated

Include the zero-padding in the averaging calculation if true. Used only with average pooling.

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

👎Deprecated

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

👎Deprecated

pub unsafe fn poolingDescriptorWithType_kernelSize_stride( pooling_type: MLCPoolingType, kernel_size: NSUInteger, stride: NSUInteger, ) -> Retained<Self>

👎Deprecated

Available on crate feature MLCTypes only.

Create a MLCPoolingDescriptor object

Parameter poolingType: The pooling function

Parameter kernelSize: The kernel sizes in x and y

Parameter stride: The kernel strides in x and y

Returns: A new MLCPoolingDescriptor object.

pub unsafe fn maxPoolingDescriptorWithKernelSizes_strides_paddingPolicy_paddingSizes( kernel_sizes: &NSArray<NSNumber>, strides: &NSArray<NSNumber>, padding_policy: MLCPaddingPolicy, padding_sizes: Option<&NSArray<NSNumber>>, ) -> Retained<Self>

👎Deprecated

Available on crate feature MLCTypes only.

Create a MLCPoolingDescriptor object for a max pooling function

Parameter kernelSizes: The kernel sizes in x and y

Parameter strides: The kernel strides in x and y

Parameter paddingPolicy: The padding policy

Parameter paddingSizes: The padding sizes in x and y if padding policy is MLCPaddingPolicyUsePaddingSIze

Returns: A new MLCPoolingDescriptor object.

pub unsafe fn maxPoolingDescriptorWithKernelSizes_strides_dilationRates_paddingPolicy_paddingSizes( kernel_sizes: &NSArray<NSNumber>, strides: &NSArray<NSNumber>, dilation_rates: &NSArray<NSNumber>, padding_policy: MLCPaddingPolicy, padding_sizes: Option<&NSArray<NSNumber>>, ) -> Retained<Self>

👎Deprecated

Available on crate feature MLCTypes only.

Create a MLCPoolingDescriptor object for a max pooling function

Parameter kernelSizes: The kernel sizes in x and y

Parameter strides: The kernel strides in x and y

Parameter dilationRates: The kernel dilation rates in x and y

Parameter paddingPolicy: The padding policy

Parameter paddingSizes: The padding sizes in x and y if padding policy is MLCPaddingPolicyUsePaddingSIze

Returns: A new MLCPoolingDescriptor object.

pub unsafe fn averagePoolingDescriptorWithKernelSizes_strides_paddingPolicy_paddingSizes_countIncludesPadding( kernel_sizes: &NSArray<NSNumber>, strides: &NSArray<NSNumber>, padding_policy: MLCPaddingPolicy, padding_sizes: Option<&NSArray<NSNumber>>, count_includes_padding: bool, ) -> Retained<Self>

👎Deprecated

Available on crate feature MLCTypes only.

Create a MLCPoolingDescriptor object for an average pooling function

Parameter kernelSizes: The kernel sizes in x and y

Parameter strides: The kernel strides in x and y

Parameter paddingPolicy: The padding policy

Parameter paddingSizes: The padding sizes in x and y if padding policy is MLCPaddingPolicyUsePaddingSIze

Parameter countIncludesPadding: Whether to include zero padding in the averaging calculation

Returns: A new MLCPoolingDescriptor object.

pub unsafe fn averagePoolingDescriptorWithKernelSizes_strides_dilationRates_paddingPolicy_paddingSizes_countIncludesPadding( kernel_sizes: &NSArray<NSNumber>, strides: &NSArray<NSNumber>, dilation_rates: &NSArray<NSNumber>, padding_policy: MLCPaddingPolicy, padding_sizes: Option<&NSArray<NSNumber>>, count_includes_padding: bool, ) -> Retained<Self>

👎Deprecated

Available on crate feature MLCTypes only.

Create a MLCPoolingDescriptor object for an average pooling function

Parameter kernelSizes: The kernel sizes in x and y

Parameter strides: The kernel strides in x and y

Parameter dilationRates: The kernel dilation rates in x and y

Parameter paddingPolicy: The padding policy

Parameter paddingSizes: The padding sizes in x and y if padding policy is MLCPaddingPolicyUsePaddingSIze

Parameter countIncludesPadding: Whether to include zero padding in the averaging calculation

Returns: A new MLCPoolingDescriptor object.

pub unsafe fn l2NormPoolingDescriptorWithKernelSizes_strides_paddingPolicy_paddingSizes( kernel_sizes: &NSArray<NSNumber>, strides: &NSArray<NSNumber>, padding_policy: MLCPaddingPolicy, padding_sizes: Option<&NSArray<NSNumber>>, ) -> Retained<Self>

👎Deprecated

Available on crate feature MLCTypes only.

Create a MLCPoolingDescriptor object for a L2 norm pooling function

Parameter kernelSizes: The kernel sizes in x and y

Parameter strides: The kernel strides in x and y

Parameter paddingPolicy: The padding policy

Parameter paddingSizes: The padding sizes in x and y if padding policy is MLCPaddingPolicyUsePaddingSIze

Returns: A new MLCPoolingDescriptor object.

pub unsafe fn l2NormPoolingDescriptorWithKernelSizes_strides_dilationRates_paddingPolicy_paddingSizes( kernel_sizes: &NSArray<NSNumber>, strides: &NSArray<NSNumber>, dilation_rates: &NSArray<NSNumber>, padding_policy: MLCPaddingPolicy, padding_sizes: Option<&NSArray<NSNumber>>, ) -> Retained<Self>

👎Deprecated

Available on crate feature MLCTypes only.

Create a MLCPoolingDescriptor object for a L2 norm pooling function

Parameter kernelSizes: The kernel sizes in x and y

Parameter strides: The kernel strides in x and y

Parameter dilationRates: The kernel dilation rates in x and y

Parameter paddingPolicy: The padding policy

Parameter paddingSizes: The padding sizes in x and y if padding policy is MLCPaddingPolicyUsePaddingSIze

Returns: A new MLCPoolingDescriptor object.

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 MLCPoolingDescriptor

fn as_ref(&self) -> &AnyObject

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

impl AsRef<MLCPoolingDescriptor> for MLCPoolingDescriptor

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for MLCPoolingDescriptor

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for MLCPoolingDescriptor

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for MLCPoolingDescriptor

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for MLCPoolingDescriptor

const NAME: &'static str = "MLCPoolingDescriptor"

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

type Super = NSObject

The superclass of this class.

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

type Result = MLCPoolingDescriptor

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

impl Debug for MLCPoolingDescriptor

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

Formats the value using the given formatter.

impl Deref for MLCPoolingDescriptor

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for MLCPoolingDescriptor

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 MLCPoolingDescriptor

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCopying for MLCPoolingDescriptor

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 MLCPoolingDescriptor

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 MLCPoolingDescriptor

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 MLCPoolingDescriptor

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

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

impl DowncastTarget for MLCPoolingDescriptor

impl Eq for MLCPoolingDescriptor