Struct MLCLossLayer

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

👎Deprecated

Available on crate features MLCLayer and MLCLossLayer only.

A loss layer

See also Apple’s documentation

Implementations

impl MLCLossLayer

pub unsafe fn descriptor(&self) -> Retained<MLCLossDescriptor>

👎Deprecated

Available on crate feature MLCLossDescriptor only.

The loss descriptor

pub unsafe fn weights(&self) -> Option<Retained<MLCTensor>>

👎Deprecated

Available on crate feature MLCTensor only.

The loss label weights tensor

pub unsafe fn layerWithDescriptor( loss_descriptor: &MLCLossDescriptor, ) -> Retained<Self>

👎Deprecated

Available on crate feature MLCLossDescriptor only.

Create a loss layer

Parameter lossDescriptor: The loss descriptor

Returns: A new loss layer.

pub unsafe fn layerWithDescriptor_weights( loss_descriptor: &MLCLossDescriptor, weights: &MLCTensor, ) -> Retained<Self>

👎Deprecated

Available on crate features MLCLossDescriptor and MLCTensor only.

Create a MLComputeLoss layer

Parameter lossDescriptor: The loss descriptor

Parameter weights: The loss label weights tensor

Returns: A new loss layer.

pub unsafe fn softmaxCrossEntropyLossWithReductionType_labelSmoothing_classCount_weight( reduction_type: MLCReductionType, label_smoothing: c_float, class_count: NSUInteger, weight: c_float, ) -> Retained<Self>

👎Deprecated

Available on crate feature MLCTypes only.

Create a loss layer

Parameter reductionType: The reduction type to use

Parameter labelSmoothing: Label smoothing value

Parameter classCount: Number of classes

Parameter weight: A scalar floating point value

Returns: A new softmax cross entropy loss layer.

pub unsafe fn softmaxCrossEntropyLossWithReductionType_labelSmoothing_classCount_weights( reduction_type: MLCReductionType, label_smoothing: c_float, class_count: NSUInteger, weights: Option<&MLCTensor>, ) -> Retained<Self>

👎Deprecated

Available on crate features MLCTensor and MLCTypes only.

Create a loss layer

Parameter reductionType: The reduction type to use

Parameter labelSmoothing: Label smoothing value

Parameter classCount: Number of classes

Parameter weights: The loss label weights tensor

Returns: A new softmax cross entropy loss layer.

pub unsafe fn categoricalCrossEntropyLossWithReductionType_labelSmoothing_classCount_weight( reduction_type: MLCReductionType, label_smoothing: c_float, class_count: NSUInteger, weight: c_float, ) -> Retained<Self>

👎Deprecated

Available on crate feature MLCTypes only.

Create a loss layer

Parameter reductionType: The reduction type to use

Parameter labelSmoothing: Label smoothing value

Parameter classCount: Number of classes

Parameter weight: A scalar floating point value

Returns: A new categorical cross entropy loss layer.

pub unsafe fn categoricalCrossEntropyLossWithReductionType_labelSmoothing_classCount_weights( reduction_type: MLCReductionType, label_smoothing: c_float, class_count: NSUInteger, weights: Option<&MLCTensor>, ) -> Retained<Self>

👎Deprecated

Available on crate features MLCTensor and MLCTypes only.

Create a loss layer

Parameter reductionType: The reduction type to use

Parameter labelSmoothing: Label smoothing value

Parameter classCount: Number of classes

Parameter weights: The loss label weights tensor

Returns: A new categorical cross entropy loss layer.

pub unsafe fn sigmoidCrossEntropyLossWithReductionType_labelSmoothing_weight( reduction_type: MLCReductionType, label_smoothing: c_float, weight: c_float, ) -> Retained<Self>

👎Deprecated

Available on crate feature MLCTypes only.

Create a loss layer

Parameter reductionType: The reduction type to use

Parameter labelSmoothing: Label smoothing value

Parameter weight: A scalar floating-point value

Returns: A new sigmoid cross entropy loss layer.

pub unsafe fn sigmoidCrossEntropyLossWithReductionType_labelSmoothing_weights( reduction_type: MLCReductionType, label_smoothing: c_float, weights: Option<&MLCTensor>, ) -> Retained<Self>

