com.mathworks.extern.java

Class MWArray

java.lang.Object

com.mathworks.extern.java.MWArray

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

MWCellArray, MWStructArray

public abstract class MWArray
extends java.lang.Object
implements java.io.Serializable

The MWArray class is the base class for native struct and cell MATLAB array types.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Object[]	flatArray

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MWArray()
protected	MWArray(int[] inDims)
protected	MWArray(int rows, int cols)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) This method returns true if the object matches the one passed in.
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.
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.
protected java.lang.String	getDimsStr()
protected int	getMaxValidIndex()
protected int	getOneBasedIndexForArray(int[] index)
int	hashCode() This method returns a hash of the object.
protected void	initNativeArray(int num)
boolean	isEmpty() This method returns true if the array object contains no elements, and false otherwise.
int	numberOfDimensions() Returns the number of dimensions of this array.
int	numberOfElements() Returns the total number of elements in this array.
void	set(int[] index, java.lang.Object val) Replaces the element at the specified 1-based index-array in this array with the specified element.
void	set(int index, java.lang.Object val) Replaces the element at the specified 1-based offset in this array with the specified element.
protected void	setMaxValidIndex(int idx)
abstract java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

flatArray

protected java.lang.Object[] flatArray

Constructor Detail

MWArray

protected MWArray()

MWArray

protected MWArray(int rows,
                  int cols)

MWArray

protected MWArray(int[] inDims)

Method Detail

toString

public abstract java.lang.String toString()

Overrides:

toString in class java.lang.Object

numberOfDimensions

public int numberOfDimensions()

Returns the number of dimensions of this array.

Returns:

number of dimensions

getDimensions

public int[] getDimensions()

Returns an array containing the size of each dimension of this array.

Returns:

array containing the size of each dimension

numberOfElements

public int numberOfElements()

Returns the total number of elements in this array.

Returns:

total number of elements

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.

set

public void set(int index,
                java.lang.Object val)

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.

val - New element to replace at index.

set

public void set(int[] index,
                java.lang.Object val)

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.

val - New element to replace at index.

getData

public java.lang.Object getData()

Returns a 1-D array containing a copy of the data in the underlying MATLAB array.

Returns:

1-D array containing a copy of the data

isEmpty

public boolean isEmpty()

This method returns true if the array object contains no elements, and false otherwise.

Returns:

true if the array object contains no elements, false otherwise

hashCode

public int hashCode()

This method returns a hash of the object.

Overrides:

hashCode in class java.lang.Object

Returns:

hash of the object

equals

public boolean equals(java.lang.Object obj)

This method returns true if the object matches the one passed in.

Overrides:

equals in class java.lang.Object

Returns:

true if the object matches the one passed in, false otherwise

getMaxValidIndex

protected int getMaxValidIndex()

setMaxValidIndex

protected void setMaxValidIndex(int idx)

initNativeArray

protected void initNativeArray(int num)

getOneBasedIndexForArray

protected int getOneBasedIndexForArray(int[] index)

getDimsStr

protected java.lang.String getDimsStr()