Struct MLCAdamOptimizer

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

👎Deprecated

Available on crate features MLCAdamOptimizer and MLCOptimizer only.

The MLCAdamOptimizer specifies the Adam optimizer.

See also Apple’s documentation

Implementations

impl MLCAdamOptimizer

pub unsafe fn beta1(&self) -> c_float

👎Deprecated

Coefficent used for computing running averages of gradient.

The default is 0.9.

pub unsafe fn beta2(&self) -> c_float

👎Deprecated

Coefficent used for computing running averages of square of gradient.

The default is 0.999.

pub unsafe fn epsilon(&self) -> c_float

👎Deprecated

A term added to improve numerical stability.

The default is 1e-8.

pub unsafe fn usesAMSGrad(&self) -> bool

👎Deprecated

Whether to use the AMSGrad variant of this algorithm

The default is false

pub unsafe fn timeStep(&self) -> NSUInteger

👎Deprecated

The current timestep used for the update.

The default is 1.

pub unsafe fn optimizerWithDescriptor( optimizer_descriptor: &MLCOptimizerDescriptor, ) -> Retained<Self>

👎Deprecated

Available on crate feature MLCOptimizerDescriptor only.

Create a MLCAdamOptimizer object with defaults

Returns: A new MLCAdamOptimizer object.

pub unsafe fn optimizerWithDescriptor_beta1_beta2_epsilon_timeStep( optimizer_descriptor: &MLCOptimizerDescriptor, beta1: c_float, beta2: c_float, epsilon: c_float, time_step: NSUInteger, ) -> Retained<Self>

👎Deprecated

Available on crate feature MLCOptimizerDescriptor only.

Create a MLCAdamOptimizer object

Parameter optimizerDescriptor: The optimizer descriptor object

Parameter beta1: The beta1 value

Parameter beta2: The beta2 value

Parameter epsilon: The epsilon value to use to improve numerical stability

Parameter timeStep: The initial timestep to use for the update

Returns: A new MLCAdamOptimizer object.

pub unsafe fn optimizerWithDescriptor_beta1_beta2_epsilon_usesAMSGrad_timeStep( optimizer_descriptor: &MLCOptimizerDescriptor, beta1: c_float, beta2: c_float, epsilon: c_float, uses_ams_grad: bool, time_step: NSUInteger, ) -> Retained<Self>

Available on crate feature MLCOptimizerDescriptor only.

Create a MLCAdamOptimizer object

Parameter optimizerDescriptor: The optimizer descriptor object

Parameter beta1: The beta1 value

Parameter beta2: The beta2 value

Parameter epsilon: The epsilon value to use to improve numerical stability

Parameter usesAMSGrad: Whether to use the AMSGrad variant of this algorithm from the paper (https://arxiv.org/abs/1904.09237)

Parameter timeStep: The initial timestep to use for the update

Returns: A new MLCAdamOptimizer object.

impl MLCAdamOptimizer

Methods declared on superclass MLCOptimizer.

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

👎Deprecated

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

👎Deprecated

Methods from Deref<Target = MLCOptimizer>

pub unsafe fn learningRate(&self) -> c_float

👎Deprecated

The learning rate. This property is ‘readwrite’ so that callers can implement a ‘decay’ during training

pub unsafe fn setLearningRate(&self, learning_rate: c_float)

👎Deprecated

Setter for learningRate.

pub unsafe fn gradientRescale(&self) -> c_float

👎Deprecated

The rescale value applied to gradients during optimizer update

pub unsafe fn appliesGradientClipping(&self) -> bool

👎Deprecated

Whether gradient clipping should be applied or not.

pub unsafe fn setAppliesGradientClipping(&self, applies_gradient_clipping: bool)

👎Deprecated

Setter for appliesGradientClipping.

pub unsafe fn gradientClipMax(&self) -> c_float

👎Deprecated

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

pub unsafe fn gradientClipMin(&self) -> c_float

👎Deprecated

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

pub unsafe fn regularizationScale(&self) -> c_float

👎Deprecated

The regularization scale.

pub unsafe fn regularizationType(&self) -> MLCRegularizationType

👎Deprecated

Available on crate feature MLCTypes only.

The regularization type.

pub unsafe fn gradientClippingType(&self) -> MLCGradientClippingType

Available on crate feature MLCTypes only.

The type of clipping applied to gradient

pub unsafe fn maximumClippingNorm(&self) -> c_float

The maximum clipping value

pub unsafe fn customGlobalNorm(&self) -> c_float

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

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 MLCAdamOptimizer

fn as_ref(&self) -> &AnyObject

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

impl AsRef<MLCAdamOptimizer> for MLCAdamOptimizer

fn as_ref(&self) -> &Self

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

impl AsRef<MLCOptimizer> for MLCAdamOptimizer

fn as_ref(&self) -> &MLCOptimizer

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

impl AsRef<NSObject> for MLCAdamOptimizer

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for MLCAdamOptimizer

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<MLCOptimizer> for MLCAdamOptimizer

fn borrow(&self) -> &MLCOptimizer

Immutably borrows from an owned value.

impl Borrow<NSObject> for MLCAdamOptimizer

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for MLCAdamOptimizer

const NAME: &'static str = "MLCAdamOptimizer"

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

type Super = MLCOptimizer

The superclass of this class.

type ThreadKind = <<MLCAdamOptimizer 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 CopyingHelper for MLCAdamOptimizer

type Result = MLCAdamOptimizer

The immutable counterpart of the type, or Self if the type has no immutable counterpart.

impl Debug for MLCAdamOptimizer

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

Formats the value using the given formatter.

impl Deref for MLCAdamOptimizer

type Target = MLCOptimizer

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for MLCAdamOptimizer

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 MLCAdamOptimizer

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCopying for MLCAdamOptimizer

fn copy(&self) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

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.

impl NSObjectProtocol for MLCAdamOptimizer

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 MLCAdamOptimizer

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 MLCAdamOptimizer

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

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

impl DowncastTarget for MLCAdamOptimizer

impl Eq for MLCAdamOptimizer