👎Deprecated

Available on crate features MLCTensor and MLCTypes only.

Create a loss layer

Parameter reductionType: The reduction type to use

Parameter labelSmoothing: Label smoothing value

Parameter weights: The loss label weights tensor

Returns: A new sigmoid cross entropy loss layer.

pub unsafe fn logLossWithReductionType_epsilon_weight( reduction_type: MLCReductionType, epsilon: c_float, weight: c_float, ) -> Retained<Self>

👎Deprecated

Available on crate feature MLCTypes only.

Create a loss layer

Parameter reductionType: The reduction type to use

Parameter epsilon: The epsilon parameter

Parameter weight: A scalar floating-point value

Returns: A new log loss layer.

pub unsafe fn logLossWithReductionType_epsilon_weights( reduction_type: MLCReductionType, epsilon: c_float, weights: Option<&MLCTensor>, ) -> Retained<Self>

👎Deprecated

Available on crate features MLCTensor and MLCTypes only.

Create a loss layer

Parameter reductionType: The reduction type to use

Parameter epsilon: The epsilon parameter

Parameter weights: The loss label weights tensor

Returns: A new log loss layer.

pub unsafe fn huberLossWithReductionType_delta_weight( reduction_type: MLCReductionType, delta: c_float, weight: c_float, ) -> Retained<Self>

👎Deprecated

Available on crate feature MLCTypes only.

Create a loss layer

Parameter reductionType: The reduction type to use

Parameter delta: The delta parameter

Parameter weight: A scalar floating-point value

Returns: A new huber loss layer.

pub unsafe fn huberLossWithReductionType_delta_weights( reduction_type: MLCReductionType, delta: c_float, weights: Option<&MLCTensor>, ) -> Retained<Self>

👎Deprecated

Available on crate features MLCTensor and MLCTypes only.

Create a loss layer

Parameter reductionType: The reduction type to use

Parameter delta: The delta parameter

Parameter weights: The loss label weights tensor

Returns: A new huber loss layer.

pub unsafe fn meanAbsoluteErrorLossWithReductionType_weight( reduction_type: MLCReductionType, weight: c_float, ) -> Retained<Self>

👎Deprecated

Available on crate feature MLCTypes only.

Create a loss layer

Parameter reductionType: The reduction type to use

Parameter weight: A scalar floating-point value

Returns: A new L1 i.e. mean absolute error loss layer.

pub unsafe fn meanAbsoluteErrorLossWithReductionType_weights( reduction_type: MLCReductionType, weights: Option<&MLCTensor>, ) -> Retained<Self>

👎Deprecated

Available on crate features MLCTensor and MLCTypes only.

Create a loss layer

Parameter reductionType: The reduction type to use

Parameter weights: The loss label weights tensor

Returns: A new L1 i.e. mean absolute error loss layer.

pub unsafe fn meanSquaredErrorLossWithReductionType_weight( reduction_type: MLCReductionType, weight: c_float, ) -> Retained<Self>

👎Deprecated

Available on crate feature MLCTypes only.

Create a loss layer

Parameter reductionType: The reduction type to use

Parameter weight: A scalar floating-point value

Returns: A new L2 i.e. mean squared error loss layer.

pub unsafe fn meanSquaredErrorLossWithReductionType_weights( reduction_type: MLCReductionType, weights: Option<&MLCTensor>, ) -> Retained<Self>

👎Deprecated

Available on crate features MLCTensor and MLCTypes only.

Create a loss layer

Parameter reductionType: The reduction type to use

Parameter weights: The loss label weights tensor

Returns: A new L2 i.e. mean squared error loss layer.

pub unsafe fn hingeLossWithReductionType_weight( reduction_type: MLCReductionType, weight: c_float, ) -> Retained<Self>

👎Deprecated

Available on crate feature MLCTypes only.

Create a loss layer

Parameter reductionType: The reduction type to use

Parameter weight: A scalar floating-point value

Returns: A new hinge loss layer.

