org.ujmp.core.objectmatrix.calculation
Interface ObjectCalculations

All Known Subinterfaces:
BigDecimalMatrix, BigDecimalMatrix2D, BigIntegerMatrix, BigIntegerMatrix2D, BooleanMatrix, BooleanMatrix2D, ByteMatrix, ByteMatrix2D, CanPerformCalculations, CharMatrix, CharMatrix2D, DateMatrix, DateMatrix2D, DenseBigDecimalMatrix, DenseBigDecimalMatrix2D, DenseBigIntegerMatrix, DenseBigIntegerMatrix2D, DenseBooleanMatrix, DenseBooleanMatrix2D, DenseByteMatrix, DenseByteMatrix2D, DenseCharMatrix, DenseCharMatrix2D, DenseDateMatrix, DenseDateMatrix2D, DenseDoubleMatrix, DenseDoubleMatrix2D, DenseFloatMatrix, DenseFloatMatrix2D, DenseGenericMatrix<A>, DenseGenericMatrix2D<A>, DenseIntMatrix, DenseIntMatrix2D, DenseLongMatrix, DenseLongMatrix2D, DenseMatrix, DenseMatrix2D, DenseObjectMatrix, DenseObjectMatrix2D, DenseShortMatrix, DenseShortMatrix2D, DenseStringMatrix, DenseStringMatrix2D, DoubleMatrix, DoubleMatrix2D, FloatMatrix, FloatMatrix2D, GenericMatrix<A>, GenericMatrix2D<A>, GraphMatrix<N,E>, IntMatrix, IntMatrix2D, ListMatrix<A>, LongMatrix, LongMatrix2D, MapMatrix<K,V>, Matrix, Matrix2D, ObjectMatrix, ObjectMatrix2D, SetMatrix<A>, ShortMatrix, ShortMatrix2D, SparseBigDecimalMatrix, SparseBigDecimalMatrix2D, SparseBigIntegerMatrix, SparseBigIntegerMatrix2D, SparseBooleanMatrix, SparseBooleanMatrix2D, SparseByteMatrix, SparseByteMatrix2D, SparseCharMatrix, SparseCharMatrix2D, SparseDateMatrix, SparseDateMatrix2D, SparseDoubleMatrix, SparseDoubleMatrix2D, SparseFloatMatrix, SparseFloatMatrix2D, SparseGenericMatrix<A>, SparseGenericMatrix2D<A>, SparseIntMatrix, SparseIntMatrix2D, SparseLongMatrix, SparseLongMatrix2D, SparseMatrix, SparseMatrix2D, SparseObjectMatrix, SparseObjectMatrix2D, SparseShortMatrix, SparseShortMatrix2D, SparseStringMatrix, SparseStringMatrix2D, StringMatrix, StringMatrix2D, TreeMatrix
All Known Implementing Classes:
AbstractBigDecimalMatrix, AbstractBigIntegerMatrix, AbstractBooleanMatrix, AbstractByteMatrix, AbstractCharMatrix, AbstractDateMatrix, AbstractDenseBigDecimalMatrix, AbstractDenseBigDecimalMatrix2D, AbstractDenseBigIntegerMatrix, AbstractDenseBigIntegerMatrix2D, AbstractDenseBooleanMatrix, AbstractDenseBooleanMatrix2D, AbstractDenseByteMatrix, AbstractDenseByteMatrix2D, AbstractDenseCharMatrix, AbstractDenseCharMatrix2D, AbstractDenseDateMatrix, AbstractDenseDateMatrix2D, AbstractDenseDoubleMatrix, AbstractDenseDoubleMatrix2D, AbstractDenseFloatMatrix, AbstractDenseFloatMatrix2D, AbstractDenseGenericMatrix, AbstractDenseGenericMatrix2D, AbstractDenseIntMatrix, AbstractDenseIntMatrix2D, AbstractDenseLongMatrix, AbstractDenseLongMatrix2D, AbstractDenseObjectMatrix, AbstractDenseObjectMatrix2D, AbstractDenseShortMatrix, AbstractDenseShortMatrix2D, AbstractDenseStringMatrix, AbstractDenseStringMatrix2D, AbstractDoubleMatrix, AbstractFloatMatrix, AbstractGenericMatrix, AbstractGraphMatrix, AbstractIntMatrix, AbstractListMatrix, AbstractLongMatrix, AbstractMapMatrix, AbstractMapToSparseMatrixWrapper, AbstractMapToTiledMatrix2DWrapper, AbstractMatrix, AbstractObjectMatrix, AbstractSetMatrix, AbstractShortMatrix, AbstractSparseBigDecimalMatrix, AbstractSparseBigDecimalMatrix2D, AbstractSparseBigIntegerMatrix, AbstractSparseBigIntegerMatrix2D, AbstractSparseBooleanMatrix, AbstractSparseBooleanMatrix2D, AbstractSparseByteMatrix, AbstractSparseByteMatrix2D, AbstractSparseCharMatrix, AbstractSparseCharMatrix2D, AbstractSparseDateMatrix, AbstractSparseDateMatrix2D, AbstractSparseDoubleMatrix, AbstractSparseDoubleMatrix2D, AbstractSparseFloatMatrix, AbstractSparseFloatMatrix2D, AbstractSparseGenericMatrix, AbstractSparseGenericMatrix2D, AbstractSparseIntMatrix, AbstractSparseIntMatrix2D, AbstractSparseLongMatrix, AbstractSparseLongMatrix2D, AbstractSparseObjectMatrix, AbstractSparseObjectMatrix2D, AbstractSparseShortMatrix, AbstractSparseShortMatrix2D, AbstractSparseStringMatrix, AbstractSparseStringMatrix2D, AbstractStringMatrix, AbstractTreeMatrix, ArrayDenseBigDecimalMatrix2D, ArrayDenseBigIntegerMatrix2D, ArrayDenseByteMatrix2D, ArrayDenseCharMatrix2D, ArrayDenseDoubleMatrix2D, ArrayDenseFloatMatrix2D, BenchmarkConfig, BigDecimalCalculationMatrix, BigIntegerCalculationMatrix, BlockDenseDoubleMatrix2D, BooleanCalculationMatrix, BufferedObjectMatrix, ByteCalculationMatrix, CharCalculationMatrix, CSVMatrix, DateCalculationMatrix, DefaultDenseBigDecimalMatrix2D, DefaultDenseBigIntegerMatrix2D, DefaultDenseBooleanMatrix2D, DefaultDenseByteMatrix2D, DefaultDenseCharMatrix2D, DefaultDenseDateMatrix2D, DefaultDenseDoubleMatrix2D, DefaultDenseDoubleMatrixMultiD, DefaultDenseFloatMatrix2D, DefaultDenseGenericMatrix2D, DefaultDenseIntMatrix2D, DefaultDenseLongMatrix2D, DefaultDenseObjectMatrix2D, DefaultDenseObjectMatrixMultiD, DefaultDenseShortMatrix2D, DefaultDenseStringMatrix2D, DefaultGraphMatrix, DefaultListMatrix, DefaultMapMatrix, DefaultSetMatrix, DefaultSparseBigDecimalMatrix, DefaultSparseBigIntegerMatrix, DefaultSparseBooleanMatrix, DefaultSparseByteMatrix, DefaultSparseCharMatrix, DefaultSparseColumnObjectMatrix2D, DefaultSparseDateMatrix, DefaultSparseDoubleMatrix, DefaultSparseFloatMatrix, DefaultSparseGenericMatrix, DefaultSparseIntMatrix, DefaultSparseLongMatrix, DefaultSparseObjectMatrix, DefaultSparseRowDoubleMatrix2D, DefaultSparseRowObjectMatrix2D, DefaultSparseShortMatrix, DefaultSparseStringMatrix, DefaultTiledObjectMatrix2D, DefaultTreeMatrix, DenseFileMatrix, DoubleCalculationMatrix, EmptyMatrix, FileFormatMatrix, FileListMatrix, FileMatrix, FloatCalculationMatrix, ImageMatrix, IntCalculationMatrix, IrisMatrix, LongCalculationMatrix, MatrixAvailableProcessors, MatrixLibraries, MatrixMemoryUsage, MatrixRandomSeed, MatrixRunningThreads, MatrixSystemEnvironment, MatrixSystemProperties, MatrixSystemTime, MortonDenseDoubleMartrix2D, ObjectCalculationMatrix, ObjectTreeMatrix, RemoteObjectMatrixUDP, SerializedSparseObjectMatrix, ServerObjectMatrixUDP, ShortCalculationMatrix, SimpleDenseDateMatrix2D, SimpleDenseIntMatrix2D, SimpleDenseLongMatrix2D, SimpleDenseObjectMatrix2D, SimpleDenseShortMatrix2D, SimpleDenseStringMatrix2D, SparseCSVMatrix, StringCalculationMatrix, SynchronizedGenericMatrix, TimeSeriesMatrix, UJMPPluginsMatrix, VolatileSparseObjectMatrix, WaveMatrix, WelcomeMatrix

