Struct MLCOptimizerDescriptor

Source
#[repr(C)]
pub struct MLCOptimizerDescriptor { /* private fields */ }
👎Deprecated
Available on crate feature MLCOptimizerDescriptor only.
Expand description

The MLCOptimizerDescriptor specifies an optimizer descriptor.

See also Apple’s documentation

Implementations§

Source§

impl MLCOptimizerDescriptor

Source

pub unsafe fn learningRate(&self) -> c_float

👎Deprecated

The learning rate

Source

pub unsafe fn gradientRescale(&self) -> c_float

👎Deprecated

The rescale value applied to gradients during optimizer update

Source

pub unsafe fn appliesGradientClipping(&self) -> bool

👎Deprecated

Whether gradient clipping should be applied or not.

The default is false

Source

pub unsafe fn gradientClipMax(&self) -> c_float

👎Deprecated

The maximum gradient value if gradient clipping is enabled before gradient is rescaled.

Source

pub unsafe fn gradientClipMin(&self) -> c_float

👎Deprecated

The minimum gradient value if gradient clipping is enabled before gradient is rescaled.

Source

pub unsafe fn regularizationScale(&self) -> c_float

👎Deprecated

The regularization scale.

Source

pub unsafe fn regularizationType(&self) -> MLCRegularizationType

👎Deprecated
Available on crate feature MLCTypes only.

The regularization type.

Source

pub unsafe fn gradientClippingType(&self) -> MLCGradientClippingType

Available on crate feature MLCTypes only.

The type of clipping applied to gradient

Source

pub unsafe fn maximumClippingNorm(&self) -> c_float

The maximum clipping value

Source

pub unsafe fn customGlobalNorm(&self) -> c_float

Used only with MLCGradientClippingTypeByGlobalNorm. If non zero, this norm will be used in place of global norm.

Source

pub unsafe fn descriptorWithLearningRate_gradientRescale_regularizationType_regularizationScale( learning_rate: c_float, gradient_rescale: c_float, regularization_type: MLCRegularizationType, regularization_scale: c_float, ) -> Retained<Self>

👎Deprecated
Available on crate feature MLCTypes only.

Create a MLCOptimizerDescriptor object

Parameter learningRate: The learning rate

Parameter gradientRescale: The gradient rescale value

Parameter regularizationType: The regularization type

Parameter regularizationScale: The regularization scale

Returns: A new MLCOptimizerDescriptor object.

Source

pub unsafe fn descriptorWithLearningRate_gradientRescale_appliesGradientClipping_gradientClipMax_gradientClipMin_regularizationType_regularizationScale( learning_rate: c_float, gradient_rescale: c_float, applies_gradient_clipping: bool, gradient_clip_max: c_float, gradient_clip_min: c_float, regularization_type: MLCRegularizationType, regularization_scale: c_float, ) -> Retained<Self>

👎Deprecated
Available on crate feature MLCTypes only.

Create a MLCOptimizerDescriptor object

Parameter learningRate: The learning rate

Parameter gradientRescale: The gradient rescale value

Parameter appliesGradientClipping: Whether to apply gradient clipping

Parameter gradientClipMax: The maximum gradient value to be used with gradient clipping

Parameter gradientClipMin: The minimum gradient value to be used with gradient clipping

Parameter regularizationType: The regularization type

Parameter regularizationScale: The regularization scale

Returns: A new MLCOptimizerDescriptor object.

Source

pub unsafe fn descriptorWithLearningRate_gradientRescale_appliesGradientClipping_gradientClippingType_gradientClipMax_gradientClipMin_maximumClippingNorm_customGlobalNorm_regularizationType_regularizationScale( learning_rate: c_float, gradient_rescale: c_float, applies_gradient_clipping: bool, gradient_clipping_type: MLCGradientClippingType, gradient_clip_max: c_float, gradient_clip_min: c_float, maximum_clipping_norm: c_float, custom_global_norm: c_float, regularization_type: MLCRegularizationType, regularization_scale: c_float, ) -> Retained<Self>

Available on crate feature MLCTypes only.

Create an MLCOptimizerDescriptor object

Parameter learningRate: The learning rate