pub unsafe fn hingeLossWithReductionType_weights( reduction_type: MLCReductionType, weights: Option<&MLCTensor>, ) -> Retained<Self>

👎Deprecated

Available on crate features MLCTensor and MLCTypes only.

Create a loss layer

Parameter reductionType: The reduction type to use

Parameter weights: The loss label weights tensor

Returns: A new hinge loss layer.

pub unsafe fn cosineDistanceLossWithReductionType_weight( reduction_type: MLCReductionType, weight: c_float, ) -> Retained<Self>

👎Deprecated

Available on crate feature MLCTypes only.

Create a loss layer

Parameter reductionType: The reduction type to use

Parameter weight: A scalar floating-point value

Returns: A new cosine distance loss layer.

pub unsafe fn cosineDistanceLossWithReductionType_weights( reduction_type: MLCReductionType, weights: Option<&MLCTensor>, ) -> Retained<Self>

👎Deprecated

Available on crate features MLCTensor and MLCTypes only.

Create a loss layer

Parameter reductionType: The reduction type to use

Parameter weights: The loss label weights tensor

Returns: A new cosine distance loss layer.

impl MLCLossLayer

Methods declared on superclass MLCLayer.

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

👎Deprecated

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

👎Deprecated

Methods from Deref<Target = MLCLayer>

pub unsafe fn layerID(&self) -> NSUInteger

👎Deprecated

The layer ID

A unique number to identify each layer. Assigned when the layer is created.

pub unsafe fn label(&self) -> Retained<NSString>

👎Deprecated

A string to help identify this object.

pub unsafe fn setLabel(&self, label: &NSString)

👎Deprecated

Setter for label.

pub unsafe fn isDebuggingEnabled(&self) -> bool

👎Deprecated

A flag to identify if we want to debug this layer when executing a graph that includes this layer

If this is set, we will make sure that the result tensor and gradient tensors are available for reading on CPU The default is NO. If isDebuggingEnabled is set to YES, make sure to set options to enable debugging when compiling the graph. Otherwise this property may be ignored.

pub unsafe fn setIsDebuggingEnabled(&self, is_debugging_enabled: bool)

👎Deprecated

Setter for isDebuggingEnabled.

pub unsafe fn deviceType(&self) -> MLCDeviceType

Available on crate feature MLCTypes only.

The device type where this layer will be executed

Typically the MLCDevice passed to compileWithOptions will be the device used to execute layers in the graph. If MLCDeviceTypeANE is selected, it is possible that some of the layers of the graph may not be executed on the ANE but instead on the CPU or GPU. This property can be used to determine which device type the layer will be executed on.

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 MLCLossLayer

fn as_ref(&self) -> &AnyObject

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

impl AsRef<MLCLayer> for MLCLossLayer

fn as_ref(&self) -> &MLCLayer

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

impl AsRef<MLCLossLayer> for MLCLossLayer

fn as_ref(&self) -> &Self

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

impl AsRef<MLCLossLayer> for MLCYOLOLossLayer

Available on crate feature MLCYOLOLossLayer only.

fn as_ref(&self) -> &MLCLossLayer

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

impl AsRef<NSObject> for MLCLossLayer

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for MLCLossLayer

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<MLCLayer> for MLCLossLayer

fn borrow(&self) -> &MLCLayer

Immutably borrows from an owned value.

impl Borrow<MLCLossLayer> for MLCYOLOLossLayer

Available on crate feature MLCYOLOLossLayer only.

fn borrow(&self) -> &MLCLossLayer

Immutably borrows from an owned value.

impl Borrow<NSObject> for MLCLossLayer

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for MLCLossLayer

const NAME: &'static str = "MLCLossLayer"

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

type Super = MLCLayer

The superclass of this class.

type ThreadKind = <<MLCLossLayer 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 Debug for MLCLossLayer

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

Formats the value using the given formatter.

impl Deref for MLCLossLayer

type Target = MLCLayer

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for MLCLossLayer

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 MLCLossLayer

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for MLCLossLayer

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 MLCLossLayer

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 MLCLossLayer

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

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

impl DowncastTarget for MLCLossLayer

impl Eq for MLCLossLayer