public interface ObjectCalculations


Method Summary
 Matrix bootstrap(Calculation.Ret returnType)
           
 Matrix bootstrap(Calculation.Ret returnType, int count)
           
 Matrix convert(ValueType newValueType)
          Creates a copy of the matrix with the desired type for matrix entries.
 Matrix copy()
          Deprecated. Please do not use this method anymore, it will be removed. use matrix.clone() instead
 Matrix delete(Calculation.Ret returnType, Collection<? extends Number>... selection)
          Delete rows and columns in the Matrix and returns a link to it.
 Matrix delete(Calculation.Ret returnType, long[]... selection)
          Delete rows and columns in the Matrix and returns a link to it.
 Matrix delete(Calculation.Ret returnType, String selection)
          Deletes rows and columns in the Matrix and returns a link to it.
 Matrix deleteColumns(Calculation.Ret returnType, Collection<? extends Number> columns)
          Deletes columns in the Matrix and returns a link to it.
 Matrix deleteColumns(Calculation.Ret returnType, long... colums)
          Deletes columns in the Matrix and returns a link to it.
 Matrix deleteRows(Calculation.Ret returnType, Collection<? extends Number> rows)
          Deletes rows in the Matrix and returns a link to it.
 Matrix deleteRows(Calculation.Ret returnType, long... rows)
          Deletes rows in the Matrix and returns a link to it.
 Matrix extractAnnotation(Calculation.Ret returnType, int dimension)
          Generates annotation such as row or column labels from the content of this matrix.
 Matrix fill(Calculation.Ret ret, Object value)
          Returns a matrix with equal size, where all entries are set to a desired value.
 Matrix flipdim(Calculation.Ret returnType, int dimension)
           
 Matrix includeAnnotation(Calculation.Ret returnType, int dimension)
           
 Matrix replace(Calculation.Ret returnType, Object search, Object replacement)
          Replaces matching values in the matrix with another value
 Matrix reshape(Calculation.Ret returnType, long... newSize)
           
 Matrix select(Calculation.Ret returnType, Collection<? extends Number>... selection)
          Selects rows and columns in the Matrix and returns a link to it.
 Matrix select(Calculation.Ret returnType, long[]... selection)
          Selects rows and columns in the Matrix and returns a link to it.
 Matrix select(Calculation.Ret returnType, String selection)
          Selects rows and columns in the Matrix and returns a link to it.
 Matrix selectColumns(Calculation.Ret returnType, Collection<? extends Number> columns)
          Selects columns in the Matrix and returns a link to it.
 Matrix selectColumns(Calculation.Ret returnType, long... colums)
          Selects columns in the Matrix and returns a link to it.
 Matrix selectRows(Calculation.Ret returnType, Collection<? extends Number> rows)
          Selects rows in the Matrix and returns a link to it.
 Matrix selectRows(Calculation.Ret returnType, long... rows)
          Selects rows in the Matrix and returns a link to it.
 Matrix shuffle(Calculation.Ret returnType)
           
 Matrix sortrows(Calculation.Ret returnType, long column, boolean reverse)
           
 Matrix squeeze(Calculation.Ret returnType)
           
 Matrix subMatrix(Calculation.Ret returnType, long startRow, long startColumn, long endRow, long endColumn)
           
 Matrix swap(Calculation.Ret returnType, int dimension, long pos1, long pos2)
           
 Matrix toColumnVector(Calculation.Ret returnType)
           
 Matrix toRowVector(Calculation.Ret returnType)
           
 Matrix transpose()
          Returns the transpose of the Matrix, where rows and columns are exchanged.
 Matrix transpose(Calculation.Ret returnType)
          Returns the transpose of the Matrix, where rows and columns are exchanged.
 Matrix transpose(Calculation.Ret returnType, int dimension1, int dimension2)
           
 Matrix tril(Calculation.Ret returnType, int k)
           
 Matrix triu(Calculation.Ret returnType, int k)
           
 Matrix unique(Calculation.Ret returnType)
           
 Matrix uniqueValueCount(Calculation.Ret returnType, int dimension)
           
 

