Interface CoordinateFunctions

All Known Subinterfaces:
BaseBigDecimalMatrix, BaseBigIntegerMatrix, BaseBooleanMatrix, BaseDoubleMatrix, BaseGenericMatrix<T>, BaseNumberMatrix<T>, BaseObjectMatrix, BigDecimalMatrix, BigDecimalMatrix2D, BigDecimalMatrixMultiD, BigIntegerMatrix, BigIntegerMatrix2D, BigIntegerMatrixMultiD, BooleanMatrix, BooleanMatrix2D, ByteArrayMatrix, ByteArrayMatrix2D, ByteMatrix, ByteMatrix2D, CharMatrix, CharMatrix2D, DenseBigDecimalMatrix, DenseBigDecimalMatrix2D, DenseBigDecimalMatrixMultiD, DenseBigIntegerMatrix, DenseBigIntegerMatrix2D, DenseBooleanMatrix, DenseBooleanMatrix2D, DenseByteArrayMatrix, DenseByteArrayMatrix2D, DenseByteMatrix, DenseByteMatrix2D, DenseCharMatrix, DenseCharMatrix2D, DenseDoubleMatrix, DenseDoubleMatrix2D, DenseDoubleMatrixMultiD, DenseFloatMatrix, DenseFloatMatrix2D, DenseGenericMatrix<T>, DenseGenericMatrix2D<T>, DenseGenericMatrixMultiD<T>, DenseIntMatrix, DenseIntMatrix2D, DenseLongMatrix, DenseLongMatrix2D, DenseMatrix, DenseMatrix2D, DenseMatrixMultiD, DenseNumberMatrix<T>, DenseNumberMatrix2D<T>, DenseNumberMatrixMultiD<T>, DenseObjectMatrix, DenseObjectMatrix2D, DenseObjectMatrixMultiD, DenseShortMatrix, DenseShortMatrix2D, DenseStringMatrix, DenseStringMatrix2D, DoubleMatrix, DoubleMatrix2D, DoubleMatrixMultiD, FileOrDirectoryMatrix, FloatMatrix, FloatMatrix2D, GenericMatrix<T>, GenericMatrix2D<T>, GenericMatrixMultiD<T>, GraphMatrix<N,E>, IntMatrix, IntMatrix2D, ListMatrix<T>, LongMatrix, LongMatrix2D, MapMatrix<K,V>, Matrix, Matrix2D, MatrixMultiD, NumberMatrix<T>, NumberMatrix2D<T>, NumberMatrixMultiD<T>, ObjectMatrix, ObjectMatrix2D, ObjectMatrixMultiD, SetMatrix<A>, ShortMatrix, ShortMatrix2D, SparseBigDecimalMatrix, SparseBigDecimalMatrix2D, SparseBigDecimalMatrixMultiD, SparseBigIntegerMatrix, SparseBigIntegerMatrix2D, SparseBooleanMatrix, SparseBooleanMatrix2D, SparseByteArrayMatrix, SparseByteArrayMatrix2D, SparseByteMatrix, SparseByteMatrix2D, SparseCharMatrix, SparseCharMatrix2D, SparseDoubleMatrix, SparseDoubleMatrix2D, SparseDoubleMatrixMultiD, SparseFloatMatrix, SparseFloatMatrix2D, SparseGenericMatrix<T>, SparseGenericMatrix2D<T>, SparseGenericMatrixMultiD<T>, SparseIntMatrix, SparseIntMatrix2D, SparseLongMatrix, SparseLongMatrix2D, SparseMatrix, SparseMatrix2D, SparseMatrixMultiD, SparseNumberMatrix<T>, SparseNumberMatrix2D<T>, SparseNumberMatrixMultiD<T>, SparseObjectMatrix, SparseObjectMatrix2D, SparseObjectMatrixMultiD, SparseShortMatrix, SparseShortMatrix2D, SparseStringMatrix, SparseStringMatrix2D, StringMatrix, StringMatrix2D, TextBlock, TextSentence, TextToken, TreeMatrix<T>
All Known Implementing Classes:
AbstractBigDecimalMatrix, AbstractBigIntegerMatrix, AbstractBooleanMatrix, AbstractByteArrayMatrix, AbstractByteMatrix, AbstractCharMatrix, AbstractCommonsMathDenseDoubleMatrix2D, AbstractDenseBigDecimalMatrix, AbstractDenseBigDecimalMatrix2D, AbstractDenseBigIntegerMatrix, AbstractDenseBigIntegerMatrix2D, AbstractDenseBooleanMatrix, AbstractDenseBooleanMatrix2D, AbstractDenseByteArrayMatrix, AbstractDenseByteArrayMatrix2D, AbstractDenseByteMatrix, AbstractDenseByteMatrix2D, AbstractDenseCharMatrix, AbstractDenseCharMatrix2D, AbstractDenseDoubleMatrix2D, AbstractDenseDoubleMatrixMultiD, AbstractDenseFloatMatrix, AbstractDenseFloatMatrix2D, AbstractDenseGenericMatrix, AbstractDenseGenericMatrix2D, AbstractDenseIntMatrix, AbstractDenseIntMatrix2D, AbstractDenseJDBCMatrix2D, AbstractDenseLongMatrix, AbstractDenseLongMatrix2D, AbstractDenseObjectMatrix, AbstractDenseObjectMatrix2D, AbstractDenseShortMatrix, AbstractDenseShortMatrix2D, AbstractDenseStringMatrix, AbstractDenseStringMatrix2D, AbstractDoubleMatrix, AbstractDoubleMatrix2D, AbstractDoubleMatrixMultiD, AbstractFloatMatrix, AbstractGenericMatrix, AbstractGraphMatrix, AbstractIntMatrix, AbstractListMatrix, AbstractLongMatrix, AbstractMapMatrix, AbstractMapMatrixList, AbstractMapToSparseMatrixWrapper, AbstractMapToTiledMatrix2DWrapper, AbstractMatrix, AbstractNumberMatrix, AbstractObjectMatrix, AbstractSetMatrix, AbstractShortMatrix, AbstractSparseBigDecimalMatrix, AbstractSparseBigDecimalMatrix2D, AbstractSparseBigIntegerMatrix, AbstractSparseBigIntegerMatrix2D, AbstractSparseBooleanMatrix, AbstractSparseBooleanMatrix2D, AbstractSparseByteArrayMatrix, AbstractSparseByteArrayMatrix2D, AbstractSparseByteMatrix, AbstractSparseByteMatrix2D, AbstractSparseCharMatrix, AbstractSparseCharMatrix2D, AbstractSparseDoubleMatrix, AbstractSparseDoubleMatrix2D, AbstractSparseFloatMatrix, AbstractSparseFloatMatrix2D, AbstractSparseGenericMatrix, AbstractSparseGenericMatrix2D, AbstractSparseIntMatrix, AbstractSparseIntMatrix2D, AbstractSparseLongMatrix, AbstractSparseLongMatrix2D, AbstractSparseObjectMatrix, AbstractSparseObjectMatrix2D, AbstractSparseShortMatrix, AbstractSparseShortMatrix2D, AbstractSparseStringMatrix, AbstractSparseStringMatrix2D, AbstractStringMatrix, AbstractTreeMatrix, ArrayDenseBigDecimalMatrix2D, ArrayDenseBigIntegerMatrix2D, ArrayDenseBooleanMatrix2D, ArrayDenseByteMatrix2D, ArrayDenseCharMatrix2D, ArrayDenseDoubleMatrix2D, ArrayDenseFloatMatrix2D, ArrayDenseIntMatrix2D, ArrayDenseLongMatrix2D, ArrayDenseObjectMatrix2D, ArrayDenseShortMatrix2D, ArrayDenseStringMatrix2D, AvailableProcessorsMatrix, BenchmarkConfig, BigDecimalCalculationMatrix, BigIntegerCalculationMatrix, BitSetDenseBooleanMatrix2D, BlockDenseDoubleMatrix2D, BooleanCalculationMatrix, BufferedObjectMatrix, ByteCalculationMatrix, CharCalculationMatrix, ClientMatrix, ColtDenseDoubleMatrix2D, ColtSparseDoubleMatrix2D, CommonsMathArrayDenseDoubleMatrix2D, CommonsMathBlockDenseDoubleMatrix2D, DefaultDenseBigDecimalMatrix2D, DefaultDenseBigIntegerMatrix2D, DefaultDenseByteMatrix2D, DefaultDenseCharMatrix2D, DefaultDenseDoubleMatrix2D, DefaultDenseDoubleMatrixMultiD, DefaultDenseFloatMatrix2D, DefaultDenseGenericMatrix2D, DefaultDenseIntMatrix2D, DefaultDenseLongMatrix2D, DefaultDenseObjectMatrix2D, DefaultDenseObjectMatrixMultiD, DefaultDenseShortMatrix2D, DefaultDenseStringMatrix2D, DefaultGraphMatrix, DefaultListMatrix, DefaultMapMatrix, DefaultSetMatrix, DefaultSparseBigDecimalMatrix, DefaultSparseBigIntegerMatrix, DefaultSparseBooleanMatrix, DefaultSparseByteMatrix, DefaultSparseCharMatrix, DefaultSparseColumnObjectMatrix2D, DefaultSparseDoubleMatrix, DefaultSparseDoubleVector1D, DefaultSparseFloatMatrix, DefaultSparseGenericMatrix, DefaultSparseIntMatrix, DefaultSparseLongMatrix, DefaultSparseObjectMatrix, DefaultSparseRowDoubleMatrix2D, DefaultSparseRowObjectMatrix2D, DefaultSparseShortMatrix, DefaultSparseStringMatrix, DefaultTextBlock, DefaultTextSentence, DefaultTextToken, DefaultTiledObjectMatrix2D, DefaultTreeMatrix, DenseCSVStringMatrix2D, DenseDerbyMatrix2D, DenseFileMatrix, DenseHSQLDBMatrix2D, DenseMySQLMatrix2D, DensePostgreSQLMatrix2D, DirectoryMatrix, DoubleCalculationMatrix, EmptyMatrix, FileFormatMatrix, FileMatrix, FloatCalculationMatrix, HttpMatrix, ImageMatrix, IndexedSparseDoubleMatrix2D, IntCalculationMatrix, IrisMatrix, JamaDenseDoubleMatrix2D, JBlasDenseDoubleMatrix2D, JDBCCatalogListMatrix, JDBCCatalogMatrix, JDBCMapMatrix, JDBCSetMatrix, JDBCSparseObjectMatrix, La4JDenseDoubleMatrix2D, LocalhostMatrix, LongCalculationMatrix, MandelbrotMatrix, MatrixLibraries, MatrixUIDefaults, MemoryUsageMatrix, MessageMatrix, MessagesMatrix, MortonDenseDoubleMartrix2D, NetworkInterfaceMatrix, NetworkMatrix, ObjectCalculationMatrix, ObjectTreeMatrix, OperatingSystemMatrix, RandomSeedMatrix, RemoteHostMatrix, RemoteObjectMatrixUDP, RunningThreadsMatrix, SerializedSparseObjectMatrix, ServerObjectMatrixUDP, ShortCalculationMatrix, SparseCSVMatrix, SparseFeatureVector, StringCalculationMatrix, SubnetMatrix, SynchronizedGenericMatrix, SystemEnvironmentMatrix, SystemPropertiesMatrix, SystemTimeMatrix, TextContentMatrix, TimeSeriesMatrix, UJMPPluginsMatrix, UJMPSettings, VecMathDenseDoubleMatrix2D, VolatileSparseObjectMatrix, WaveMatrix, WelcomeMatrix, ZipEntryMatrix, ZipFileMatrix

