#[repr(C)]pub struct MLCTensorParameter { /* private fields */ }
MLCTensorParameter
only.Expand description
A tensor parameter object. This is used to describe input tensors that are updated by the optimizer during training.
See also Apple’s documentation
Implementations§
Source§impl MLCTensorParameter
impl MLCTensorParameter
Sourcepub unsafe fn tensor(&self) -> Retained<MLCTensor>
👎DeprecatedAvailable on crate feature MLCTensor
only.
pub unsafe fn tensor(&self) -> Retained<MLCTensor>
MLCTensor
only.The underlying tensor
Sourcepub unsafe fn isUpdatable(&self) -> bool
👎Deprecated
pub unsafe fn isUpdatable(&self) -> bool
Specifies whether this tensor parameter is updatable
Sourcepub unsafe fn setIsUpdatable(&self, is_updatable: bool)
👎Deprecated
pub unsafe fn setIsUpdatable(&self, is_updatable: bool)
Setter for isUpdatable
.
pub unsafe fn new() -> Retained<Self>
pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>
Sourcepub unsafe fn parameterWithTensor(tensor: &MLCTensor) -> Retained<Self>
👎DeprecatedAvailable on crate feature MLCTensor
only.
pub unsafe fn parameterWithTensor(tensor: &MLCTensor) -> Retained<Self>
MLCTensor
only.Create a tensor parameter
Parameter tensor
: The unedrlying tensor
Returns: A new tensor parameter object
Sourcepub unsafe fn parameterWithTensor_optimizerData(
tensor: &MLCTensor,
optimizer_data: Option<&NSArray<MLCTensorData>>,
) -> Retained<Self>
👎DeprecatedAvailable on crate features MLCTensor
and MLCTensorData
only.
pub unsafe fn parameterWithTensor_optimizerData( tensor: &MLCTensor, optimizer_data: Option<&NSArray<MLCTensorData>>, ) -> Retained<Self>
MLCTensor
and MLCTensorData
only.Create a tensor parameter
Parameter tensor
: The unedrlying tensor
Parameter optimizerData
: The optimizer data needed for this input tensor
Returns: A new tensor parameter object
Methods from Deref<Target = NSObject>§
Sourcepub fn doesNotRecognizeSelector(&self, sel: Sel) -> !
pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !
Handle messages the object doesn’t recognize.
See Apple’s documentation for details.
Methods from Deref<Target = AnyObject>§
Sourcepub fn class(&self) -> &'static AnyClass
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());
Sourcepub unsafe fn get_ivar<T>(&self, name: &str) -> &Twhere
T: Encode,
👎Deprecated: this is difficult to use correctly, use Ivar::load
instead.
pub unsafe fn get_ivar<T>(&self, name: &str) -> &Twhere
T: Encode,
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.
Sourcepub fn downcast_ref<T>(&self) -> Option<&T>where
T: DowncastTarget,
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 MLCTensorParameter
impl AsRef<AnyObject> for MLCTensorParameter
Source§impl AsRef<MLCTensorParameter> for MLCTensorParameter
impl AsRef<MLCTensorParameter> for MLCTensorParameter
Source§impl AsRef<NSObject> for MLCTensorParameter
impl AsRef<NSObject> for MLCTensorParameter
Source§impl Borrow<AnyObject> for MLCTensorParameter
impl Borrow<AnyObject> for MLCTensorParameter
Source§impl Borrow<NSObject> for MLCTensorParameter
impl Borrow<NSObject> for MLCTensorParameter
Source§impl ClassType for MLCTensorParameter
impl ClassType for MLCTensorParameter
Source§const NAME: &'static str = "MLCTensorParameter"
const NAME: &'static str = "MLCTensorParameter"
Source§type ThreadKind = <<MLCTensorParameter as ClassType>::Super as ClassType>::ThreadKind
type ThreadKind = <<MLCTensorParameter as ClassType>::Super as ClassType>::ThreadKind
Source§impl Debug for MLCTensorParameter
impl Debug for MLCTensorParameter
Source§impl Deref for MLCTensorParameter
impl Deref for MLCTensorParameter
Source§impl Hash for MLCTensorParameter
impl Hash for MLCTensorParameter
Source§impl Message for MLCTensorParameter
impl Message for MLCTensorParameter
Source§impl NSObjectProtocol for MLCTensorParameter
impl NSObjectProtocol for MLCTensorParameter
Source§fn isEqual(&self, other: Option<&AnyObject>) -> bool
fn isEqual(&self, other: Option<&AnyObject>) -> bool
Source§fn hash(&self) -> usize
fn hash(&self) -> usize
Source§fn isKindOfClass(&self, cls: &AnyClass) -> bool
fn isKindOfClass(&self, cls: &AnyClass) -> bool
Source§fn is_kind_of<T>(&self) -> bool
fn is_kind_of<T>(&self) -> bool
isKindOfClass
directly, or cast your objects with AnyObject::downcast_ref