Method Detail

sortrows

Matrix sortrows(Calculation.Ret returnType,
                long column,
                boolean reverse)
                throws MatrixException
Throws:
MatrixException

shuffle

Matrix shuffle(Calculation.Ret returnType)
               throws MatrixException
Throws:
MatrixException

bootstrap

Matrix bootstrap(Calculation.Ret returnType)
                 throws MatrixException
Throws:
MatrixException

bootstrap

Matrix bootstrap(Calculation.Ret returnType,
                 int count)
                 throws MatrixException
Throws:
MatrixException

extractAnnotation

Matrix extractAnnotation(Calculation.Ret returnType,
                         int dimension)
                         throws MatrixException
Generates annotation such as row or column labels from the content of this matrix. This is useful for example for data imported from CSV files with labels in the first line.

Parameters:
returnType - Specify whether to return a new matrix, or a link
dimension - Which axis should be shortened to extract the labels. E.g. if you want column labels, you must specify Matrix.ROW, which does not seem very intuitive at first glance. However, if you're dealing with multi-dimensional data, this becomes more clear. If you want annotation generated for all dimensions, you can specify Matrix.ALL or omit the dimensions parameter.
Returns:
new Matrix with annotation generated from content.
Throws:
MatrixException

includeAnnotation

Matrix includeAnnotation(Calculation.Ret returnType,
                         int dimension)
                         throws MatrixException
