Struct Convolution2DOpDescriptor

Source

pub struct Convolution2DOpDescriptor { /* private fields */ }

Expand description

A class that describes the properties of a 2D-convolution operator.

Use an instance of this class is to add a 2D-convolution operator with the desired properties to the graph.

Implementations§

Source §

impl Convolution2DOpDescriptor

Source

pub fn stride_in_x(&self) -> u64

Returns the scale that maps the destination x-coordinate to the source x-coordinate.

§Details

The source coordinate sx is computed from the destination coordinate dx as sx = strideInX * dx. The default value is 1.

§Returns

The scale factor applied to the x dimension.

Source

pub fn set_stride_in_x(&self, stride_in_x: u64)

Sets the stride_in_x property.

§Arguments

stride_in_x – The new scale factor.

Source

pub fn stride_in_y(&self) -> u64

Returns the scale that maps the destination y-coordinate to the source y-coordinate.

§Details

The source coordinate sy is computed from the destination coordinate dy as sy = strideInY * dy. The default value is 1.

§Returns

The scale factor applied to the y dimension.

Source

pub fn set_stride_in_y(&self, stride_in_y: u64)

Sets the stride_in_y property.

§Arguments

stride_in_y – The new scale factor.

Source

pub fn dilation_rate_in_x(&self) -> u64

Returns the amount by which the weights tensor expands in the x direction.

§Details

Expansion is achieved by inserting dilationRateInX - 1 zeros between consecutive values in the x dimension of the weights tensor. The resulting dilated width is (dilationRateInX - 1) * kernelWidth + 1. The default value is 1.

§Returns

The dilation rate along the x axis.

Source

pub fn set_dilation_rate_in_x(&self, dilation_rate_in_x: u64)

Sets the dilation_rate_in_x property.

§Arguments

dilation_rate_in_x – The new dilation rate.

Source

pub fn dilation_rate_in_y(&self) -> u64

Returns the amount by which the weights tensor expands in the y direction.

§Details

Expansion is achieved by inserting dilationRateInY - 1 zeros between consecutive values in the y dimension of the weights tensor. The resulting dilated height is (dilationRateInY - 1) * kernelHeight + 1. The default value is 1.

§Returns

The dilation rate along the y axis.

Source

pub fn set_dilation_rate_in_y(&self, dilation_rate_in_y: u64)

Sets the dilation_rate_in_y property.

§Arguments

dilation_rate_in_y – The new dilation rate.

Source

pub fn padding_left(&self) -> u64

Returns the number of zeros added to the left side of the source tensor.

§Returns

The left padding value.

Source

pub fn set_padding_left(&self, padding_left: u64)

Sets the padding_left property.

§Arguments

padding_left – Number of zeros to add on the left.

Source

pub fn padding_right(&self) -> u64

Returns the number of zeros added to the right side of the source tensor.

§Returns

The right padding value.

Source

pub fn set_padding_right(&self, padding_right: u64)

Sets the padding_right property.

§Arguments

padding_right – Number of zeros to add on the right.

Source

pub fn padding_top(&self) -> u64

Returns the number of zeros added to the top of the source tensor.

§Returns

The top padding value.

Source

pub fn set_padding_top(&self, padding_top: u64)

Sets the padding_top property.

§Arguments

padding_top – Number of zeros to add on the top.

Source

pub fn padding_bottom(&self) -> u64

Returns the number of zeros added to the bottom of the source tensor.

§Returns

The bottom padding value.

Source

pub fn set_padding_bottom(&self, padding_bottom: u64)

Sets the padding_bottom property.

§Arguments

padding_bottom – Number of zeros to add on the bottom.

Source

pub fn padding_style(&self) -> PaddingStyle

Returns the padding style applied to the source tensor.

§Details

If the style is PaddingStyle::Explicit, the individual padding values (padding_left, padding_right, padding_top, padding_bottom) must be specified. For all other styles, the framework computes these values automatically.

