com.mathworks.extern.java.MWArray Class

Namespace: com.mathworks.extern.java
Superclasses:

Abstract Java base class to manage array types in MATLAB

Description

Declaration

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

The MWArray class, part of the com.mathworks.extern.java package, serves as the foundational abstract class for native MATLAB array types, specifically struct and cell arrays. Extending from Java's core Object class and implementing the Serializable interface, it ensures that objects of its kind can be serialized into a stream of bytes. Notable direct subclasses include MWCellArray and MWStructArray, which specialize the behavior and characteristics of this base class to align more closely with MATLAB's native cell and struct array data types, respectively.

Implemented Interfaces: java.io.Serializable

Direct Known Subclasses: MWCellArray, MWStructArray

Class Attributes

Abstract

true

Creation

Constructors

protected  MWArray() 
protected  MWArray(int[] inDims) 
protected  MWArray(int rows, int cols)

These constructors are protected, which means you can't use them directly from outside classes unless you're extending the MWArray class. If you're trying to create instances of MWArray or its subclasses, you'll typically use public static methods or constructors provided by those subclasses.

Properties

Public Properties

flatArray — Flattened representation of multidimensional array

protected java.lang.Object[]

The flatArray field provides a linear, or "flattened," representation of multi-dimensional array data. It consists of an array of objects that are protected.

Methods

Public Methods

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
get	public java.lang.Object get(int index) Returns the element at the specified 1-based offset in this 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. Returns: Object containing the requested element.
getData	public java.lang.Object getData() Returns a 1-D array containing a copy of the data in the underlying MATLAB array. Returns: 1-D array containing a copy of the data
getDimensions	public int[] getDimensions() Returns an array containing the size of each dimension of this array. Returns: array containing the size of each dimension
getDimsStr	protected java.lang.String getDimsStr()
getMaxValidIndex	protected int getMaxValidIndex()
getOneBasedIndexForArray	protected int getOneBasedIndexForArray(int[] index)
hashCode	public int hashCode() This method returns a hash of the object. Overrides: hashCode in class java.lang.Object Returns: hash of the object
initNativeArray	protected void initNativeArray(int num)
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
numberOfDimensions	public int numberOfDimensions() Returns the number of dimensions of the array. Returns: Number of dimensions
numberOfElements	public int numberOfElements() Returns the total number of elements in this array. Returns: total number of elements
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.
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.
setMaxValidIndex	protected void setMaxValidIndex(int idx)
toString	public abstract java.lang.String toString() Overrides: toString in class java.lang.Object

Examples

More About

Inheritance Hierarchy

Version History

Introduced in R2006a