Throws:
MatrixException

reshape

Matrix reshape(Calculation.Ret returnType,
               long... newSize)
               throws MatrixException
Throws:
MatrixException

squeeze

Matrix squeeze(Calculation.Ret returnType)
               throws MatrixException
Throws:
MatrixException

unique

Matrix unique(Calculation.Ret returnType)
              throws MatrixException
Throws:
MatrixException

uniqueValueCount

Matrix uniqueValueCount(Calculation.Ret returnType,
                        int dimension)
                        throws MatrixException
Throws:
MatrixException

tril

Matrix tril(Calculation.Ret returnType,
            int k)
            throws MatrixException
Throws:
MatrixException

triu

Matrix triu(Calculation.Ret returnType,
            int k)
            throws MatrixException
Throws:
MatrixException

toColumnVector

Matrix toColumnVector(Calculation.Ret returnType)
                      throws MatrixException
Throws:
MatrixException

toRowVector

Matrix toRowVector(Calculation.Ret returnType)
                   throws MatrixException
Throws:
MatrixException

swap

Matrix swap(Calculation.Ret returnType,
            int dimension,
            long pos1,
            long pos2)

fill

Matrix fill(Calculation.Ret ret,
            Object value)
            throws MatrixException
Returns a matrix with equal size, where all entries are set to a desired value.

