MWFunctionHandle

java.lang.Object
- com.mathworks.toolbox.javabuilder.MWArray
- - com.mathworks.toolbox.javabuilder.MWMatrixRef
  - - com.mathworks.toolbox.javabuilder.MWFunctionHandle

All Implemented Interfaces:

Disposable, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable
```
public class MWFunctionHandle
extends MWMatrixRef
```
The MWFunctionHandle class represents a MATLAB function handle.

Since:

2.0

See Also:

Serialized Form

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

Method Summary

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

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

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

- Method Detail
  - clone
```
public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
```
    Creates and returns a deep copy of this array. Changing the data in a deep copy does not change the original array.
    
    Overrides:
    
    clone in class MWMatrixRef
    
    Returns:
    
    An MWFunctionHandle instance representing a deep copy of the underlying MATLAB array.
    
    Throws:
    
    java.lang.CloneNotSupportedException - - The object's class does not implement the Cloneable interface.
  - sharedCopy
```
public java.lang.Object sharedCopy()
```
    Creates and returns a shared copy of this array.
    
    Overrides:
    
    sharedCopy in class MWMatrixRef
    
    Returns:
    
    An MWFunctionHandle instance representing a shared copy of the underlying MATLAB array.
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Indicates whether some other array is equal to this one.
    
    Overrides:
    
    equals in class MWMatrixRef
    
    Parameters:
    
    obj - Object Array to compare with this MWArray object
  - hashCode
```
public int hashCode()
```
    Returns a hash code value for this array.
    
    Overrides:
    
    hashCode in class MWMatrixRef
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this array.
    
    Overrides:
    
    toString in class MWMatrixRef
  - numberOfElements
```
public int numberOfElements()
```
    Returns the total number of elements in this array.
    
    Overrides:
    
    numberOfElements in class MWMatrixRef
    
    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().
    
    Overrides:
    
    numberOfNonZeros in class MWMatrixRef
    
    Returns:
    
    Current number of non-zero elements in a sparse array.
  - maximumNonZeros
```
public int maximumNonZeros()
```
    Returns the allocated capacity of a sparse array. If the underlying array is non-sparse, this method returns the same value as numberOfElements().
    
    Overrides:
    
    maximumNonZeros in class MWMatrixRef
    
    Returns:
    
    Currently allocated number of non-zero elements in a sparse array.
  - classID
```
public MWClassID classID()
```
    Returns the MATLAB type of this array.
    
    Overrides:
    
    classID in class MWMatrixRef
    
    Returns:
    
    MWClassID of this array
  - 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.
    
    Overrides:
    
    toArray in class MWMatrixRef
    
    Returns:
    
    An array with the same dimensionality of the MATLAB array.
  - numberOfDimensions
```
public int numberOfDimensions()
```
    Returns the number of dimensions of this array.
    
    Overrides:
    
    numberOfDimensions in class MWMatrixRef
    
    Returns:
    
    number of dimensions
  - getDimensions
```
public int[] getDimensions()
```
    Returns an array containing the size of each dimension of this array.
    
    Overrides:
    
    getDimensions in class MWMatrixRef
    
    Returns:
    
    array containing size of each dimension
  - isEmpty
```
public boolean isEmpty()
```
    Tests if this array has no elements.
    
    Overrides:
    
    isEmpty in class MWMatrixRef
    
    Returns:
    
    true if empty, false otherwise
  - isSparse
```
public boolean isSparse()
```
    Tests if this array is sparse.
    
    Overrides:
    
    isSparse in class MWMatrixRef
    
    Returns:
    
    true if sparse, false otherwise
  - 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
    
    Overrides:
    
    compareTo in class MWMatrixRef
    
    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.
    
    Overrides:
    
    get in class MWMatrixRef
    
    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.
    
    Overrides:
    
    get in class MWMatrixRef
    
    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 element)
```
    Replaces the element at the specified 1-based offset in this array with the specified element.
    
    Overrides:
    
    set in class MWMatrixRef
    
    Parameters:
    
    index - The index of the element to replace. Valid range: 1 <= index <= N, where N = total number of elements in the array.
    
    element - New element to replace at index.
  - set
```
public void set(int[] index,
                java.lang.Object element)
```
    Replaces the element at the specified 1-based index-array in this array with the specified element.
    
    Overrides:
    
    set in class MWMatrixRef
    
    Parameters:
    
    index - Array of indices specifying the location of the element to replace. The length of the index array must be exactly the number of dimensions of this array. Each element of the index array has the valid range: 1 <= index[i] <= N[i], where N[i] = the size of the ith dimension.
    
    element - New element to replace at index.
  - 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.
    
    Overrides:
    
    getData in class MWMatrixRef
    
    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.
  - setData
```
public void setData(java.lang.Object data)
```
    Overrides:
    
    setData in class MWMatrixRef
  - rowIndex
```
public int[] rowIndex()
```
    Returns an array containing the row index of each element in the underlying MATLAB array.
    
    Overrides:
    
    rowIndex in class MWMatrixRef
    
    Returns:
    
    Array of indices.
  - columnIndex
```
public int[] columnIndex()
```
    Returns an array containing the column index of each element in the underlying MATLAB array.
    
    Overrides:
    
    columnIndex in class MWMatrixRef
    
    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.
  - 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
  - applyVisitor
```
public <T> T applyVisitor(AbstractMWArrayVisitor<T> v)
```
    Specified by:
    
    applyVisitor in class MWArray
  - validate
```
protected void validate()
```
    Validates the internal array handle. Called by constructors and deserialization code.
  - readResolve
```
protected java.lang.Object readResolve()
                                throws java.io.ObjectStreamException
```
    Called by serialization mechanism when loading a new array from a byte stream. This method validates the correct array type.
    
    Returns:
    
    Returns this Object indicating validated array type.
    
    Throws:
    
    java.io.InvalidObjectException - Attempt to load an invalid array handle.
    
    java.io.ObjectStreamException

Class MWFunctionHandle

Field Summary

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

Method Summary

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

Methods inherited from class java.lang.Object

Method Detail

clone

sharedCopy

equals

hashCode

toString

numberOfElements

numberOfNonZeros

maximumNonZeros

classID

toArray

numberOfDimensions

getDimensions

isEmpty

isSparse

compareTo

get

get

set

set

getData

setData

rowIndex

columnIndex

serialize

deserialize

dispose

applyVisitor

validate

readResolve