Parameter gradientRescale: The gradient rescale value

Parameter appliesGradientClipping: Whether to apply gradient clipping

Parameter gradientClippingType: The type of clipping applied to gradients

Parameter gradientClipMax: The maximum gradient value to be used with gradient clipping

Parameter gradientClipMin: The minimum gradient value to be used with gradient clipping

Parameter maximumClippingNorm: The maximum norm to be used with gradient clipping

Parameter customGlobalNorm: If non-zero, the norm to be used instead of calculating the global norm

Parameter regularizationType: The regularization type

Parameter regularizationScale: The regularization scale

Returns: A new MLCOptimizerDescriptor object.

Source§

impl MLCOptimizerDescriptor

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

Trait Implementations§

Source§

impl AsRef<AnyObject> for MLCOptimizerDescriptor

Source§

fn as_ref(&self) -> &AnyObject

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

impl AsRef<MLCOptimizerDescriptor> for MLCOptimizerDescriptor

Source§

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for MLCOptimizerDescriptor

Source§

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for MLCOptimizerDescriptor

Source§

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value. Read more
Source§

impl Borrow<NSObject> for MLCOptimizerDescriptor

Source§

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value. Read more
Source§

impl ClassType for MLCOptimizerDescriptor

Source§

const NAME: &'static str = "MLCOptimizerDescriptor"

The name of the Objective-C class that this type represents. Read more
Source§

type Super = NSObject

The superclass of this class. Read more
Source§

type ThreadKind = <<MLCOptimizerDescriptor as ClassType>::Super as ClassType>::ThreadKind

Whether the type can be used from any thread, or from only the main thread. Read more
Source§

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents. Read more
Source§

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.
Source§

impl CopyingHelper for MLCOptimizerDescriptor

Source§

type Result = MLCOptimizerDescriptor

The immutable counterpart of the type, or Self if the type has no immutable counterpart. Read more
Source§

impl Debug for MLCOptimizerDescriptor

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Deref for MLCOptimizerDescriptor

Source§

type Target = NSObject

The resulting type after dereferencing.
Source§

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

Dereferences the value.
Source§

impl Hash for MLCOptimizerDescriptor

Source§

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Message for MLCOptimizerDescriptor

Source§

fn retain(&self) -> Retained<Self>
where Self: Sized,

Increment the reference count of the receiver. Read more
Source§

impl NSCopying for MLCOptimizerDescriptor

Source§

fn copy(&self) -> Retained<Self::Result>
where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver. Read more
Source§

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. Read more
Source§

impl NSObjectProtocol for MLCOptimizerDescriptor

Source§

fn isEqual(&self, other: Option<&AnyObject>) -> bool
where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object. Read more
Source§

fn hash(&self) -> usize
where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure. Read more
Source§

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. Read more
Source§

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. Read more
Source§

fn isMemberOfClass(&self, cls: &AnyClass) -> bool
where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses. Read more
Source§

fn respondsToSelector(&self, aSelector: Sel) -> bool
where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector. Read more
Source§

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool
where Self: Sized + Message,

Check whether the object conforms to a given protocol. Read more
Source§

fn description(&self) -> Retained<NSObject>
where Self: Sized + Message,

A textual representation of the object. Read more
Source§

fn debugDescription(&self) -> Retained<NSObject>
where Self: Sized + Message,

A textual representation of the object to use when debugging. Read more
Source§

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. Read more
Source§

fn retainCount(&self) -> usize
where Self: Sized + Message,

The reference count of the object. Read more
Source§

impl PartialEq for MLCOptimizerDescriptor

Source§

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl RefEncode for MLCOptimizerDescriptor

Source§

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

The Objective-C type-encoding for a reference of this type. Read more
Source§

impl DowncastTarget for MLCOptimizerDescriptor

Source§

impl Eq for MLCOptimizerDescriptor

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<'a, T> AnyThread for T
where T: ClassType<ThreadKind = dyn AnyThread + 'a> + ?Sized,

Source§

fn alloc() -> Allocated<Self>
where Self: Sized + ClassType,

Allocate a new instance of the class. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> AutoreleaseSafe for T
where T: ?Sized,