Parameters:
value - fill with this value
Returns:
Matrix with ones.
Throws:
MatrixException

replace

Matrix replace(Calculation.Ret returnType,
               Object search,
               Object replacement)
               throws MatrixException
Replaces matching values in the matrix with another value

Parameters:
returnType - Select whether a new or a linked Matrix is returned, or if the operation is performed on the original Matrix
search - Object to search for
replacement - Object used to replace the original value
Returns:
matrix with modified entries
Throws:
MatrixException

transpose

Matrix transpose()
                 throws MatrixException
Returns the transpose of the Matrix, where rows and columns are exchanged. This works also if the Matrix has more than two dimensions.

Returns:
transposed Matrix.
Throws:
MatrixException

transpose

Matrix transpose(Calculation.Ret returnType)
                 throws MatrixException
Returns the transpose of the Matrix, where rows and columns are exchanged. This works also if the Matrix has more than two dimensions.

Parameters:
returnType - Defines if a new Matrix or a link should be returned.
Returns:
transposed Matrix.
Throws:
MatrixException

transpose

Matrix transpose(Calculation.Ret returnType,
                 int dimension1,
                 int dimension2)
                 throws MatrixException
Throws:
MatrixException

flipdim

Matrix flipdim(Calculation.Ret returnType,
               int dimension)

copy

Matrix copy()
            throws MatrixException
Deprecated. Please do not use this method anymore, it will be removed. use matrix.clone() instead

Throws:
MatrixException

convert

Matrix convert(ValueType newValueType)
               throws MatrixException
Creates a copy of the matrix with the desired type for matrix entries.

Parameters:
newValueType - defines the new format of the matrix
Returns:
Matrix with the same entries in the new format
Throws:
MatrixException

select

Matrix select(Calculation.Ret returnType,
              long[]... selection)
              throws MatrixException
Selects rows and columns in the Matrix and returns a link to it.

Parameters:
returnType - Defines if a new Matrix or a link should be returned.
selection - selected rows and columns
Returns:
Link to original Matrix with desired rows and columns
Throws:
MatrixException

delete

Matrix delete(Calculation.Ret returnType,
              long[]... selection)
              throws MatrixException
Delete rows and columns in the Matrix and returns a link to it.

Parameters:
returnType - Defines if a new Matrix or a link should be returned.
selection - selected rows and columns
Returns:
Link to original Matrix with desired rows and columns
Throws:
MatrixException

select

Matrix select(Calculation.Ret returnType,
              Collection<? extends Number>... selection)
              throws MatrixException
Selects rows and columns in the Matrix and returns a link to it.

Parameters:
returnType - Defines if a new Matrix or a link should be returned.
selection - selected rows and columns
Returns:
Link to original Matrix with desired rows and columns
Throws:
MatrixException

delete

Matrix delete(Calculation.Ret returnType,
              Collection<? extends Number>... selection)
              throws MatrixException
Delete rows and columns in the Matrix and returns a link to it.

Parameters:
returnType - Defines if a new Matrix or a link should be returned.
selection - selected rows and columns
Returns:
Link to original Matrix with desired rows and columns
Throws:
MatrixException

selectRows

Matrix selectRows(Calculation.Ret returnType,
                  long... rows)
                  throws MatrixException
Selects rows in the Matrix and returns a link to it.

Parameters:
returnType - Defines if a new Matrix or a link should be returned.
rows - selected rows
Returns:
Link to original Matrix with desired rows
Throws:
MatrixException

deleteRows

