MWCellArray

java.lang.Object
- com.mathworks.toolbox.javabuilder.MWArray
- - com.mathworks.toolbox.javabuilder.MWCellArray

All Implemented Interfaces:

Disposable, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable
```
public class MWCellArray
extends MWArray
```
The MWCellArray class manages a native MATLAB cell array.

Since:

1.0

See Also:

Serialized Form

Field Summary
- Fields inherited from class com.mathworks.toolbox.javabuilder.MWArray
  EMPTY_ARRAY

Constructor Summary

Constructors
Constructor and Description
`MWCellArray()` Creates an empty cell array.
`MWCellArray(int[] dims)` Constructs a new cell array with the specified dimensions.
`MWCellArray(int rows, int cols)` Constructs a new cell matrix with the specified number of rows and columns.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T> T`	`applyVisitor(AbstractMWArrayVisitor<T> v)`
`java.util.List<MWArray>`	`asList()` Provide a java.util.List interface to the cell array.
`MWClassID`	`classID()` Returns the MATLAB type of this array.
`java.lang.Object`	`clone()` Creates and returns a deep copy of this array.
`int[]`	`columnIndex()` Returns an array containing the column index of each element in the underlying MATLAB array.
`int`	`compareTo(java.lang.Object obj)` Compares this array with the specified array for order.
`static MWArray`	`deserialize(byte[] data)` Create a new MWArray from serialized data.
`void`	`dispose()` Frees the native MATLAB array contained by this array.
`boolean`	`equals(java.lang.Object obj)` Indicates whether some other array is equal to this one.
`java.util.List<java.lang.Object>`	`exportCells()` Export the cells to a java.util.List of Java native type array objects.
`java.lang.Object`	`get(int index)` Returns the element at the specified 1-based offset in this array.
`java.lang.Object`	`get(int[] index)` Returns the element at the specified 1-based index-array in this array.
`MWArray`	`getCell(int index)` Returns a shared copy of the element at the specified 1-based offset in this array as an `MWArray` instance.
`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.
`java.lang.Object`	`getData()` Returns a 1-D array containing a copy of the data in the underlying MATLAB array.
`int[]`	`getDimensions()` Returns an array containing the size of each dimension of this array.
`int`	`hashCode()` Returns a hash code value for this array.
`boolean`	`isEmpty()` Tests if this array has no elements.
`boolean`	`isSparse()` Tests if this array is sparse.
`int`	`maximumNonZeros()` Returns the allocated capacity of a sparse array.
`int`	`numberOfDimensions()` Returns the number of dimensions of this array.
`int`	`numberOfElements()` Returns the total number of elements in this array.
`int`	`numberOfNonZeros()` Returns the number of non-zero elements in a sparse array.
`protected java.lang.Object`	`readResolve()` Called by serialization mechanism when loading a new array from a byte stream.
`int[]`	`rowIndex()` Returns an array containing the row index of each element in the underlying MATLAB array.
`byte[]`	`serialize()` Serialize the MATLAB array to a byte array.
`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.
`void`	`set(int index, java.lang.Object element)` Replaces the element at the specified 1-based offset in this array with the specified element.
`void`	`setData(java.lang.Object data)`
`java.lang.Object`	`sharedCopy()` Creates and returns a shared copy of this array.
`java.lang.Object[]`	`toArray()` Returns an array containing a copy of the data in the underlying MATLAB array.
`java.lang.String`	`toString()` Returns a string representation of this array.
`protected void`	`validate()` Validates the internal array handle.

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

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - MWCellArray
```
public MWCellArray()
```
    Creates an empty cell array.
    
    Example: Constructing an Empty Cell Array Object
    This example creates an empty MWCellArray object:
```
      MWCellArray C = new MWCellArray();
      System.out.println("C = " + C.toString());
 
```
    When run, the example displays this output:
```
      C = []
 
