Struct InterleavedComplexArray 

pub struct InterleavedComplexArray<T, P> { /* private fields */ }

Implementations

impl<T: MatlabNumber> InterleavedComplexArray<T, MxArray>

pub fn new( data: Box<[Complex<T>]>, shape: &[usize], ) -> ToMatlabResult<Self, Box<[Complex<T>]>>

Methods from Deref<Target = mxArray>

pub fn duplicate(&self) -> MxArray

Create a deep copy of the array, and return as an owned type. However, consider using MatlabClass::duplicate instead if you are already working with MatlabClasses.

pub fn dimensions(&self) -> &[usize]

Return the sizes of the constituent dimensions of the mxArray

pub fn numel(&self) -> usize

Return the number of elements contained in this array.

pub fn raw_class_id(&self) -> u32

Return the raw class ID; the number Matlab returns.

pub fn class_id(&self) -> Result<ClassID, u32>

Return Ok(ClassID) for mxArrays which map to a built-in class (such as numeric arrays, structure arrays, and cell arrays (see ClassID); otherwise it returns the raw class ID in the Err variant. These other values of the raw class ID are used in modern versions of Matlab for custom classes, defined via e..g classdef.

pub fn is_complex(&self) -> bool

Check whether the backing array is complex. Since the only arrays which can be complex are numeric arrays, this also implies that.

pub fn is_sparse(&self) -> bool

Check whether the backing array is a sparse matrix

pub fn is_struct(&self) -> bool

Check whether the backing array is a struct array

pub fn is_empty(&self) -> bool

Check whether the backing array is empty

pub fn is_scalar(&self) -> bool

Check whether the backing array only holds one element

pub fn complexity(&self) -> Complexity

Trait Implementations

impl<T: Clone, P: Clone> Clone for InterleavedComplexArray<T, P>

fn clone(&self) -> InterleavedComplexArray<T, P>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'p, T, P> ComplexNumericArray<'p> for InterleavedComplexArray<T, P>

where T: MatlabNumber + 'p, P: MatlabPtr + 'p,

type CDT = T

fn complex_data( &self, ) -> ComplexData<&'p [Complex<Self::CDT>], Complex<&'p [Self::CDT]>>

impl<T: Debug, P: Debug> Debug for InterleavedComplexArray<T, P>

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

Formats the value using the given formatter.

impl<T, P> Deref for InterleavedComplexArray<T, P>

where P: MatlabPtr,

type Target = mxArray_tag

The resulting type after dereferencing.

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

Dereferences the value.

impl<T, P> DerefMut for InterleavedComplexArray<T, P>

where P: MutMatlabPtr,

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'a, 'b, T, P> From<&InterleavedComplexArray<T, P>> for ArrayViewD<'a, Complex<T>>

where T: MatlabNumber, P: MatlabPtr + 'a, 'b: 'a,

fn from(num: &InterleavedComplexArray<T, P>) -> Self

Converts to this type from the input type.

impl<'a, 'b, T, P> From<&'b mut InterleavedComplexArray<T, P>> for ArrayViewMutD<'a, Complex<T>>

where T: MatlabNumber, P: MutMatlabPtr + 'a, 'b: 'a,

fn from(num: &mut InterleavedComplexArray<T, P>) -> Self

Converts to this type from the input type.

impl<T> From<[Complex<T>; 0]> for InterleavedComplexArray<T, MxArray>

where T: MatlabNumber,

fn from(_empty: [Complex<T>; 0]) -> Self

Converts to this type from the input type.

impl<'a, T, D> From<ArrayBase<OwnedRepr<Complex<T>>, D>> for InterleavedComplexArray<T, MxArray>

where T: MatlabNumber, D: Dimension,

fn from(arr: Array<Complex<T>, D>) -> Self

Converts to this type from the input type.

impl<T> From<Complex<T>> for InterleavedComplexArray<T, MxArray>

where T: MatlabNumber,

fn from(cn: Complex<T>) -> Self

Converts to this type from the input type.

impl<'a, T> From<InterleavedComplexArray<T, &'a mut mxArray_tag>> for ArrayViewMutD<'a, Complex<T>>

where T: MatlabNumber,

fn from(num: InterleavedComplexArray<T, &'a mut mxArray>) -> Self

Converts to this type from the input type.

impl<'a, T> From<InterleavedComplexArray<T, &'a mxArray_tag>> for ArrayViewD<'a, Complex<T>>

where T: MatlabNumber,

fn from(num: InterleavedComplexArray<T, &'a mxArray>) -> Self

Converts to this type from the input type.

impl<T> FromVec<Complex<T>> for InterleavedComplexArray<T, MxArray>

where T: MatlabNumber,

fn from_boxed_slice<L: VecLayout>(b: Box<[Complex<T>]>, l: L) -> Self

Convert a boxed slice into some matlab type.

fn from_vec<L>(v: Vec<T>, l: L) -> Self

where L: VecLayout, Self: Sized,

Convert an owned Vec<T> to some Matlab class.

fn from_slice<S, L>(s: S, l: L) -> Self

where S: Into<Box<[T]>>, L: VecLayout, Self: Sized,

impl<T, P> MatlabClass<P> for InterleavedComplexArray<T, P>

where T: MatlabNumber, P: MatlabPtr,

type Owned = InterleavedComplexArray<T, MxArray>

The owned variant of this matlab class.

fn from_mx_array(mx: P) -> Result<Self, FromMatlabError<P>>

Try to build a matlab class from a MatlabPtr. If the type requirements of the class match what the pointer is, then the class is constructed. Otherwise, an error is returned; containing the reason of the failure and the original pointer. The latter is especially useful with MxArrays; the owned MatlabPtr type — otherwise it would be dropped.

fn into_inner(self) -> P

Deconstruct the MatlabClass back to a bare MatlabPtr.

fn inner(&self) -> &P

Get a reference to the inner MatlabPtr. However, note that for &mxArray and &mut mxArray, the returned references will be of type &&mxArray and &&mut mxArray.

fn duplicate(&self) -> Self::Owned

Make a deep clone of the inner MatlabPtr, and construct an Owned MatlabClass from it.

impl<T, P> MutMatlabClass<P> for InterleavedComplexArray<T, P>

where T: MatlabNumber, P: MutMatlabPtr,

type AsBorrowed<'a> = InterleavedComplexArray<T, &'a mxArray_tag> where P: 'a, T: 'a

fn as_borrowed<'a>(&'a self) -> Self::AsBorrowed<'a>

fn inner_mut(&mut self) -> &mut P

impl<'p, T, P> MutNumericArray<'p> for InterleavedComplexArray<T, P>

where T: MatlabNumber + 'p, P: MutMatlabPtr + 'p,

type MutData = &'p mut [Complex<T>]

fn mut_data(&mut self) -> Self::MutData

impl<T> NewEmpty for InterleavedComplexArray<T, MxArray>

where T: MatlabNumber,

fn new_empty() -> Self

Construct the empty type

impl<'p, T, P> NumericArray<'p> for InterleavedComplexArray<T, P>

where T: MatlabNumber + 'p, P: MatlabPtr + 'p,

type Data = &'p [Complex<T>]

fn data(&self) -> Self::Data

impl<T> OwnedMatlabClass for InterleavedComplexArray<T, MxArray>

where T: MatlabNumber,

type AsMutable<'a> = InterleavedComplexArray<T, &'a mut mxArray_tag> where Self: 'a

The way this class would be represented if it were a mutable borrow.

fn as_mutable<'a>(&'a mut self) -> Self::AsMutable<'a>

Create a MutMatlabClass from this owned instance.

impl<T: PartialEq, P: PartialEq> PartialEq for InterleavedComplexArray<T, P>

fn eq(&self, other: &InterleavedComplexArray<T, P>) -> 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<T, P> TakeData<P> for InterleavedComplexArray<T, P>

where T: MatlabNumber, P: MutMatlabPtr,

type OwnedData = Box<[Complex<T>]>

The type of data that this array wraps.

fn take_data(&mut self) -> Self::OwnedData

Take the data out of the array, leaving it in an empty state.

impl<T: Copy, P: Copy> Copy for InterleavedComplexArray<T, P>

impl<T: Eq, P: Eq> Eq for InterleavedComplexArray<T, P>

impl<T, P> StructuralPartialEq for InterleavedComplexArray<T, P>