Matrix deleteRows(Calculation.Ret returnType,
                  long... rows)
                  throws MatrixException
Deletes rows in the Matrix and returns a link to it.

Parameters:
returnType - Defines if a new Matrix or a link should be returned.
rows - selected rows
Returns:
Link to original Matrix with desired rows
Throws:
MatrixException

selectRows

Matrix selectRows(Calculation.Ret returnType,
                  Collection<? extends Number> rows)
                  throws MatrixException
Selects rows in the Matrix and returns a link to it.

Parameters:
returnType - Defines if a new Matrix or a link should be returned.
rows - selected rows
Returns:
Link to original Matrix with desired rows
Throws:
MatrixException

deleteRows

Matrix deleteRows(Calculation.Ret returnType,
                  Collection<? extends Number> rows)
                  throws MatrixException
Deletes rows in the Matrix and returns a link to it.

Parameters:
returnType - Defines if a new Matrix or a link should be returned.
rows - selected rows
Returns:
Link to original Matrix with desired rows
Throws:
MatrixException

selectColumns

Matrix selectColumns(Calculation.Ret returnType,
                     long... colums)
                     throws MatrixException
Selects columns in the Matrix and returns a link to it.

Parameters:
returnType - Defines if a new Matrix or a link should be returned.
columns - selected columns
Returns:
Link to original Matrix with desired columns
Throws:
MatrixException

deleteColumns

Matrix deleteColumns(Calculation.Ret returnType,
                     long... colums)
                     throws MatrixException
Deletes columns in the Matrix and returns a link to it.

Parameters:
returnType - Defines if a new Matrix or a link should be returned.
columns - selected columns
Returns:
Link to original Matrix with desired columns
Throws:
MatrixException

selectColumns

Matrix selectColumns(Calculation.Ret returnType,
                     Collection<? extends Number> columns)
                     throws MatrixException
Selects columns in the Matrix and returns a link to it.

Parameters:
returnType - Defines if a new Matrix or a link should be returned.
columns - selected columns
Returns:
Link to original Matrix with desired columns
Throws:
MatrixException

deleteColumns

Matrix deleteColumns(Calculation.Ret returnType,
                     Collection<? extends Number> columns)
                     throws MatrixException
Deletes columns in the Matrix and returns a link to it.

Parameters:
returnType - Defines if a new Matrix or a link should be returned.
columns - selected columns
Returns:
Link to original Matrix with desired columns
Throws:
MatrixException

select

Matrix select(Calculation.Ret returnType,
              String selection)
              throws MatrixException
Selects rows and columns in the Matrix and returns a link to it. Selections can be made in Matlab/Octave style or similar, e.g. "1,2,5-6,8:5;*". Dimensions are separated by ';'. Selections in one dimension are separated by spaces or ','. Ranges are selected using '-' or ':'. A whole dimension can be selected with '*'.

Parameters:
returnType - Defines if a new Matrix or a link should be returned.
selection - String defining the selection
Returns:
Link to original Matrix with desired rows and columns
Throws:
MatrixException

delete

Matrix delete(Calculation.Ret returnType,
              String selection)
              throws MatrixException
Deletes rows and columns in the Matrix and returns a link to it. Selections can be made in Matlab/Octave style or similar, e.g. "1,2,5-6,8:5;*". Dimensions are separated by ';'. Selections in one dimension are separated by spaces or ','. Ranges are selected using '-' or ':'. A whole dimension can be selected with '*'.

Parameters:
returnType - Defines if a new Matrix or a link should be returned.
selection - String defining the selection
Returns:
Link to original Matrix with desired rows and columns deleted
Throws:
MatrixException

subMatrix

Matrix subMatrix(Calculation.Ret returnType,
                 long startRow,
                 long startColumn,
                 long endRow,
                 long endColumn)
                 throws MatrixException
Throws:
MatrixException


Copyright © 2010. All Rights Reserved.