com.mathworks.toolbox.javabuilder.MWNumericArray Class

Namespace: com.mathworks.toolbox.javabuilder

Java class to manage numeric arrays in MATLAB

Description

Declaration

public class MWNumericArray extends MWArray

The MWNumericArray class manages a native MATLAB^® numeric array. It serves as the base class for all numeric MATLAB array types and serves as a data container for passing numeric information between Java^® and MATLAB code.

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

Creation

Constructors

MWNumericArray()

Creates an empty MWNumericArray of type MWClassID.DOUBLE.

MWNumericArray(boolean rVal, boolean iVal, MWClassID classid)

Constructs a complex numeric double array that represents the primitive boolean arguments.

MWNumericArray(boolean rVal, MWClassID classid)

Constructs a real scalar numeric array that represents the primitive boolean argument.

MWNumericArray(byte rVal)

Constructs a real scalar numeric array of type MWClassID.INT8 that represents the primitive byte argument.

MWNumericArray(byte rVal, byte iVal)

Constructs a complex scalar numeric array of type MWClassID.INT8 that represents the primitive byte arguments.

MWNumericArray(byte rVal, byte iVal, MWClassID classid)

Constructs a complex scalar numeric array that represents the primitive byte arguments.

MWNumericArray(byte rVal, MWClassID classid)

Constructs a real scalar numeric array that represents the primitive byte argument.

MWNumericArray(double rVal)

Constructs a real scalar array of type MWClassID.DOUBLE that represents the primitive double argument.

MWNumericArray(double rVal, double iVal)

Constructs a complex scalar array of type MWClassID.DOUBLE that represents the primitive double arguments.

MWNumericArray(double rVal, double iVal, MWClassID classid)

Constructs a complex scalar array that represents the primitive double arguments.

MWNumericArray(double rVal, MWClassID classid)

Constructs a real scalar array that represents the primitive double argument.

MWNumericArray(float rVal)

Constructs a real scalar numeric array of type MWClassID.SINGLE that represents the primitive float argument.

MWNumericArray(float rVal, float iVal)

Constructs a complex scalar numeric array of type MWClassID.SINGLE that represents the primitive float arguments.

MWNumericArray(float rVal, float iVal, MWClassID classid)

Constructs a complex scalar numeric array that represents the primitive float arguments.

MWNumericArray(float rVal, MWClassID classid)

Constructs a real scalar numeric array that represents the primitive float argument.

MWNumericArray(int rVal)

Constructs a real scalar numeric array of type MWClassID.INT32 that represents the primitive int argument.

MWNumericArray(int rVal, int iVal)

Constructs a complex scalar numeric array of type MWClassID.INT32 that represents the primitive int arguments.

MWNumericArray(int rVal, int iVal, MWClassID classid)

Constructs a complex scalar numeric array that represents the primitive int arguments.

MWNumericArray(int rVal, MWClassID classid)

Constructs a real scalar numeric array that represents the primitive int argument.

MWNumericArray(long rVal)

Constructs a real scalar numeric array of type MWClassID.INT64 that represents the primitive long argument.

MWNumericArray(long rVal, long iVal)

Constructs a complex numeric double array of type MWClassID.INT64 that represents the primitive long arguments.

MWNumericArray(long rVal, long iVal, MWClassID classid)

Constructs a complex numeric double array that represents the primitive long arguments.

MWNumericArray(MWClassID classid)

Creates an empty MWNumericArray of the specified type.

MWNumericArray(java.lang.Object rVal)

Constructs a real numeric array that represents the Object argument using default conversion rules.

MWNumericArray(java.lang.Object rVal, MWClassID classid)

Constructs a real numeric array that represents the Object argument.

MWNumericArray(java.lang.Object rVal, java.lang.Object iVal)

Constructs a complex numeric array that represents the Object arguments using default conversion rules.

MWNumericArray(java.lang.Object rVal, java.lang.Object iVal, MWClassID classid)

Constructs a complex numeric array that represents the Object arguments.

MWNumericArray(short rVal)

Constructs a real scalar numeric array of type MWClassID.INT16 that represents the primitive short argument.

MWNumericArray(short rVal, MWClassID classid)

Constructs a real scalar numeric array that represents the primitive short argument.

MWNumericArray(short rVal, short iVal)

Constructs a complex scalar numeric array of type MWClassID.INT16 that represents the primitive short arguments.

MWNumericArray(short rVal, short iVal, MWClassID classid)

