com.mathworks.toolbox.javabuilder.MWMatrixRef Class

Namespace: com.mathworks.toolbox.javabuilder

Java class to represent matrix references in MATLAB

Description

Declaration

public class MWMatrixRef extends MWArray

The MWMatrixRef class represents a MATLAB Matrix Reference.

Implemented Interfaces: Disposable, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable

Direct Known Subclasses: MWFunctionHandle

Properties

expand all

Public Properties

`EMPTY_ARRAY` — Represent an empty array
`public static final MWArray`

A convenient, efficient, and consistent way to represent an empty array as follows:

public static final MWArray EMPTY_ARRAY

Methods

expand all

Public Methods

`applyVisitor`	`public abstract <T> T applyVisitor(AbstractMWArrayVisitor<T> v)` This method is abstract and returns a type specified by the type parameter <T>. It takes an instance of `AbstractMWArrayVisitor<T>` as an argument. The purpose of this method is to apply the visitor pattern to an MWArray object. By calling this method with an appropriate visitor, you can traverse and perform operations on elements of the MWArray in a type-safe manner. Parameters: v An instance of `AbstractMWArrayVisitor<T>` representing the visitor to be applied to the MWArray object. Returns: T The result of applying the visitor to the MWArray object, with the specific type specified by <T>.
`classID`	`public abstract MWClassID classID()` Returns the MATLAB type of this array. Returns: MWClassID of this array.
`clone`	`public java.lang.Object clone() throws java.lang.CloneNotSupportedException` Creates and returns a deep copy of this array. Changing the data in a deep copy does not change the original array. Returns: A MWMatrixRef instance representing a deep copy of the underlying MATLAB array. Throws: java.lang.CloneNotSupportedException The object's class does not implement the Cloneable interface.
`columnIndex`	`public int[] columnIndex()` Returns an array containing the column index of each element in the underlying MATLAB array. Returns: Array of indices.
`compareTo`	`public int compareTo(java.lang.Object obj)` Compares this array with the specified array for order. Specified by: `compareTo` in class `MWArray`. Parameters: obj Object Array to compare with this MWArray object
`deserialize`	`public static MWArray deserialize(byte[] data)` Create a new MWArray from serialized data. Parameters: data Serialized array returned from `MWArray.serialize` Returns: The deserialized MWArray.
`dispose`	`public void dispose()` Frees the native MATLAB array contained by this array. Specified by: `dispose` in interface `Disposable`. Specified by: `dispose` in class `MWArray`.
`equals`	`public boolean equals(java.lang.Object obj)` Indicates whether some other array is equal to this one. Parameters: obj Object Array to compare with this MWArray object.
`get`	`public java.lang.Object get(int index)` Returns the element at the specified 1-based offset in this array. Parameters: index The index of the requested element. Valid range: 1 <= index <= N, where N = total number of elements in the array. Returns: Object containing the requested element.
`get`	`public java.lang.Object get(int[] index)` Returns the element at the specified 1-based index-array in this array. Parameters: index Array of indices specifying the location of the requested element. The length of the index array must be exactly the number of dimensions of this array. Each element of the index array has the valid range: 1 <= index[i] <= N[i], where N[i] = the size of the ith dimension. Returns: Object containing the requested element.
`getData`	`public java.lang.Object getData()` Returns a 1-D array containing a copy of the data in the underlying MATLAB array. The elements of the returned array are converted according to default conversion rules. If the underlying MATLAB array is a complex numeric type, `getData` returns the real part. If the underlying array is a cell or struct array, `toArray` is recursively called on each cell. Returns: A 1-D array of elements stored in column-wise order. The length of the returned array equals `numberOfElements()` for a non-sparse array, and `numberOfNonZeros()` for a sparse array.
`getDimensions`	`public int[] getDimensions()` Returns an array containing the size of each dimension of this array. Returns: Array containing size of each dimension.
`hashCode`	`public int hashCode()` Returns a hash code value for this array.
`isEmpty`	`public boolean isEmpty()` Tests if this array has no elements. Returns: `true` if empty, `false` otherwise
`isSparse`	`public boolean isSparse()` Tests if this array is sparse. Returns: `true` if empty, `false` otherwise
`maximumNonZeros`	`public int maximumNonZeros()` Returns the allocated capacity of a sparse array. If the underlying array is non-sparse, this method returns the same value as `numberOfElements()`. Returns: Currently allocated number of non-zero elements in a sparse array.
`numberOfDimensions`	`public int numberOfDimensions()` Returns the number of dimensions of this array. Returns: Number of dimensions.
`numberOfElements`	`public int numberOfElements()` Returns the total number of elements in this array. Returns: Number of elements.
`numberOfNonZeros`	`public int numberOfNonZeros()` Returns the number of non-zero elements in a sparse array. If the underlying array is non-sparse, this method returns the same value as `numberOfElements()`. Returns: Current number of non-zero elements in a sparse array.
`readResolve`	`protected java.lang.Object readResolve() throws java.io.ObjectStreamException` Called by serialization mechanism when loading a new array from a byte stream. This method validates the correct array type. Returns: Returns this Object indicating validated array type. Throws: java.io.InvalidObjectException Attempt to load an invalid array handle. java.io.ObjectStreamException Object stream exception.
`rowIndex`	`public int[] rowIndex()` Returns an array containing the row index of each element in the underlying MATLAB array. Returns: Array of indices.
`serialize`	`public byte[] serialize() throws java.io.IOException` Serialize the MATLAB array to a byte array. Parameters: index Returns: The serialized MATLAB array data. Throws: java.io.IOException If the array cannot be serialized. For example, executable content (function handles, class instances) cannot be serialized.
`set`	`public void set(int index, java.lang.Object element)` Replaces the element at the specified 1-based offset in this array with the specified element. Parameters: index The index of the element to replace. Valid range: 1 <= index <= N, where N = total number of elements in the array. element New element to replace at index.
`set`	`public void set(int[] index, java.lang.Object element)` Replaces the element at the specified 1-based index-array in this array with the specified element. Parameters: index Array of indices specifying the location of the element to replace. The length of the index array must be exactly the number of dimensions of this array. Each element of the index array has the valid range: 1 <= index[i] <= N[i], where N[i] = the size of the ith dimension. element New element to replace at index.
`setData`	`public void setData(java.lang.Object data)`
`sharedCopy`	`public java.lang.Object sharedCopy()` Creates and returns a shared copy of this array. Returns: A MWMatrixRef instance representing a shared copy of the underlying MATLAB array.
`toArray`	`public java.lang.Object[] toArray()` Returns an array containing a copy of the data in the underlying MATLAB array. The returned array has the same dimensionality as the underlying MATLAB array. The elements of the returned array are converted according to default conversion rules. If the underlying MATLAB array is a complex numeric type, `toArray>` returns the real part. If the underlying array is sparse, a full representation of the array is returned. Care should be taken when calling `toArray` on a sparse array with large row and column dimensions, as this action may exhaust system memory. If the underlying array is a cell or struct array, `toArray` is recursively called on each cell. Returns: An array with the same dimensionality of the MATLAB array.
`toString`	`public java.lang.String toString()` Returns a string representation of this array.
`validate`	`protected void validate()` Validates the internal array handle. Called by constructors and deserialization code.

Inherited Methods

Methods inherited from class com.mathworks.toolbox.javabuilder.MWArray.

disposeArray

public static void disposeArray(java.lang.Object obj)

This method destroys any native MATLAB arrays contained in the input object and frees the memory occupied by them. This is a static method of the class and thus does not need to be invoked in reference to an instance of the class. If the input object implements the Disposable interface, the object is freed by calling its Disposable.dispose() method. If the input object represents an array of Disposable instances, each object in the array is disposed. If the input object represents an array of java.lang.Object, or a multi-dimensional array, the array is recursively processed to free each Disposable instance contained in the array.

Example: Constructing an MWNumericArray Object

MWArray[] MArr = new MWArray[10];
for (int i = 0; i < 10; i++)
    MArr[i] = new MWNumericArray();
MWArray.disposeArray(MArr);

Parameters:

obj: Object to process.

Methods inherited from class java.lang.Object.

`finalize`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`getClass`	`public final Class<?> getClass()` Returns the runtime class of this Object.
`notify`	`public final void notify()`
`notifyAll`	`public final void notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`wait`	`public final void wait(long timeout, int nanos) throws InterruptedException` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.

Version History

Introduced in R2006a