§Returns

The selected PaddingStyle.

Source

pub fn set_padding_style(&self, padding_style: PaddingStyle)

Sets the padding_style property.

§Arguments

padding_style – The new padding style.

Source

pub fn data_layout(&self) -> TensorNamedDataLayout

Returns the named layout of data in the source tensor.

§Returns

The current TensorNamedDataLayout for the source tensor.

Source

pub fn set_data_layout(&self, data_layout: TensorNamedDataLayout)

Sets the data_layout property.

§Arguments

data_layout – The desired layout of the source tensor data.

Source

pub fn weights_layout(&self) -> TensorNamedDataLayout

Returns the named layout of data in the weights tensor.

§Returns

The current TensorNamedDataLayout for the weights tensor.

Source

pub fn set_weights_layout(&self, weights_layout: TensorNamedDataLayout)

Sets the weights_layout property.

§Arguments

weights_layout – The desired layout of the weights tensor data.

Source

pub fn groups(&self) -> u64

Returns the number of channel partitions (groups).

§Details

Input and output channels are divided into groups partitions. Input channels in a partition are only connected to output channels in the corresponding partition.

§Returns

The number of groups.

Source

pub fn set_groups(&self, groups: u64)

Sets the groups property.

§Arguments

groups – The desired number of channel partitions.

Source

pub fn descriptor_with_stride_in_x_stride_in_y_dilation_rate_in_x_dilation_rate_in_y_groups_padding_left_padding_right_padding_top_padding_bottom_padding_style_data_layout_weights_layout( stride_in_x: u64, stride_in_y: u64, dilation_rate_in_x: u64, dilation_rate_in_y: u64, groups: u64, padding_left: u64, padding_right: u64, padding_top: u64, padding_bottom: u64, padding_style: PaddingStyle, data_layout: TensorNamedDataLayout, weights_layout: TensorNamedDataLayout, ) -> Option<Retained<Self>>

Creates a convolution descriptor with the supplied parameter values.

§Arguments

stride_in_x – See stride_in_x.
stride_in_y – See stride_in_y.
dilation_rate_in_x – See dilation_rate_in_x.
dilation_rate_in_y – See dilation_rate_in_y.
groups – See groups.
padding_left – See padding_left.
padding_right – See padding_right.
padding_top – See padding_top.
padding_bottom – See padding_bottom.
padding_style – See padding_style.
data_layout – See data_layout.
weights_layout – See weights_layout.

§Returns

A new MPSGraphConvolution2DOpDescriptor.

Source

pub fn descriptor_with_stride_in_x_stride_in_y_dilation_rate_in_x_dilation_rate_in_y_groups_padding_style_data_layout_weights_layout( stride_in_x: u64, stride_in_y: u64, dilation_rate_in_x: u64, dilation_rate_in_y: u64, groups: u64, padding_style: PaddingStyle, data_layout: TensorNamedDataLayout, weights_layout: TensorNamedDataLayout, ) -> Option<Retained<Self>>

Creates a convolution descriptor with the supplied parameter values.

§Arguments

stride_in_x – See stride_in_x.
stride_in_y – See stride_in_y.
dilation_rate_in_x – See dilation_rate_in_x.
dilation_rate_in_y – See dilation_rate_in_y.
groups – See groups.
padding_style – See padding_style.
data_layout – See data_layout.
weights_layout – See weights_layout.

§Returns

A new MPSGraphConvolution2DOpDescriptor.

Source

pub fn set_explicit_padding_with_padding_left_padding_right_padding_top_padding_bottom( &self, padding_left: u64, padding_right: u64, padding_top: u64, padding_bottom: u64, )

Sets the explicit padding values on all sides of the source tensor.

§Arguments

padding_left – See padding_left.
padding_right – See padding_right.
padding_top – See padding_top.
padding_bottom – See padding_bottom.

Source §

impl Convolution2DOpDescriptor

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