com.mathworks.toolbox.javabuilder.MWCellArray Class

Namespace: com.mathworks.toolbox.javabuilder

Java class to manage MATLAB cell arrays

Description

Declaration

public class MWCellArray extends MWArray

The MWCellArray class manages a native MATLAB cell array

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

Direct Known Subclasses: ,

Class Attributes: ,

Creation

Constructors

MWCellArray()

MWCellArray(int[] dims)

MWCellArray(int rows, int cols)

Properties

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

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>.
asList	public java.util.List<MWArray> asList() Provide a java.util.List interface to the cell array. Each item in the list is an MWArray or some subclass. List.set can take any object type, however. This operation is equivalent to MWCellArray.set. Returns: array as list
classID	public MWClassID classID() Returns the MATLAB type of this array. Example: Getting the Class ID of a Cell Array Create an MWCellArray object and display its class: int[] cdims = {2, 3}; MWCellArray C = new MWCellArray(cdims); System.out.println("Class of C is " + C.classID()); Class of C is cell
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. Example: Cloning a Cell Array Object Create an MWCellArray object and then a clone of that object: int[] cdims = {1, 3}; MWCellArray C = new MWCellArray(cdims); Object X = C.clone(); System.out.println("Clone of cell array C is:"); System.out.println(X.toString()); Clone of cell array C is: [] [] [] 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. Specified by: columnIndex in class MWArray 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 interface java.lang.Comparable 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. Specified by: equals in class MWArray Parameters: obj Object Array to compare with this MWArray object
exportCells	public java.util.List<java.lang.Object> exportCells() Export the cells to a java.util.List of Java native type array objects. List.get will convert the stored MWArray to a Java native array by calling MWArray.toArray. Otherwise the List returned by this method behaves the same as one returned by MWCellArray.asList. Returns: cells as list
get	public java.lang.Object get(int index) Returns the element at the specified 1-based offset in this array. The returned element is converted to a Java array using default conversion rules. Calling this method is equivalent to calling getCell(index).toArray(). Example: Getting Data from a Cell Array with get int[] cdims = {1, 3}; MWCellArray C = new MWCellArray(cdims); Integer val = new Integer(15); int[] index2 = {1, 3}; C.set(index2, val); Object x = C.get(index2); if (x instanceof int[][]) { int[][] y = (int[][])x; System.out.println("B: Cell data C(1,3) is " + y[0][0]); } B: Cell data C(1,3) is 15 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. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
get	public java.lang.Object get(int[] index) Returns the element at the specified 1-based index-array in this array. The returned element is converted to a Java array using default conversion rules. Calling this method is equivalent to calling getCell(index).toArray(). 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. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
getCell	public MWArray getCell(int index) Returns a shared copy of the element at the specified 1-based offset in this array as an MWArray instance. Parameters: index The index of the requested element. Valid range: 1 <= index <= N, where N = total number of elements in the array. Returns: An MWArray instance representing the requested cell. This MWArray reference should be disposed by calling MWArray.dispose(). Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
getCell	public MWArray getCell(int[] index) Returns a shared copy of the element at the specified 1-based index-array in this array as an MWArray instance. Example: 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: An MWArray instance representing the requested cell. This MWArray reference should be dsiposed by calling MWArray.dispose(). Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
getData	public java.lang.Object getData() Returns a 1-D array containing a copy of the data in the underlying MATLAB array. Example: Getting Cell Array Data with getData Use getData to read data from MWCellArray object C: int[] cdims = {1, 3}; MWCellArray C = new MWCellArray(cdims); Integer[] val = new Integer[3]; for (int i = 0; i < 3; i++) val[i] = new Integer(i * 15); for (int i = 1; i <= 3; i++) C.set(i, val[i-1]); System.out.println("Data read from cell array C: \n"); MWArray[] x = (MWArray[]) C.getData(); for (int i = 0; i < x.length; i++) System.out.println(x[i]); System.out.println(); Data read from cell array C: 0 0 0 Returns: A 1-D array of elements stored in column-wise order. Each element in the returned array is converted to a Java array by calling MWArray.toArray() on the corresponding cell.
getDimensions	public int[] getDimensions() Returns an array containing the size of each dimension of this array. Specified by: getDimensions in class MWArray Returns: array containing size of each dimension
hashCode	public int hashCode() Returns a hash code value for this array. Specified by: hashCode in class MWArray
isEmpty	public boolean isEmpty() Tests if this array has no elements. Specified by: isEmpty in class MWArray Returns: true if empty, false otherwise
isSparse	public boolean isSparse() Tests if this array is sparse. Specified by: isSparse in class MWArray 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(). Specified by: maximumNonZeros in class MWArray Returns: Currently allocated number of non-zero elements in a sparse array.
numberOfDimensions	public int numberOfDimensions() Returns the number of dimensions of this array. Specified by: numberOfDimensions in class MWArray Returns: Number of dimensions.
numberOfElements	public int numberOfElements() Returns the total number of elements in this array. Specified by: numberOfElements in class MWArray 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(). Specified by: numberOfNonZeros in class MWArray 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 An object stream exception.
rowIndex	public int[] rowIndex() Returns an array containing the row index of each element in the underlying MATLAB array. Specified by: columnIndex in class MWArray Returns: Array of indices.
serialize	public byte[] serialize() throws java.io.IOException Serialize the MATLAB array to a byte array. Returns: 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. Example: Setting Values in a Cell Array Set the value of the MWCellArray object C at index (1,3): int[] cdims = {1, 3}; MWCellArray C = new MWCellArray(cdims); Integer val = new Integer(15); int[] index = {1, 3}; C.set(index, val); Object x = C.get(index); System.out.println("Cell data C(1,3) is " + x.toString()); Cell data C(1,3) is 15 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. If element is of type MWArray, the cell at index is set to a shared copy of the underlying MATLAB array. Otherwise, a new MATLAB array is created from element using default conversion rules and assigned to the cell at index. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
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. If element is of type MWArray, the cell at index is set to a shared copy of the underlying MATLAB array. Otherwise, a new MATLAB array is created from element using default conversion rules and assigned to the cell at index. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
setData	public void setData(java.lang.Object data) Specified by: setData in class MWArray
sharedCopy	public java.lang.Object sharedCopy() Creates and returns a shared copy of this array. A shared copy points to the same underlying MATLAB array as the original. Changing the data in a shared copy also changes the original array. Example: Making a Shared Copy of a Cell Array Object Create an MWCellArray object and then a shared copy of that object: int[] cdims = {1, 3}; MWCellArray C = new MWCellArray(cdims); Object X = C.sharedCopy(); System.out.println("Shared copy of cell array C is:"); System.out.println(X.toString()); Shared copy of cell array C is: [] [] [] Returns: An MWCellArray 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. Example: Getting Cell Array Data with toArray int[] cdims = {1, 3}; MWCellArray C = new MWCellArray(cdims); System.out.println("Data read from cell array C \n"); Object x = (Object) C.toArray(); System.out.println(); for (int i = 0; i < x[0].length; i++) System.out.println(x[0][i]); Data read from cell array C [] [] [] Returns: An array with the same dimensionality of the MATLAB array. Each element in the returned array is converted to a Java array by calling MWArray.toArray() on the corresponding cell.
toString	public java.lang.String toString() Returns a string representation of this array. Specified by: toString in class MWArray
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.

Examples

Hello World

Version History

Introduced in R2006a