Struct MPSGraphRandomOpDescriptor

Source

pub struct MPSGraphRandomOpDescriptor { /* private fields */ }

Available on crate features MPSGraphCore and MPSGraphRandomOps only.

Expand description

A class that describes the random operation.

Implementations§

Source §

impl MPSGraphRandomOpDescriptor

Source

pub unsafe fn distribution(&self) -> MPSGraphRandomDistribution

The type of distribution to draw samples from. See MPSGraphRandomDistribution.

Source

pub unsafe fn setDistribution(&self, distribution: MPSGraphRandomDistribution)

Setter for distribution.

Source

pub unsafe fn dataType(&self) -> MPSDataType

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

The data type of the generated result values.

When sampling from the uniform distribution, valid types are MPSDataTypeFloat16, MPSDataTypeFloat32, and MPSDataTypeInt32. When sampling from the normal or truncated normal distribution, valid types are MPSDataTypeFloat16 and MPSDataTypeFloat32.

Source

pub unsafe fn setDataType(&self, data_type: MPSDataType)

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

Setter for dataType.

Source

pub unsafe fn min(&self) -> c_float

The lower range of the distribution.

This value is used for Uniform distributions with float data types and Truncated Normal disributions. Defaults to 0 for uniform distributions and -2 for normal distributions.

Source

pub unsafe fn setMin(&self, min: c_float)

Setter for min.

Source

pub unsafe fn max(&self) -> c_float

The upper range of the distribution.

This value is used for Uniform distributions with float data types and Truncated Normal disributions. Defaults to 1 for uniform distributions and 2 for normal distributions.

Source

pub unsafe fn setMax(&self, max: c_float)

Setter for max.

Source

pub unsafe fn minInteger(&self) -> NSInteger

The lower range of the distribution.

This value is used for Uniform with integer data types Defaults to 0.

Source

pub unsafe fn setMinInteger(&self, min_integer: NSInteger)

Setter for minInteger.

Source

pub unsafe fn maxInteger(&self) -> NSInteger

The upper range of the distribution.

This value is used for Uniform with integer data types Defaults to INT32_MAX for uniform distributions and 0 for normal distributions.

Source

pub unsafe fn setMaxInteger(&self, max_integer: NSInteger)

Setter for maxInteger.

Source

pub unsafe fn mean(&self) -> c_float

The mean of the distribution.

This value is used for Normal and Truncated Normal disributions. Defaults to 0.

Source

pub unsafe fn setMean(&self, mean: c_float)

Setter for mean.

Source

pub unsafe fn standardDeviation(&self) -> c_float

The standard deviation of the distribution.

This value is used for Normal and Truncated Normal disributions. For Truncated Normal distribution this defines the standard deviation parameter of the underlying Normal distribution, that is the width of the Gaussian, not the true standard deviation of the truncated distribution which typically differs from the standard deviation of the original Normal distribution. Defaults to 0 for uniform distributions and 1 for normal distributions.

Source

pub unsafe fn setStandardDeviation(&self, standard_deviation: c_float)

Setter for standardDeviation.

Source

pub unsafe fn samplingMethod(&self) -> MPSGraphRandomNormalSamplingMethod

The sampling method of the distribution.

This value is used for Normal and Truncated Normal disributions. See MPSGraphRandomNormalSamplingMethod. Defaults to MPSGraphRandomNormalSamplingInvCDF.

Source

pub unsafe fn setSamplingMethod( &self, sampling_method: MPSGraphRandomNormalSamplingMethod, )

Setter for samplingMethod.

Source

pub unsafe fn descriptorWithDistribution_dataType( distribution: MPSGraphRandomDistribution, data_type: MPSDataType, ) -> Option<Retained<Self>>

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

Class method to initialize a distribution descriptor.

Source §

impl MPSGraphRandomOpDescriptor

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