Skip to main content

TensorDescriptor

Struct TensorDescriptor 

Source
pub struct TensorDescriptor(/* private fields */);
Expand description

Descriptor for creating a tensor.

C++ equivalent: MTL::TensorDescriptor

Implementations§

Source§

impl TensorDescriptor

Source

pub fn new() -> Option<Self>

Create a new tensor descriptor.

C++ equivalent: TensorDescriptor* alloc()->init()

Source

pub unsafe fn from_raw(ptr: *mut c_void) -> Option<Self>

Create from a raw pointer.

§Safety

The pointer must be a valid Metal TensorDescriptor.

Source

pub fn as_raw(&self) -> *mut c_void

Get the raw pointer.

Source

pub fn data_type(&self) -> TensorDataType

Get the data type.

C++ equivalent: TensorDataType dataType() const

Source

pub fn set_data_type(&self, data_type: TensorDataType)

Set the data type.

C++ equivalent: void setDataType(MTL::TensorDataType)

Source

pub fn dimensions(&self) -> Option<TensorExtents>

Get the dimensions.

C++ equivalent: TensorExtents* dimensions() const

Source

pub fn set_dimensions(&self, dimensions: &TensorExtents)

Set the dimensions.

C++ equivalent: void setDimensions(const MTL::TensorExtents*)

Source

pub fn strides(&self) -> Option<TensorExtents>

Get the strides.

C++ equivalent: TensorExtents* strides() const

Source

pub fn set_strides(&self, strides: &TensorExtents)

Set the strides.

C++ equivalent: void setStrides(const MTL::TensorExtents*)

Source

pub fn storage_mode(&self) -> StorageMode

Get the storage mode.

C++ equivalent: StorageMode storageMode() const

Source

pub fn set_storage_mode(&self, storage_mode: StorageMode)

Set the storage mode.

C++ equivalent: void setStorageMode(MTL::StorageMode)

Source

pub fn cpu_cache_mode(&self) -> CPUCacheMode

Get the CPU cache mode.

C++ equivalent: CPUCacheMode cpuCacheMode() const

Source

pub fn set_cpu_cache_mode(&self, cpu_cache_mode: CPUCacheMode)

Set the CPU cache mode.

C++ equivalent: void setCpuCacheMode(MTL::CPUCacheMode)

Source

pub fn hazard_tracking_mode(&self) -> HazardTrackingMode

Get the hazard tracking mode.

C++ equivalent: HazardTrackingMode hazardTrackingMode() const

Source

pub fn set_hazard_tracking_mode(&self, hazard_tracking_mode: HazardTrackingMode)

Set the hazard tracking mode.

C++ equivalent: void setHazardTrackingMode(MTL::HazardTrackingMode)

Source

pub fn resource_options(&self) -> ResourceOptions

Get the resource options.

C++ equivalent: ResourceOptions resourceOptions() const

Source

pub fn set_resource_options(&self, resource_options: ResourceOptions)

Set the resource options.

C++ equivalent: void setResourceOptions(MTL::ResourceOptions)

Source

pub fn usage(&self) -> TensorUsage

Get the usage.

C++ equivalent: TensorUsage usage() const

Source

pub fn set_usage(&self, usage: TensorUsage)

Set the usage.

C++ equivalent: void setUsage(MTL::TensorUsage)

Trait Implementations§

Source§

impl Clone for TensorDescriptor

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Default for TensorDescriptor

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Drop for TensorDescriptor

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl Referencing for TensorDescriptor

Source§

fn as_ptr(&self) -> *const c_void

Get the raw pointer to the Objective-C object.
Source§

fn as_mut_ptr(&self) -> *mut c_void

Get the raw mutable pointer to the Objective-C object.
Source§

fn retain(&self) -> Self
where Self: Clone,

Retain the object, incrementing its reference count. Read more
Source§

fn release(&self)

Release the object, decrementing its reference count. Read more
Source§

fn autorelease(&self) -> Self
where Self: Clone,

Autorelease the object. Read more
Source§

fn retain_count(&self) -> usize

Get the retain count of the object. Read more
Source§

impl Send for TensorDescriptor

Source§

impl Sync for TensorDescriptor

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<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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.