Struct MLCLossDescriptor

Source

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

👎Deprecated

Available on crate feature MLCLossDescriptor only.

Expand description

The MLCLossDescriptor specifies a loss filter descriptor.

Implementations§

Source §

impl MLCLossDescriptor

Source

pub unsafe fn lossType(&self) -> MLCLossType

👎Deprecated

Available on crate feature MLCTypes only.

Specifies the loss function.

Source

pub unsafe fn reductionType(&self) -> MLCReductionType

👎Deprecated

Available on crate feature MLCTypes only.

The reduction operation performed by the loss function.

Source

pub unsafe fn weight(&self) -> c_float

👎Deprecated

The scale factor to apply to each element of a result. The default value is 1.0.

Source

pub unsafe fn labelSmoothing(&self) -> c_float

👎Deprecated

The label smoothing parameter. The default value is 0.0.

This parameter is valid only for the loss functions of the following type(s): MLCLossTypeSoftmaxCrossEntropy and MLCLossTypeSigmoidCrossEntropy.

Source

pub unsafe fn classCount(&self) -> NSUInteger

👎Deprecated

The number of classes parameter. The default value is 1.

This parameter is valid only for the loss function MLCLossTypeSoftmaxCrossEntropy.

Source

pub unsafe fn epsilon(&self) -> c_float

👎Deprecated

The epsilon parameter. The default value is 1e-7.

This parameter is valid only for the loss function MLCLossTypeLog.

Source

pub unsafe fn delta(&self) -> c_float

👎Deprecated

The delta parameter. The default value is 1.0f.

This parameter is valid only for the loss function MLCLossTypeHuber.

Source

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

👎Deprecated

Source

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

👎Deprecated

Source

pub unsafe fn descriptorWithType_reductionType( loss_type: MLCLossType, reduction_type: MLCReductionType, ) -> Retained<Self>

👎Deprecated

Available on crate feature MLCTypes only.

Create a loss descriptor object

Parameter lossType: The loss function.

Parameter reductionType: The reduction operation

Returns: A new MLCLossDescriptor object

Source

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

👎Deprecated

Available on crate feature MLCTypes only.

Create a loss descriptor object

Parameter lossType: The loss function.

Parameter reductionType: The reduction operation

Parameter weight: The scale factor to apply to each element of a result.

Returns: A new MLCLossDescriptor object

Source

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

👎Deprecated

Available on crate feature MLCTypes only.

Create a loss descriptor object

Parameter lossType: The loss function.

Parameter reductionType: The reduction operation

Parameter weight: The scale factor to apply to each element of a result.

Parameter labelSmoothing: The label smoothing parameter.

Parameter classCount: The number of classes parameter.

Returns: A new MLCLossDescriptor object

Source

pub unsafe fn descriptorWithType_reductionType_weight_labelSmoothing_classCount_epsilon_delta( loss_type: MLCLossType, reduction_type: MLCReductionType, weight: c_float, label_smoothing: c_float, class_count: NSUInteger, epsilon: c_float, delta: c_float, ) -> Retained<Self>

👎Deprecated

Available on crate feature MLCTypes only.

Create a loss descriptor object

Parameter lossType: The loss function.

Parameter reductionType: The reduction operation

Parameter weight: The scale factor to apply to each element of a result.

Parameter labelSmoothing: The label smoothing parameter.

Parameter classCount: The number of classes parameter.

Parameter epsilon: The epsilon used by LogLoss

Parameter delta: The delta parameter used by Huber loss

Returns: A new MLCLossDescriptor object

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