#[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<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