public interface CoordinateFunctions
This interface defines functions on a Matrix that have to do with the coordinates of the entries.
  • Method Details

    • nonZeroCoordinates

      Iterable<long[]> nonZeroCoordinates()
    • allCoordinates

      Iterable<long[]> allCoordinates()
      Returns an Iterator that goes over all coordinates in the Matrix. It goes from 0,0 to the size of the Matrix.
      Returns:
      Iterable over all coordinates within a Matrix.
    • availableCoordinates

      Iterable<long[]> availableCoordinates()
      Returns an Iterator that only goes over the coordinates in the Matrix that are stored. For most Matrices, this is the same as allCoordinates(). For sparse Matrices, it iterates only over the entries in it.
      Returns:
      Iterable over the saved entries in a Matrix.
    • selectedCoordinates

      Iterable<long[]> selectedCoordinates(String selection)
      Returns an Iterator that goes only over the Coordinates defined by the selection. The selection is a Matlab/Octave style String, to define what rows or columns should be considered. E.g. "(2:5,[1,3,5,7:9])" to select rows 2 to 5 and the columns 1, 3, 5, 7, 8 and 9. Note that, in UJMP numbering starts at 0 unlike in Matlab and Octave
      Parameters:
      selection - The String defining the selection of rows or columns
      Returns:
      Iterable over the desired Coordinates
    • selectedCoordinates

      Iterable<long[]> selectedCoordinates(long[]... selection)
      Returns an Iterator that goes only over the Coordinates defined by the selection. The selections consists of a list of long arrays, one for each dimension. The first array contains the row numbers that should be selected, the second the column numbers, and so on.
      Parameters:
      selection - A list of long arrays defining the desired rows or columns
      Returns:
      Iterable over the desired Coordinates @
    • getCoordinatesOfMaximum

      long[] getCoordinatesOfMaximum()
      Returns the position of the maximum value in a Matrix. If there is more than one equal maximum values, the first that is found is returned (not necessarily with the lowest coordinates). If no maximum can be found (because there are no numbers in the matrix or all numbers are NaN), the coordinates -1,-1 are returned.
      Returns:
      Coordinates of the maximum value @
    • getCoordinatesOfMinimum

      long[] getCoordinatesOfMinimum()
      Returns the position of the minimum value in a Matrix. If there is more than one equal minimum values, the first that is found is returned (not necessarily with the lowest coordinates). If no minimum can be found (because there are no numbers in the matrix or all numbers are NaN), the coordinates -1,-1 are returned.
      Returns:
      Coordinates of the minimum value @
    • containsCoordinates

      boolean containsCoordinates(long... coordinates)
      Determines if the given Coordinates are part of the Matrix. If the Matrix is dense, true is returned for all Coordinates smaller than the Matrix's size. For sparse Matrices, this function checks if the coordinates are actually stored in the matrix or not.
      Parameters:
      coordinates - The coordinates to check
      Returns:
      a boolean stating if the coordinates are part of the Matrix