```
  - MWCellArray
```
public MWCellArray(int[] dims)
```
    Constructs a new cell array with the specified dimensions.
    Parameters:
    
    dims - Array of dimension sizes. Each dimension size must be non-negative.
    
    Throws:
    java.lang.NegativeArraySizeException - A negative dimension size is supplied.
    
    Example: Constructing an Initialized Cell Array Object
    This example constructs and initializes a 2-by-3 MWCellArray object:
    int[] cdims = {2, 3}; MWCellArray C = new MWCellArray(cdims); Integer[] val = new Integer[6]; for (int i = 0; i < 6; i++) val[i] = new Integer(i * 15); for (int i = 0; i < 2; i++) for (int j = 0; j < 3; j++) { int[] idx = {i+1, j+1}; C.set(idx, val[j + (i * 3)]); } System.out.println("C = " + C.toString());
    When run, the example displays this output:
    C = [ 0] [15] [30] [45] [60] [75]
  - MWCellArray
```
public MWCellArray(int rows,
                   int cols)
```
    Constructs a new cell matrix with the specified number of rows and columns.
    
    Parameters:
    
    rows - Number of rows. Number of rows must be non-negative.
    
    cols - Number of columns. Number of columns must be non-negative.
    
    Throws:
    
    java.lang.NegativeArraySizeException - A negative row or column size is supplied.
- Method Detail
  - 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:
    An MWCellArray instance representing a deep copy of the underlying MATLAB 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());
    When run, the example displays this output:
    Clone of cell array C is: [] [] []
    Throws:
    
    java.lang.CloneNotSupportedException - - The object's class does not implement the Cloneable interface.
  - 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.
    Returns:
    An MWCellArray instance representing a shared copy of the underlying MATLAB 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());
    When run, the example displays this output:
    Shared copy of cell array C is: [] [] []
  - classID
```
public MWClassID classID()
```
    Returns the MATLAB type of this array.
    Returns:
    returns MWClassID.CELL for MWCellArray.
    
    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());
    When run, the example displays this output:
    Class of C is cell
  - 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. 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.
    
    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());
    When run, the example displays this output:
    Cell data C(1,3) is 15
  - 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.
  - 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 equivelent to calling getCell(index).toArray().
    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.
    
    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]); }
    When run, the example displays this output:
    B: Cell data C(1,3) is 15
  - 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 equivelent 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 dsiposed 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.
    
    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.
    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.
    
    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();
    When run, the example displays this output:
    Data read from cell array C: 0 0 0
  - toArray
```
public java.lang.Object[] toArray()
```
    Returns an array containing a copy of the data in the underlying MATLAB array.
    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.
    
    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]);
    When run, the example displays this output:
    Data read from cell array C [] [] []
  - applyVisitor
```
public <T> T applyVisitor(AbstractMWArrayVisitor<T> v)
```
  - validate
```
protected void validate()
```
    Validates the internal array handle. Called by constructors and deserialization code.
  - 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
  - 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
  - serialize
```
public byte[] serialize()
                 throws java.io.IOException
```
    Serialize the MATLAB array to a byte array.
    
    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.
  - 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
  - numberOfDimensions
```
public int numberOfDimensions()
```
    Returns the number of dimensions of this array.
    
    Specified by:
    
    numberOfDimensions in class MWArray
    
    Returns:
    
    number of dimensions
  - 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
  - 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 sparse, false otherwise
  - 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
  - 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
  - hashCode
```
public int hashCode()
```
    Returns a hash code value for this array.
    
    Specified by:
    
    hashCode in class MWArray
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this array.
    
    Specified by:
    
    toString in class MWArray
  - 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.
  - 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.
  - 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
  - setData
```
public void setData(java.lang.Object data)
```
    Specified by:
    
    setData in class MWArray
  - rowIndex
```
public int[] rowIndex()
```
    Returns an array containing the row index of each element in the underlying MATLAB array.
    
    Specified by:
    
    rowIndex in class MWArray
    
    Returns:
    
    Array of indices.
  - 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.
  - 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

Class MWCellArray

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

MWCellArray

MWCellArray

MWCellArray

Method Detail

clone

sharedCopy

classID

set

set

get

get

getCell

getCell

getData

toArray

applyVisitor

validate

asList

exportCells

serialize

deserialize

numberOfDimensions

getDimensions

isEmpty

isSparse

equals

compareTo

hashCode

toString

numberOfElements

numberOfNonZeros

maximumNonZeros

dispose

setData

rowIndex

columnIndex

readResolve