MLSparse

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.jmatio.types
Class MLSparse

java.lang.Object
  com.jmatio.types.MLArray
      com.jmatio.types.MLNumericArray<Double>
          com.jmatio.types.MLSparse

All Implemented Interfaces:: GenericArrayCreator<Double>

public class MLSparse
extends MLNumericArray<Double>
extends MLNumericArray<Double>

Field Summary

Fields inherited from class com.jmatio.types.MLArray
`attributes, dims, mtFLAG_COMPLEX, mtFLAG_GLOBAL, mtFLAG_LOGICAL, mtFLAG_TYPE, mxCELL_CLASS, mxCHAR_CLASS, mxDOUBLE_CLASS, mxFUNCTION_CLASS, mxINT16_CLASS, mxINT32_CLASS, mxINT64_CLASS, mxINT8_CLASS, mxOBJECT_CLASS, mxOPAQUE_CLASS, mxSINGLE_CLASS, mxSPARSE_CLASS, mxSTRUCT_CLASS, mxUINT16_CLASS, mxUINT32_CLASS, mxUINT64_CLASS, mxUINT8_CLASS, mxUNKNOWN_CLASS, name, type`

Constructor Summary
`MLSparse(String name, int[] dims, int attributes, int nzmax)`

Method Summary
`String`	`contentToString()`
`Double[]`	`createArray(int m, int n)`
`Double[]`	`exportImaginary()` Exports column-packed vector of imaginary elements
`Double[]`	`exportReal()` Exports column-packed vector of real elements
`Double`	`getImaginary(int m, int n)` Gets single imaginary array element of A(m,n).
`int[]`	`getIR()` Gets row indices `ir` points to an integer array of length nzmax containing the row indices of the corresponding elements in `pr` and `pi`.
`int[]`	`getJC()` Gets collumn indices.
`int`	`getMaxNZ()` Gets maximum number of non-zero values
`Double`	`getReal(int m, int n)` Gets single real array element of A(m,n).
`void`	`setImaginary(Double value, int index)` Sets single real array element.
`void`	`setImaginary(Double value, int m, int n)` Sets single imaginary array element.
`void`	`setReal(Double value, int index)` Sets single real array element.
`void`	`setReal(Double value, int m, int n)` Sets single real array element.

Methods inherited from class com.jmatio.types.MLNumericArray
`equals, get, get, set, set, set, setReal`

Methods inherited from class com.jmatio.types.MLArray
`getDimensions, getFlags, getIndex, getM, getN, getName, getNameToByteArray, getNDimensions, getSize, getType, isCell, isChar, isComplex, isDouble, isEmpty, isFunctionObject, isInt16, isInt32, isInt64, isInt8, isLogical, isObject, isOpaque, isSingle, isSparse, isStruct, isUint16, isUint32, isUint64, isUint8, isUnknown, toString, typeToString`

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

Constructor Detail

MLSparse

public MLSparse(String name,
                int[] dims,
                int attributes,
                int nzmax)

Method Detail

getMaxNZ

public int getMaxNZ()

Gets maximum number of non-zero values

getIR

public int[] getIR()

Gets row indices ir points to an integer array of length nzmax containing the row indices of the corresponding elements in pr and pi.

getJC

public int[] getJC()

Gets collumn indices. jc points to an integer array of length N+1 that contains column index information. For j, in the range 0<=j<=N???1, jc[j] is the index in ir and pr (and pi if it exists) of the first nonzero entry in the jth column and jc[j+1]???1 index of the last nonzero entry. As a result, jc[N] is also equal to nnz, the number of nonzero entries in the matrix. If nnz is less than nzmax, then more nonzero entries can be inserted in the array without allocating additional storage