Constructs a complex scalar numeric array that represents the primitive short arguments.

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>.
classID	public MWClassID classID() Returns the MATLAB type of this array. Specified by: classID in class MWArray 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. Example: Cloning a Numeric Array Object Create a 3-by-6 array of type double: double[][] AData = {{ 1, 2, 3, 4, 5, 6}, { 7, 8 , 9, 10, 11, 12}, {13, 14, 15, 16, 17, 18}}; MWNumericArray A = new MWNumericArray(AData, MWClassID.DOUBLE); Create a clone of the MWNumericArray object A: Object C = A.clone(); System.out.println("Clone of matrix A is:"); System.out.println(C.toString()); When run, the example displays this output: Clone of matrix A is: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 Clone of matrix A is: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 Returns: An MWNumericArray 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. 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
complexity	public MWComplexity complexity() Returns the complexity of this array. Example: Testing for a Complex Array Create matrix A: double AReal = 24; double AImag = 5; MWNumericArray A = new MWNumericArray(AReal, AImag); Determine whether matrix A is real or complex: System.out.println("A is a " + A.complexity() + " matrix"); When run, the example displays this output: A is a complex matrix Returns:MWComplexity.REAL for a real array. Returns MWComplexity.COMPLEX for a complex array.
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
get	public java.lang.Object get(int index) Returns the element at the specified 1-based offset in this array. Specified by: get in class MWArray 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) Return this array as a scalar byte. Specified by: get in class MWArray 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.
getByte	public byte getByte() Return this array as a scalar byte. Returns: Scalar value.
getByte	public byte getByte(int index) Returns the real part at the specified 1-based offset as a byte value. Example: Getting a Short Value from a Numeric Array The following examples use this array: short[][] Adata = {{ 1, 2, 3, 4, 5, 6}, { 7, 8 , 9, 10, 11, 12}, {13, 14, 15, 16, 17, 18}}; MWNumericArray A = new MWNumericArray(Adata, MWClassID.INT16); int[] index = {2, 4}; System.out.println("A(2,4) = " + A.getShort(index)); A(2,4) = 10 Example: Using get and set on a Numeric Array Given the same MWNumericArray used in the previous example, get and then modify the value of element (2, 3): int[] idx = {2, 3}; System.out.println("A(2, 3) is " + A.get(idx).toString()); System.out.println(""); System.out.println("Setting A(2, 3) to a new value ..."); A.set(idx, 555); System.out.println(""); System.out.println("A(2, 3) is now " + A.get(idx).toString()); A(2, 3) is 9.0 Setting A(2, 3) to a new value ... A(2, 3) is now 555.0 Parameters: index The index of the requested element. Valid range: 1 <= index <= N, where N = total number of elements in the array. Returns: Value of the requested element. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
getByte	public byte getByte(int[] index) Returns the real part at the specified 1-based index-array as a byte value. 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 i of the index array has the valid range: 1 <= index[i] <= N[i], where N[i] = the size of the ith dimension. Returns: Value of the requested element. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
getByteData	public byte[] getByteData() This method returns a one-dimensional array of Java types matching the primitive type byte. For example, if you call getByteData, an array of type byte is returned regardless of the data type in the underlying array. The data is converted from another primitive type, if necessary. If conversion is performed, truncation or other loss of precision may occur. Returns: One-dimensional array of elements of the Java primitive type byte
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. Specified by: getData in class MATLAB Parameters: 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. Specified by: getDimensions in class MWArray Returns: Array containing size of each dimension
getDouble	public double getDouble() Return this array as a scalar double. Returns: Scalar value.
getDouble	public double getDouble(int index) Returns the real part at the specified 1-based offset as a double value. Parameters: index The index of the requested element. Valid range: 1 <= index <= N, where N = total number of elements in the array. Returns: Value of the requested element. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
getDouble	public double getDouble(int[] index) Returns the real part at the specified 1-based index-array as a double value. 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 i of the index array has the valid range: 1 <= index[i] <= N[i], where N[i] = the size of the ith dimension. Returns: Value of the requested element. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
getDoubleData	public double[] getDoubleData() This method returns a one-dimensional array of Java types matching the primitive type double. For example, if you call getDoubleData, an array of type double is returned regardless of the data type in the underlying array. The data is converted from another primitive type, if necessary. If conversion is performed, truncation or other loss of precision may occur. Returns: One-dimensional array of elements of the Java primitive type double
getEps	public static double getEps() Returns MATLAB's concept of eps. Returns: eps as a double
getFloat	public float getFloat() Return this array as a scalar float. Returns: Scalar value
getFloat	public float getFloat(int index) Returns the real part at the specified 1-based offset as a float value. Parameters: index The index of the requested element. Valid range: 1 <= index <= N, where N = total number of elements in the array. Returns: Value of the requested element. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
getFloat	public float getFloat(int[] index) Returns the real part at the specified 1-based index-array as a float value. 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 i of the index array has the valid range: 1 <= index[i] <= N[i], where N[i] = the size of the ith dimension. Returns: Value of the requested element. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
getFloatData	public float[] getFloatData() This method returns a one-dimensional array of Java types matching the primitive type float. For example, if you call getFloatData, an array of type float is returned regardless of the data type in the underlying array. The data is converted from another primitive type, if necessary. If conversion is performed, truncation or other loss of precision may occur. Returns: One-dimensional array of elements of the Java primitive type float
getImag	public java.lang.Object getImag(int index) Returns the imaginary part at the specified 1-based offset in this array. Example: Getting the Real and Imaginary Parts of an Array Start by creating a two-dimensional array of complex values: double[][] Rdata = {{ 2, 3, 4}, { 8 , 9, 10}, {14, 15, 16}}; double[][] Idata = {{ 6, 5, 14}, { 7 , 1, 23}, { 1, 1, 9}}; MWNumericArray A = new MWNumericArray(Rdata, Idata, MWClassID.DOUBLE); System.out.println("Complex matrix A ="); System.out.println(A.toString()); 2.0000 + 6.0000i 3.0000 + 5.0000i 4.0000 + 14.0000i 8.0000 + 7.0000i 9.0000 + 1.0000i 10.0000 + 23.0000i 14.0000 + 1.0000i 15.0000 + 1.0000i 16.0000 + 9.0000i Now, use get and getImag to read the real and imaginary parts of the element at index (2, 3): int[] index = {2, 3}; System.out.println("The real part of A(2,3) = " + A.get(index)); System.out.println("The imaginary part of A(2,3) = " + A.getImag(index)); The real part of A(2,3) = 10.0 The imaginary part of A(2,3) = 23.0 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.
getImag	public java.lang.Object getImag(int[] index) Returns the imaginary part 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 i 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.
getImagByte	public byte getImagByte() Return imaginary component of this array as a scalar byte. Returns: Scalar value
getImagByte	public byte getImagByte(int index) Returns the imaginary part at the specified 1-based offset as a byte value. Example: Parameters: index The index of the requested element. Valid range: 1 <= index <= N, where N = total number of elements in the array. Returns: Value of the requested element. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
getImagByte	public byte getImagByte(int[] index) Returns the imaginary part at the specified 1-based index-array as a byte value. 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 i of the index array has the valid range: 1 <= index[i] <= N[i], where N[i] = the size of the ith dimension. Returns: Value of the requested element. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
getImagByteData	public byte[] getImagByteData() This method returns a one-dimensional array of imaginary elements of the Java primitive type byte. For example, if you call getImagByteData, an array of type byte is returned regardless of the data type in the underlying array. The data is converted from another primitive type, if necessary. If conversion is performed, truncation or other loss of precision may occur. Returns: One-dimensional array of imaginary elements of the Java primitive type byte.
getImagData	public java.lang.Object getImagData() Returns a 1-D array containing a copy of the imaginary data in the underlying MATLAB array. Example: Getting Data from a Complex Array Start by creating a two-dimensional array of complex values: double[][] Rdata = {{ 2, 3, 4}, { 8 , 9, 10}, {14, 15, 16}}; double[][] Idata = {{ 6, 5, 14}, { 7 , 1, 23}, { 1, 1, 9}}; MWNumericArray A = new MWNumericArray(Rdata, Idata, MWClassID.DOUBLE); System.out.println("Complex matrix A ="); System.out.println(A.toString()); 2.0000 + 6.0000i 3.0000 + 5.0000i 4.0000 + 14.0000i 8.0000 + 7.0000i 9.0000 + 1.0000i 10.0000 + 23.0000i 14.0000 + 1.0000i 15.0000 + 1.0000i 16.0000 + 9.0000i Get the entire contents of the complex array: int[] index = {2, 3}; double[] x; System.out.println("The real data in matrix A is:"); x = (double[]) A.getData(); for (int i = 0; i < x.length; i++) System.out.print(" " + x[i]); System.out.println(); System.out.println(); System.out.println("The imaginary data in matrix A is:"); x = (double[]) A.getImagData(); for (int i = 0; i < x.length; i++) System.out.print(" " + x[i]); System.out.println(); When run, the example displays this output: The real data in matrix A is: 2.0 8.0 14.0 3.0 9.0 15.0 4.0 10.0 16.0 The imaginary data in matrix A is: 6.0 7.0 1.0 5.0 1.0 1.0 14.0 23.0 9.0 Returns: A 1-D array of elements stored in column-wise order. The elements of the returned array are converted according to default conversion rules.
getImagDouble	public double getImagDouble() Return imaginary component of this array as a scalar double. Returns: Scalar value
getImagDouble	public double getImagDouble(int index) Returns the imaginary part at the specified 1-based offset as a double value. Example: Getting Complex Data of a Specific Type Start by creating a two-dimensional array of complex values: double[][] Rdata = {{ 2, 3, 4}, { 8 , 9, 10}, {14, 15, 16}}; double[][] Idata = {{ 6, 5, 14}, { 7 , 1, 23}, { 1, 1, 9}}; MWNumericArray A = new MWNumericArray(Rdata, Idata, MWClassID.DOUBLE); System.out.println("Complex matrix A ="); System.out.println(A.toString()); 2.0000 + 6.0000i 3.0000 + 5.0000i 4.0000 + 14.0000i 8.0000 + 7.0000i 9.0000 + 1.0000i 10.0000 + 23.0000i 14.0000 + 1.0000i 15.0000 + 1.0000i 16.0000 + 9.0000i Get the real and imaginary parts of one element of the MWNumericArray: int[] index = {2, 3}; System.out.println("The real part of A(2,3) = " + A.getDouble(index)); System.out.println("The imaginary part of A(2,3) = " + A.getImagDouble(index)); The real part of A(2,3) = 10.0 The imaginary part of A(2,3) = 23.0 Parameters: index The index of the requested element. Valid range: 1 <= index <= N, where N = total number of elements in the array. Returns: Value of the requested element. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
getImagDouble	public double getImagDouble(int[] index) Returns the imaginary part at the specified 1-based index-array as a double value. 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 i of the index array has the valid range: 1 <= index[i] <= N[i], where N[i] = the size of the ith dimension. Returns: Value of the requested element. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
getImagDoubleData	public double[] getImagDoubleData() This method returns a one-dimensional array of imaginary elements of the Java primitive type double. For example, if you call getImagDoubleData, an array of type double is returned regardless of the data type in the underlying array. The data is converted from another primitive type, if necessary. If conversion is performed, truncation or other loss of precision may occur. Returns: One-dimensional array of imaginary elements of the Java primitive type double
getImagFloat	public float getImagFloat() Returns the imaginary part at the specified 1-based offset as a float value. Parameters: index The index of the requested element. Valid range: 1 <= index <= N, where N = total number of elements in the array. Returns: Value of the requested element. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
getImagFloat	public float getImagFloat(int index) Returns the imaginary part at the specified 1-based offset as a float value. Parameters: index The index of the requested element. Valid range: 1 <= index <= N, where N = total number of elements in the array. Returns: Value of the requested element. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
getImagFloat	public float getImagFloat(int[] index) Returns the imaginary part at the specified 1-based offset as a float value. 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 i of the index array has the valid range: 1 <= index[i] <= N[i], where N[i] = the size of the ith dimension. Returns: Value of the requested element. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
getImagFloatData	public float[] getImagFloatData() This method returns a one-dimensional array of imaginary elements of the Java primitive type float. For example, if you call getImagFloatData, an array of type float is returned regardless of the data type in the underlying array. The data is converted from another primitive type, if necessary. If conversion is performed, truncation or other loss of precision may occur. Returns: One-dimensional array of imaginary elements of the Java primitive type float
getImagInt	public int getImagInt() Return imaginary component of this array as a scalar int. Returns: Scalar value
getImagInt	public int getImagInt(int index) Returns the imaginary part at the specified 1-based offset as an int value. Parameters: index The index of the requested element. Valid range: 1 <= index <= N, where N = total number of elements in the array. Returns: Value of the requested element. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
getImagInt	public int getImagInt(int[] index) Returns the imaginary part at the specified 1-based index-array as an int value. 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 i of the index array has the valid range: 1 <= index[i] <= N[i], where N[i] = the size of the ith dimension. Returns: Value of the requested element. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
getImagIntData	public int[] getImagIntData() This method returns a one-dimensional array of imaginary elements of the Java primitive type int. For example, if you call getImagIntData, an array of type int is returned regardless of the data type in the underlying array. The data is converted from another primitive type, if necessary. If conversion is performed, truncation or other loss of precision may occur. Returns: One-dimensional array of imaginary elements of the Java primitive type int
getImagLong	public long getImagLong() Return imaginary component of this array as a scalar long. Returns: Scalar value
getImagLong	public long getImagLong(int index) Returns the imaginary part at the specified 1-based offset as a long value. Parameters: index The index of the requested element. Valid range: 1 <= index <= N, where N = total number of elements in the array. Returns: Value of the requested element. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
getImagLong	public long getImagLong(int[] index) Returns the imaginary part at the specified 1-based index-array as a long value. 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 i of the index array has the valid range: 1 <= index[i] <= N[i], where N[i] = the size of the ith dimension. Returns: Value of the requested element. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
getImagLongData	public long[] getImagLongData() This method returns a one-dimensional array of imaginary elements of the Java primitive type long. For example, if you call getImagLongData, an array of type long is returned regardless of the data type in the underlying array. The data is converted from another primitive type, if necessary. If conversion is performed, truncation or other loss of precision may occur. Returns: One-dimensional array of imaginary elements of the Java primitive type long
getImagShort	public short getImagShort() Return imaginary component of this array as a scalar short. Returns: Scalar value
getImagShort	public short getImagShort(int index) Returns the imaginary part at the specified 1-based offset as a short value. Parameters: index The index of the requested element. Valid range: 1 <= index <= N, where N = total number of elements in the array. Returns: Value of the requested element. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
getImagShort	public short getImagShort(int[] index) Returns the imaginary part at the specified 1-based index-array as a short value. 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 i of the index array has the valid range: 1 <= index[i] <= N[i], where N[i] = the size of the ith dimension. Returns: Value of the requested element. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
getImagShortData	public short[] getImagShortData() This method returns a one-dimensional array of imaginary elements of the Java primitive type short. For example, if you call getImagShortData, an array of type short is returned regardless of the data type in the underlying array. The data is converted from another primitive type, if necessary. If conversion is performed, truncation or other loss of precision may occur. Returns: One-dimensional array of imaginary elements of the Java primitive type short
getInf	public static double getInf() Returns MATLAB's concept of Inf. Returns: Inf as a double
getInt	public int getInt() Return this array as a scalar int. Returns: Scalar value.
getInt	public int getInt(int index) Returns the real part at the specified 1-based offset as an int value. Parameters: index The index of the requested element. Valid range: 1 <= index <= N, where N = total number of elements in the array. Returns: Value of the requested element. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
getInt	public int getInt(int[] index) Returns the real part at the specified 1-based index-array as an int value. 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 i of the index array has the valid range: 1 <= index[i] <= N[i], where N[i] = the size of the ith dimension. Returns: Value of the requested element. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
getIntData	public int[] getIntData() This method returns a one-dimensional array of Java types matching the primitive type int. For example, if you call getIntData, an array of type int is returned regardless of the data type in the underlying array. The data is converted from another primitive type, if necessary. If conversion is performed, truncation or other loss of precision may occur. Returns: One-dimensional array of elements of the Java primitive type int Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
getLong	public long getLong() Return this array as a scalar long. Returns: Scalar value
getLong	public long getLong(int index) Parameters: index Returns: Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
getLong	public long getLong(int[] index) Returns the real part at the specified 1-based index-array as a long value. 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 i of the index array has the valid range: 1 <= index[i] <= N[i], where N[i] = the size of the ith dimension. Returns: Value of the requested element. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
getLongData	public long[] getLongData() This method returns a one-dimensional array of Java types matching the primitive type long. For example, if you call getLongData, an array of type long is returned regardless of the data type in the underlying array. The data is converted from another primitive type, if necessary. If conversion is performed, truncation or other loss of precision may occur. Returns: One-dimensional array of elements of the Java primitive type long
getNaN	public static double getNaN() Returns MATLAB's concept of NaN. Returns: NaN as a double.
getShort	public short getShort() Return this array as a scalar short. Returns: Scalar value
getShort	public short getShort(int index) Returns the real part at the specified 1-based offset as a short value. Parameters: index The index of the requested element. Valid range: 1 <= index <= N, where N = total number of elements in the array. Returns: Value of the requested element. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
getShort	public short getShort(int[] index) Returns the real part at the specified 1-based index-array as a short value. 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 i of the index array has the valid range: 1 <= index[i] <= N[i], where N[i] = the size of the ith dimension. Returns: Value of the requested element. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
getShortData	public short[] getShortData() This method returns a one-dimensional array of Java types matching the primitive type short. For example, if you call getShortData, an array of type short is returned regardless of the data type in the underlying array. The data is converted from another primitive type, if necessary. If conversion is performed, truncation or other loss of precision may occur. Returns: One-dimensional array of elements of the Java primitive type short
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 Parameters: index Returns: true if empty, false otherwise
isFinite	public static boolean isFinite(double x) Test for finiteness in a machine-independent manner. Example: Testing for Finite Array Values Test x for finiteness: double x = 25; if (MWNumericArray.isFinite(x)) System.out.println("The input value is finite"); When run, the example displays this output: The input value is finite Parameters: x double value to test for Returns: true if finite, false otherwise
isInf	public static boolean isInf(double x) Test for infinity in a machine-independent manner. Example: Test x for infinity double x = 1.0 / 0.0; if (MWNumericArray.isInf(x)) System.out.println("The input value is infinite"); When run, the example displays this output: The input value is infinite Parameters: x double value to test for infinity Returns: true if infinite, false otherwise
isNaN	public static boolean isNaN(double x) Test for NaN in a machine-independent manner. Example: Testing for NaN Array Values Test x for NaN: double x = 0.0 / 0.0; if (MWNumericArray.isNaN(x)) System.out.println("The input value is not a number."); When run, the example displays this output: The input value is not a number Parameters: x double value to test for NaN Returns: true if NaN, false otherwise
isSparse	public boolean isSparse() Tests if this array is sparse. Parameters: index Specified by: isSparse in class MWArray Returns: true if sparse, 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.
newInstance	public static MWNumericArray newInstance(int[] dims, MWClassID classid, MWComplexity cmplx) Constructs a numeric array with the specified dimensions and complexity. The elements of the array are all initialized to 0. This method offers better performance than using the class constructor. To construct an uninitialized real or complex numeric array, use the following: newInstance(int[] dims, MWClassID classid, MWComplexity cmplx) To construct and initialize a real numeric array, use: newInstance(int[] dims, Object rData, MWClassID classid) To construct and initialize a complex numeric array, use newInstance(int[] dims, Object rData, Object iData, MWClassID classid) Example: Constructing a Numeric Array Object with newInstance Construct a 3-by-6 real numeric array using the newInstance method. Note that data in the Java array must be stored in column-major order so that it will be in the correct order in the final MWNumericArray object. int[] dims = {3, 6}; double[] Adata = { 1, 7, 13, 2, 8, 14, 3, 9, 15, 4, 10, 16, 5, 11, 17, 6, 12, 18}; MWNumericArray A = MWNumericArray.newInstance(dims, Adata, MWClassID.DOUBLE); System.out.println("A = " + A); When run, the example displays this output: A = 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 Parameters: dims array of dimension sizes. Each dimension size must be non-negative. classid MWClassID representing the MATLAB type of the array. For numeric arrays, the following types are allowed: MWClassID.DOUBLE, MWClassID.SINGLE, MWClassID.INT8, MWClassID.UINT8, MWClassID.INT16, MWClassID.UINT16, MWClassID.INT32, MWClassID.UINT32, MWClassID.INT64, MWClassID.UINT64 cmplx Array complexity. MWComplexity.REAL = Real array, MWComplexity.COMPLEX = Complex array. Returns: A new MWNumericArray with the specified size, type, and complexity. Throws: java.lang.NegativeArraySizeException A negative dimension size is supplied.
newInstance	public static MWNumericArray newInstance(int[] dims, java.lang.Object rData, MWClassID classid) Constructs a real numeric array with the specified dimensions and initializes the array with the supplied data. The input array must be a 1-D array with the data stored in column-major order. Valid types for input arrays are: double[], float[], byte[], short[], int[], long[], boolean[], 1-D arrays of any sub-class of java.lang.Number, and 1-D arrays of java.lang.Boolean. Parameters: dims Array of dimension sizes. Each dimension size must be non-negative. rData Data to initialize the array with. classid MWClassID representing the MATLAB type of the array. For numeric arrays, the following types are allowed: MWClassID.DOUBLE, MWClassID.SINGLE, MWClassID.INT8, MWClassID.UINT8, MWClassID.INT16, MWClassID.UINT16, MWClassID.INT32, MWClassID.UINT32, MWClassID.INT64, MWClassID.UINT64 Returns: A new MWNumericArray with the specified dimensions and type, and initialized with the supplied data. Throws: java.lang.NegativeArraySizeException A negative dimension size is supplied. java.lang.ArrayStoreException An incompatible array type or invalid array data was specified.
newInstance	public static MWNumericArray newInstance(int[] dims, java.lang.Object rData, java.lang.Object iData, MWClassID classid) Constructs a complex numeric array with the specified dimensions and initializes the array with the supplied data. The input arrays must be 1-D arrays with the data stored in column-major order. Valid types for input arrays are: double[], float[], byte[], short[], int[], long[], boolean[], 1-D arrays of any sub-class of java.lang.Number, and 1-D arrays of java.lang.Boolean. Parameters: dims Array of dimension sizes. Each dimension size must be non-negative. rData Data to initialize the real part of the array with. iData Data to initialize the imaginary part of the array with. classid MWClassID representing the MATLAB type of the array. For numeric arrays, the following types are allowed: MWClassID.DOUBLE, MWClassID.SINGLE, MWClassID.INT8, MWClassID.UINT8, MWClassID.INT16, MWClassID.UINT16, MWClassID.INT32, MWClassID.UINT32, MWClassID.INT64, MWClassID.UINT64 Returns: A new MWNumericArray with the specified dimensions and type, and initialized with the supplied data. Throws: java.lang.NegativeArraySizeException A negative dimension size is supplied. java.lang.ArrayStoreException An incompatible array type or invalid array data was specified.
newSparse	public static MWNumericArray newSparse(int[] rowindex, int[] colindex, java.lang.Object rData, int rows, int cols, int nzmax, MWClassID classid) Constructs a real sparse numeric matrix with the specified number of rows and columns, maximum nonzero elements, and initializes the array with the supplied data. The row and column index arrays are used to construct the sparse array such that S(rowindex(k), columnindex(k)) = rData(k), with space allocated for nzmax nonzeros. Valid types for the input array are: double[], float[], byte[], short[], int[], long[], boolean[], 1-D arrays of any sub-class of java.lang.Number, 1-D arrays of java.lang.Boolean, and 1-D arrays of java.lang.String. Currently, only numeric sparse arrays of type double are supported. Any elements of the data arrays that have duplicate values of rowindex and columnindex are added together. To construct a Sparse Matrix with No Nonzero Elements: newSparse(int rows, int cols, int nzmax, MWClassID classid, MWComplexity cmplx) To construct a real sparse array from an existing nonsparse two-dimensional array, use: newSparse(Object realData, MWClassID classid) To construct and initialize a new real sparse array, use: newSparse(int[] rowindex, int[] colindex, Object realData, MWClassID classid) To construct and initialize a new real sparse array, specifying its dimensions, use: newSparse(int[] rowindex, int[] colindex, Object realData, int rows, int cols, MWClassID classid) To construct and initialize a new real sparse array, specifying its dimensions and maximum number of nonzeros, use: newSparse(int[] rowindex, int[] colindex, Object realData, int rows, int cols, int nzmax, MWClassID classid) To construct a complex sparse array from an existing nonsparse two-dimensional array, use: newSparse(Object realData, Object imagData, MWClassID classid) To construct and initialize a new complex sparse array, use: newSparse(int[] rowindex, int[] colindex, Object realData, Object imagData, MWClassID classid) To construct and initialize a new complex sparse array, specifying its dimensions, use: newSparse(int[] rowindex, int[] colindex, Object realData, Object imagData, int rows, int cols, MWClassID classid) To construct and initialize a new complex sparse array, specifying its dimensions and maximum number of nonzeros, use: newSparse(int[] rowindex, int[] colindex, Object realData, Object imagData, int rows, int cols, int nzmax, MWClassID classid) Example: Constructing a Sparse Array Object with newSparse To create a sparse complex MWNumericArray, construct a two-dimensional complex sparse MWNumericArray from the real and imaginary double vectors: double[][] rData = {{ 0, 0, 0, 16, 0}, {71, 63, 32, 0, 0}}; double[][] iData = {{ 0, 0, 0, 41, 0}, { 0, 0, 32, 0, 2}}; MWNumericArray A = MWNumericArray.newSparse(rData, iData, MWClassID.DOUBLE); System.out.println("A = " + A.toString()); When run, the example displays this output: A = (2,1) 71.0000 (2,2) 63.0000 (2,3) 32.0000 +32.0000i (1,4) 16.0000 +41.0000i (2,5) 0 + 2.0000i Example: Using newSparse with Row and Column Indices Construct a sparse MWNumericArray from vector Adata: double[] Adata = { 0, 10, 0, 0, 40, 50, 60, 0, 0, 90}; int[] ri = {1, 1, 1, 1, 1, 2, 2, 2, 2, 2}; int[] ci = {1, 2, 3, 4, 5, 1, 2, 3, 4, 5}; MWNumericArray A = MWNumericArray.newSparse(ri, ci, Adata, MWClassID.DOUBLE); System.out.println("A = " + A.toString()); When run, the example displays this output: (2,1) 50 (1,2) 10 (2,2) 60 (1,5) 40 (2,5) 90 Example: Assigning Multiple Values to a Single Array Element Create a sparse MWNumericArray using the rowindex and colindex arguments, specifying multiple values for the array element at index (2, 5). The result is that this element stores the sum of the values from Adata(1), Adata(7), Adata(8), and Adata(9), which is equal to 250. double[] Adata = { 0, 10, 0, 0, 40, 50, 60, 70, 80, 90}; int[] ri = {1, 2, 1, 1, 1, 2, 2, 2, 2, 2}; int[] ci = {1, 5, 2, 3, 5, 1, 2, 5, 5, 5}; MWNumericArray A = MWNumericArray.newSparse(ri, ci, Adata, 4, 5, MWClassID.DOUBLE); System.out.println("A = " + A.toString()); When run, the example displays this output: (2,1) 50 (2,2) 60 (1,5) 40 (2,5) 250 Parameters: rowindex Array of 1-based row indices. colindex Array of 1-based column indices. rData Data to initialize the real part of the array with. rows Number of rows in the matrix. cols umber of columns in the matrix. nzmax Maximum number of nonzero elements. classid MWClassID representing the MATLAB type of the array. Currently, the only type allowed is MWClassID.DOUBLE. Returns: A new sparse MWNumericArray with the specified size and initialized with the supplied data. Throws: java.lang.NegativeArraySizeException A negative dimension size is supplied. java.lang.ArrayStoreException An incompatible array type or invalid array data was specified. java.lang.IndexOutOfBoundsException An invalid row or column index was specified.
newSparse	public static MWNumericArray newSparse(int[] rowindex, int[] colindex, java.lang.Object rData, int rows, int cols, MWClassID classid) Constructs a real sparse numeric matrix with the specified number of rows and columns, and initializes the array with the supplied data. The maximum number of nonzero elements is calculated from rData.length. The row and column index arrays are used to construct the sparse array such that S(rowindex(k), columnindex(k)) = rData(k). Valid types for the input array are: double[], float[], byte[], short[], int[], long[], boolean[], 1-D arrays of any sub-class of java.lang.Number, 1-D arrays of java.lang.Boolean, and 1-D arrays of java.lang.String. Currently, only numeric sparse arrays of type double are supported. Any elements of the data arrays that have duplicate values of rowindex and columnindex are added together. Parameters: rowindex Array of 1-based row indices. colindex Array of 1-based column indices. rData Data to initialize the real part of the array with. rows Number of rows in the matrix. cols umber of columns in the matrix. classid MWClassID representing the MATLAB type of the array. Currently, the only type allowed is MWClassID.DOUBLE. Returns: A new sparse MWNumericArray with the specified size and initialized with the supplied data. Throws: java.lang.NegativeArraySizeException A negative dimension size is supplied. java.lang.ArrayStoreException An incompatible array type or invalid array data was specified. java.lang.IndexOutOfBoundsException An invalid row or column index was specified.
newSparse	public static MWNumericArray newSparse(int[] rowindex, int[] colindex, java.lang.Object rData, MWClassID classid) Constructs a real sparse numeric matrix with the number of rows = max{rowindex(k)} and the number of columns = max{colindex(k)}, and initializes the array with the supplied data. The maximum number of nonzero elements is calculated from rData.length. The row and column index arrays are used to construct the sparse array such that S(rowindex(k), columnindex(k)) = rData(k). Valid types for the input array are: double[], float[], byte[], short[], int[], long[], boolean[], 1-D arrays of any sub-class of java.lang.Number, 1-D arrays of java.lang.Boolean, and 1-D arrays of java.lang.String. Currently, only numeric sparse arrays of type double are supported. Any elements of the data arrays that have duplicate values of rowindex and columnindex are added together. Parameters: rowindex Array of 1-based row indices. colindex Array of 1-based column indices. rData Data to initialize the real part of the array with. classid MWClassID representing the MATLAB type of the array. Currently, the only type allowed is MWClassID.DOUBLE. Returns: A new sparse MWNumericArray with the specified size and initialized with the supplied data. Throws: java.lang.NegativeArraySizeException A negative dimension size is supplied. java.lang.ArrayStoreException An incompatible array type or invalid array data was specified. java.lang.IndexOutOfBoundsException An invalid row or column index was specified.
newSparse	public static MWNumericArray newSparse(java.lang.Object rArr, MWClassID classid) Constructs a real sparse numeric matrix from the supplied full matrix. Currently, only numeric sparse arrays of type double are supported. Parameters: rArr Array to convert. classid MWClassID representing the MATLAB type of the array. Currently, the only type allowed is MWClassID.DOUBLE. Returns: A new sparse MWNumericArray initialized with the supplied data. Throws: java.lang.ArrayStoreException An incompatible array type or invalid array data was specified.
newSparse	public static MWNumericArray newSparse(int[] rowindex, int[] colindex, java.lang.Object rData, java.lang.Object iData, int rows, int cols, int nzmax, MWClassID classid) Constructs a complex sparse numeric matrix with the specified number of rows and columns, maximum nonzero elements, and initializes the array with the supplied data. The row and column index arrays are used to construct the sparse array such that S(rowindex(k), columnindex(k)) = rData(k) + iData(k)*i, with space allocated for nzmax nonzeros. Valid types for input arrays are: double[], float[], byte[], short[], int[], long[], boolean[], 1-D arrays of any sub-class of java.lang.Number, 1-D arrays of java.lang.Boolean, and 1-D arrays of java.lang.String. Currently, only numeric sparse arrays of type double are supported. Any elements of the data arrays that have duplicate values of rowindex and columnindex are added together. Parameters: rowindex Array of 1-based row indices. colindex Array of 1-based column indices. rData Data to initialize the real part of the array with. iData Data to initialize the imaginary part of the array with. rows Number of rows in the matrix. cols Number of columns in the matrix. nzmax Maximum number of nonzero elements. classid MWClassID representing the MATLAB type of the array. Currently, the only type allowed is MWClassID.DOUBLE. Returns: A new sparse MWNumericArray with the specified size and initialized with the supplied data. Throws: java.lang.NegativeArraySizeException A negative dimension size is supplied. java.lang.ArrayStoreException An incompatible array type or invalid array data was specified. java.lang.IndexOutOfBoundsException An invalid row or column index was specified.
newSparse	public static MWNumericArray newSparse(int[] rowindex, int[] colindex, java.lang.Object rData, java.lang.Object iData, int rows, int cols, MWClassID classid) Constructs a complex sparse numeric matrix with the specified number of rows and columns, and initializes the array with the supplied data. The maximum number of nonzero elements is calculated from max{rData.length, iData.length}. The row and column index arrays are used to construct the sparse array such that S(rowindex(k), columnindex(k)) = rData(k) + iData(k)*i. Valid types for input arrays are: double[], float[], byte[], short[], int[], long[], boolean[], 1-D arrays of any sub-class of java.lang.Number, 1-D arrays of java.lang.Boolean, and 1-D arrays of java.lang.String. Currently, only numeric sparse arrays of type double are supported. Any elements of the data arrays that have duplicate values of rowindex and columnindex are added together. Parameters: rowindex Array of 1-based row indices. colindex Array of 1-based column indices. rData Data to initialize the real part of the array with. iData Data to initialize the imaginary part of the array with. rows Number of rows in the matrix. cols Number of columns in the matrix. classid MWClassID representing the MATLAB type of the array. Currently, the only type allowed is MWClassID.DOUBLE. Returns: A new sparse MWNumericArray with the specified size and initialized with the supplied data. Throws: java.lang.NegativeArraySizeException A negative dimension size is supplied. java.lang.ArrayStoreException An incompatible array type or invalid array data was specified. java.lang.IndexOutOfBoundsException An invalid row or column index was specified.
newSparse	public static MWNumericArray newSparse(int[] rowindex, int[] colindex, java.lang.Object rData, java.lang.Object iData, MWClassID classid) Constructs a complex sparse numeric matrix with the number of rows = max{rowindex(k)} and the number of columns = max{colindex(k)}, and initializes the array with the supplied data. The maximum number of nonzero elements is calculated from max{rData.length, iData.length}. The row and column index arrays are used to construct the sparse array such that S(rowindex(k), columnindex(k)) = rData(k) + iData(k)*i. Valid types for input arrays are: double[], float[], byte[], short[], int[], long[], boolean[], 1-D arrays of any sub-class of java.lang.Number, 1-D arrays of java.lang.Boolean, and 1-D arrays of java.lang.String. Currently, only numeric sparse arrays of type double are supported. Any elements of the data arrays that have duplicate values of rowindex and columnindex are added together. Parameters: rowindex Array of 1-based row indices. colindex Array of 1-based column indices. rData Data to initialize the real part of the array with. iData Data to initialize the imaginary part of the array with. classid MWClassID representing the MATLAB type of the array. Currently, the only type allowed is MWClassID.DOUBLE. Returns: A new sparse MWNumericArray with the specified size and initialized with the supplied data. Throws: java.lang.NegativeArraySizeException A negative dimension size is supplied. java.lang.ArrayStoreException An incompatible array type or invalid array data was specified. java.lang.IndexOutOfBoundsException An invalid row or column index was specified.
newSparse	public static MWNumericArray newSparse(java.lang.Object rArr, java.lang.Object iArr, MWClassID classid) Constructs a complex sparse numeric matrix from the supplied full matrices. Currently, only numeric sparse arrays of type double are supported. Parameters: rArr Array to convert to real part of matrix. iArr Array to convert to imaginary part of matrix. classid MWClassID representing the MATLAB type of the array. Currently, the only type allowed is MWClassID.DOUBLE. Returns: A new sparse MWNumericArray initialized with the supplied data. Throws: java.lang.ArrayStoreException An incompatible array type or invalid array data was specified.
newSparse	public static MWNumericArray newSparse(int rows, int cols, int nzmax, MWClassID classid, MWComplexity cmplx) Constructs a sparse numeric matrix with no nonzero elements. Parameters: rows Number of rows in the matrix. cols Number of columns in the matrix. nzmax Maximum number of nonzero elements. classid MWClassID representing the MATLAB type of the array. Currently, the only type allowed is MWClassID.DOUBLE. cmplx Array complexity. MWComplexity.REAL = Real array, MWComplexity.COMPLEX = Complex array. Currently, the only type allowed is MWClassID.DOUBLE. Returns: A new sparse MWNumericArray with the specified size. Throws: java.lang.NegativeArraySizeException A negative dimension size is supplied. java.lang.ArrayStoreException An incompatible array type or invalid array data was specified. java.lang.IndexOutOfBoundsException An invalid row or column index was specified.
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 An invalid index has been supplied. java.io.ObjectStreamException An array containing all of the exceptions that were suppressed.
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.
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.
set	public void set(int index, double element) Replaces the real part at the specified 1-based offset in this array with the specified double value. 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 value to replace at index. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
set	public void set(int index, float element) Replaces the real part at the specified 1-based offset in this array with the specified float value. 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 value to replace at index. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
set	public void set(int index, byte element) Replaces the real part at the specified 1-based offset in this array with the specified byte value. 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 value to replace at index. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
set	public void set(int index, int element) Replaces the real part at the specified 1-based offset in this array with the specified int value. 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 value to replace at index. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
set	public void set(int index, short element) Replaces the real part at the specified 1-based offset in this array with the specified short value. 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 value to replace at index. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
set	public void set(int index, long element) Replaces the real part at the specified 1-based offset in this array with the specified long value. 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 value to replace at index. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
set	public void set(int[] index, double element) Replaces the real part at the specified 1-based index-array in this array with the specified double value. 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 i of the index array has the valid range: 1 <= index[i] <= N[i], where N[i] = the size of the ith dimension. element New value to replace at index. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
set	public void set(int[] index, float element) Replaces the real part at the specified 1-based index-array in this array with the specified float value. 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 i of the index array has the valid range: 1 <= index[i] <= N[i], where N[i] = the size of the ith dimension. element New value to replace at index. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
set	public void set(int[] index, byte element) Replaces the real part at the specified 1-based index-array in this array with the specified byte value. 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 i of the index array has the valid range: 1 <= index[i] <= N[i], where N[i] = the size of the ith dimension. element New value to replace at index. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
set	public void set(int[] index, int element) Replaces the real part at the specified 1-based index-array in this array with the specified int value. 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 i of the index array has the valid range: 1 <= index[i] <= N[i], where N[i] = the size of the ith dimension. element New value to replace at index. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
set	public void set(int[] index, short element) Replaces the real part at the specified 1-based index-array in this array with the specified short value. 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 i of the index array has the valid range: 1 <= index[i] <= N[i], where N[i] = the size of the ith dimension. element New value to replace at index. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
set	public void set(int[] index, long element) Replaces the real part at the specified 1-based index-array in this array with the specified long value. 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 i of the index array has the valid range: 1 <= index[i] <= N[i], where N[i] = the size of the ith dimension. element New value to replace 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
setImag	public void setImag(int index, java.lang.Object element) Replaces the imaginary part 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 value to replace at index. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
setImag	public void setImag(int index, double element) Replaces the imaginary part at the specified 1-based offset in this array with the specified double value. 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 value to replace at index. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
setImag	public void setImag(int index, float element) Replaces the imaginary part at the specified 1-based offset in this array with the specified float value. 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 value to replace at index. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
setImag	public void setImag(int index, byte element) Replaces the imaginary part at the specified 1-based offset in this array with the specified byte value. 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 value to replace at index. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
setImag	public void setImag(int index, int element) Replaces the imaginary part at the specified 1-based offset in this array with the specified int value. 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 value to replace at index. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
setImag	public void setImag(int index, short element) Replaces the imaginary part at the specified 1-based offset in this array with the specified short value. 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 value to replace at index. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
setImag	public void setImag(int index, long element) Replaces the imaginary part at the specified 1-based offset in this array with the specified long value. 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 value to replace at index. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
setImag	public void setImag(int[] index, java.lang.Object element) Replaces the imaginary part 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 i of the index array has the valid range: 1 <= index[i] <= N[i], where N[i] = the size of the ith dimension. element New value to replace at index. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
setImag	public void setImag(int[] index, double element) Replaces the imaginary part at the specified 1-based index-array in this array with the specified double value. 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 i of the index array has the valid range: 1 <= index[i] <= N[i], where N[i] = the size of the ith dimension. element New value to replace at index. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
setImag	public void setImag(int[] index, float element) Replaces the imaginary part at the specified 1-based index-array in this array with the specified float value. 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 i of the index array has the valid range: 1 <= index[i] <= N[i], where N[i] = the size of the ith dimension. element New value to replace at index. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
setImag	public void setImag(int[] index, byte element) Replaces the imaginary part at the specified 1-based index-array in this array with the specified byte value. 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 i of the index array has the valid range: 1 <= index[i] <= N[i], where N[i] = the size of the ith dimension. element New value to replace at index. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
setImag	public void setImag(int[] index, int element) Replaces the imaginary part at the specified 1-based index-array in this array with the specified int value. 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 i of the index array has the valid range: 1 <= index[i] <= N[i], where N[i] = the size of the ith dimension. element New value to replace at index. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
setImag	public void setImag(int[] index, short element) Replaces the imaginary part at the specified 1-based index-array in this array with the specified short value. 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 i of the index array has the valid range: 1 <= index[i] <= N[i], where N[i] = the size of the ith dimension. element New value to replace at index. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
setImag	public void setImag(int[] index, long element) Replaces the imaginary part at the specified 1-based index-array in this array with the specified long value. 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 i of the index array has the valid range: 1 <= index[i] <= N[i], where N[i] = the size of the ith dimension. element New value to replace at index. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
setImagData	public void setImagData(java.lang.Object data) Initializes imaginary component of MATLAB array data. Parameters: data A single dimensional array containing all element values in row-major order. Throws: java.lang.ArrayStoreException Thrown if data type is non-numeric.
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. Parameters: index Returns: An MWNumericArray instance representing a shared copy of the underlying MATLAB array. Throws: java.lang.IndexOutOfBoundsException An invalid index has been supplied.
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. Specified by: toArray in class MWArray Returns: An array with the same dimensionality of the MATLAB array.
toByteArray	public java.lang.Object toByteArray() Returns an array of elements of the Java primitive type byte. The returned array is of the same dimension as the underlying MATLAB array. For example, if you call toByteArray, an array of type byte is returned regardless of the data type in the underlying array. The data is converted from another primitive type, if necessary, and the array's original dimensions are preserved upon return. If conversion is performed, truncation or other loss of precision may occur. Returns: Array of elements of the Java primitive type byte
toDoubleArray	public java.lang.Object toDoubleArray() Returns an array of elements of the Java primitive type double. The returned array is of the same dimension as the underlying MATLAB array. For example, if you call toDoubleArray, an array of type double is returned regardless of the data type in the underlying array. The data is converted from another primitive type, if necessary, and the array's original dimensions are preserved upon return. If conversion is performed, truncation or other loss of precision may occur. See example in toDoubleArray. Returns: Array of elements of the Java primitive type double
toFloatArray	public java.lang.Object toFloatArray() Returns an array of elements of the Java primitive type float. The returned array is of the same dimension as the underlying MATLAB array. For example, if you call toFloatArray, an array of type float is returned regardless of the data type in the underlying array. The data is converted from another primitive type, if necessary, and the array's original dimensions are preserved upon return. If conversion is performed, truncation or other loss of precision may occur. Example: Using toTypeArray Methods This example demonstrates how you can coerce or force data to a specified numeric type by invoking any of the toTypeArray methods. Object results = null; try { // call a compiled m-function results = myobject.myfunction(2); // first output is known to be a numeric matrix MWNumericArray resultA = (MWNumericArray) results[0]; double[][] a = resultA.toDoubleArray(); // second output is known to be a 3-dimensional numeric array MWNumericArray resultB = (MWNumericArray) results[1]; int[][][] b = resultB.toIntArray(); } finally { MWNumericArray.disposeArray(results); } Returns: Array of elements of the Java primitive type float.
toImagArray	public java.lang.Object toImagArray() Returns an array containing a copy of the imaginary data in the underlying MATLAB array. Returns: An array with the same dimensionality of the MATLAB array. The elements of the returned array are converted according to default conversion rules. Example: Getting Complex Data with toImagArray Start by creating a two-dimensional array of complex values: double[][] Rdata = {{ 2, 3, 4}, { 8 , 9, 10}, {14, 15, 16}}; double[][] Idata = {{ 6, 5, 14}, { 7 , 1, 23}, { 1, 1, 9}}; MWNumericArray A = new MWNumericArray(Rdata, Idata, MWClassID.DOUBLE); System.out.println("Complex matrix A ="); System.out.println(A.toString()); Here is the complex array that is displayed: 2.0000 + 6.0000i 3.0000 + 5.0000i 4.0000 + 14.0000i 8.0000 + 7.0000i 9.0000 + 1.0000i 10.0000 + 23.0000i 14.0000 + 1.0000i 15.0000 + 1.0000i 16.0000 + 9.0000i Get and display a copy of the imaginary part of this array: double[][] x = (double[][]) A.toImagArray(); int[] dimA = A.getDimensions(); System.out.println("The imaginary part of matrix A is:"); for (int i = 0; i < dimA[0]; i++) { for (int j = 0; j < dimA[1]; j++) { System.out.print(" " + x[i][j]); } System.out.println(); } When run, the example displays this output: The imaginary part of matrix A is: 6.0 5.0 14.0 7.0 1.0 23.0 1.0 1.0 9.0
toImagByteArray	public java.lang.Object toImagByteArray() Returns an array of imaginary elements of the Java primitive type byte. The returned array is of the same dimension as the underlying MATLAB array. For example, if you call toImagByteArray, an array of type byte is returned regardless of the data type in the underlying array. The data is converted from another primitive type, if necessary, and the array's original dimensions are preserved upon return. If conversion is performed, truncation or other loss of precision may occur. See example in toDoubleArray. Returns: Array of imaginary elements of the Java primitive type byte.
toImagDoubleArray	public java.lang.Object toImagDoubleArray() Returns an array of imaginary elements of the Java primitive type double. The returned array is of the same dimension as the underlying MATLAB array. For example, if you call toImagDoubleArray, an array of type double is returned regardless of the data type in the underlying array. The data is converted from another primitive type, if necessary, and the array's original dimensions are preserved upon return. If conversion is performed, truncation or other loss of precision may occur. See example in toDoubleArray. Returns: Array of imaginary elements of the Java primitive type double
toImagFloatArray	public java.lang.Object toImagFloatArray() Returns an array of imaginary elements of the Java primitive type float. The returned array is of the same dimension as the underlying MATLAB array. For example, if you call toImagFloatArray, an array of type float is returned regardless of the data type in the underlying array. The data is converted from another primitive type, if necessary, and the array's original dimensions are preserved upon return. If conversion is performed, truncation or other loss of precision may occur. See example in toDoubleArray. Returns: Array of imaginary elements of the Java primitive type float.
toImagIntArray	public java.lang.Object toImagIntArray() Returns an array of imaginary elements of the Java primitive type int. The returned array is of the same dimension as the underlying MATLAB array. For example, if you call toImagIntArray, an array of type int is returned regardless of the data type in the underlying array. The data is converted from another primitive type, if necessary, and the array's original dimensions are preserved upon return. If conversion is performed, truncation or other loss of precision may occur. See example in toDoubleArray. Returns: Array of imaginary elements of the Java primitive type int.
toImagLongArray	public java.lang.Object toImagLongArray() Returns an array of imaginary elements of the Java primitive type long. The returned array is of the same dimension as the underlying MATLAB array. For example, if you call toImagLongArray, an array of type long is returned regardless of the data type in the underlying array. The data is converted from another primitive type, if necessary, and the array's original dimensions are preserved upon return. If conversion is performed, truncation or other loss of precision may occur. See example in toDoubleArray. Returns: Array of imaginary elements of the Java primitive type long.
toImagShortArray	public java.lang.Object toImagShortArray() Returns an array of imaginary elements of the Java primitive type short. The returned array is of the same dimension as the underlying MATLAB array. For example, if you call toImagShortArray, an array of type short is returned regardless of the data type in the underlying array. The data is converted from another primitive type, if necessary, and the array's original dimensions are preserved upon return. If conversion is performed, truncation or other loss of precision may occur. See example in toDoubleArray. Returns: Array of imaginary elements of the Java primitive type short.
toIntArray	public java.lang.Object toIntArray() Returns an array of elements of the Java primitive type int. The returned array is of the same dimension as the underlying MATLAB array. For example, if you call toIntArray, an array of type int is returned regardless of the data type in the underlying array. The data is converted from another primitive type, if necessary, and the array's original dimensions are preserved upon return. If conversion is performed, truncation or other loss of precision may occur. See example in toDoubleArray. Returns: Array of elements of the Java primitive type int.
toLongArray	public java.lang.Object toLongArray() Returns an array of elements of the Java primitive type long. The returned array is of the same dimension as the underlying MATLAB array. For example, if you call toLongArray, an array of type long is returned regardless of the data type in the underlying array. The data is converted from another primitive type, if necessary, and the array's original dimensions are preserved upon return. If conversion is performed, truncation or other loss of precision may occur. See example in toDoubleArray. Returns: Array of elements of the Java primitive type long.
toShortArray	public java.lang.Object toShortArray() Returns an array of elements of the Java primitive type short. The returned array is of the same dimension as the underlying MATLAB array. For example, if you call toShortArray, an array of type short is returned regardless of the data type in the underlying array. The data is converted from another primitive type, if necessary, and the array's original dimensions are preserved upon return. If conversion is performed, truncation or other loss of precision may occur. See example in toDoubleArray. Returns: Array of elements of the Java primitive type short.
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

Construct Empty Numeric Array Object

 MWNumericArray A = new MWNumericArray(MWClassID.INT64);
      System.out.println("A = " + A);

A = []

Construct Integer Array Object

double AReal = 24;
 
MWNumericArray A = new MWNumericArray(AReal, MWClassID.INT16);
System.out.println("Array A of type " + A.classID() + " = \n" + A);

Array A of type int16 =
          24
 

Construct Complex Array Object

double AReal = 24;
double AImag = 5;
 
MWNumericArray A = new MWNumericArray(AReal, AImag);
System.out.println("Array A of type " + A.classID() + " = \n" + A);

Array A of type double =
    24.0000 + 5.0000i

Construct Real Array of Specific Type

double[][] AData = {{ 1, 2, 3, 4, 5, 6},
                    { 7, 8 , 9, 10, 11, 12},
                    {13, 14, 15, 16, 17, 18}};
 
MWNumericArray A = new MWNumericArray(AData, MWClassID.SINGLE);
System.out.println("Array A = \n" + A);

 A =   1   2   3   4   5   6
       7   8   9  10  11  12
      13  14  15  16  17  18
 

Version History

Introduced in R2006a