Package net.algart.arrays

Interface UpdatablePFloatingArray

All Superinterfaces:
Array, ArrayExchanger, PArray, PFloatingArray, PNumberArray, UpdatableArray, UpdatablePArray, UpdatablePNumberArray
All Known Subinterfaces:
MutableDoubleArray, MutableFloatArray, MutablePFloatingArray, UpdatableDoubleArray, UpdatableFloatArray
All Known Implementing Classes:
AbstractUpdatableDoubleArray, AbstractUpdatableFloatArray
public interface UpdatablePFloatingArray extends PFloatingArray, UpdatablePNumberArray

AlgART array of any floating-point primitive elements (float or double), read/write access, no resizing.

Any class implementing this interface must implement one of UpdatableFloatArray, UpdatableDoubleArray subinterfaces.

Author:
Daniel Alievsky

  • Method Details

    • subArray

      UpdatablePFloatingArray subArray(long fromIndex, long toIndex)
      Description copied from interface: Array
      Returns a view of the portion of this array between fromIndex, inclusive, and toIndex, exclusive.
      • If fromIndex and toIndex are equal, the returned array is empty.
      • The returned array is backed by this array, so — if this array is not immutable — any changes of the elements of the returned array are reflected in this array, and vice-versa.
      • The capacity of returned array (returned by Array.capacity() method) will be equal to the its length (returned by Array.length(), that is toIndex-fromIndex.
      • The type of elements of the returned array is the same as the type of elements of this array.
      • The returned array is immutable, trusted immutable or copy-on-next-write, if, and only if, this array is immutable, trusted immutable or copy-on-next-write correspondingly.
      • If (and only if) this array implements UpdatableArray interface, then the returned array also implements it. If (and only if) this array implements DirectAccessible interface, then the returned array also implements it. The returned array never implements MutableArray interface; it is always unresizable.

      Like List.subList method, this method eliminates the need for explicit range operations. For example, you may use Arrays.sort(UpdatableArray, ArrayComparator) method for sorting a fragment of the array.

      Unlike List.subList, the semantics of the array returned by this method is well-defined in any case, even in case of resizing of the source array. Namely, if the internal storage of this or returned array is reallocated, then the returned array will cease to be a view of this array. The only possible reasons for reallocation are the following: calling MutableArray.length(long), MutableArray.ensureCapacity(long) or MutableArray.trim() methods for this array, or any modification of this or returned array in a case when this array is copy-on-next-write. Also, if the length of this array will be reduced, it can lead to clearing some elements in returned array: see comments to MutableArray.length(long) method.

      Specified by:
      subArray in interface Array
      Specified by:
      subArray in interface UpdatableArray
      Specified by:
      subArray in interface UpdatablePArray
      Parameters:
      fromIndex - low endpoint (inclusive) of the subarray.
      toIndex - high endpoint (exclusive) of the subarray.
      Returns:
      a view of the specified range within this array.
      See Also:

    • subArr

      UpdatablePFloatingArray subArr(long position, long count)
      Description copied from interface: Array
      Equivalent to subArray(position, position + count). The only possible difference is other exception messages. If position+count>Long.MAX_VALUE (overflow), an exception message is allowed to be not fully correct (maximal speed is more important than absolutely correct exception messages for such exotic situations).
      Specified by:
      subArr in interface Array
      Specified by:
      subArr in interface UpdatableArray
      Specified by:
      subArr in interface UpdatablePArray
      Parameters:
      position - start position (inclusive) of the subarray.
      count - number of elements in the subarray.
      Returns:
      a view of the specified range within this array.
      See Also:

    • asUnresizable

      UpdatablePFloatingArray asUnresizable()
      Description copied from interface: UpdatableArray
      Returns an unresizable view of this array. If this array is not resizable already, returns a reference to this object. Query operations on the returned array "read through" and "write through" to this array.

      The returned view (when it is not a reference to this object) contains the same elements as this array, but independent length, start offset, capacity, copy-on-next-write and possible other information about array characteristics besides its elements, as for UpdatableArray.shallowClone() method. If modifications of this or returned array characteristics lead to reallocation of the internal storage, then the returned array ceases to be a view of this array. The only possible reasons for reallocation are the following: calling MutableArray.length(long), MutableArray.ensureCapacity(long) or MutableArray.trim() methods for this array, or any modification of this or returned array in a case when this array is copy-on-next-write.

      Resizable arrays, created by this package, implement full MutableArray interface, but unresizable ones implement only its UpdatableArray superinterface.

      Specified by:
      asUnresizable in interface UpdatableArray
      Specified by:
      asUnresizable in interface UpdatablePArray
      Returns:
      an unresizable view of this array.
      See Also:

    • matrix

      default Matrix<? extends UpdatablePFloatingArray> matrix(long... dim)
      Description copied from interface: Array
      Equivalent to matrix(thisArray, dim).
      Specified by:
      matrix in interface Array
      Specified by:
      matrix in interface PArray
      Specified by:
      matrix in interface PFloatingArray
      Specified by:
      matrix in interface PNumberArray
      Specified by:
      matrix in interface UpdatableArray
      Specified by:
      matrix in interface UpdatablePArray
      Specified by:
      matrix in interface UpdatablePNumberArray
      Parameters:
      dim - the matrix dimensions.
      Returns:
      new matrix backed by array with the given dimensions.