Package net.algart.arrays

Interface UpdatableObjectArray<E>

All Superinterfaces:

Array, ArrayExchanger, ObjectArray<E>, UpdatableArray

All Known Subinterfaces:

MutableObjectArray<E>, MutableObjectInPlaceArray<E>, UpdatableObjectInPlaceArray<E>

All Known Implementing Classes:

AbstractUpdatableObjectArray

public interface UpdatableObjectArray<E>
extends ObjectArray<E>, UpdatableArray

AlgART array of some objects (non-primitive values) with the specified generic type E, read/write access, no resizing.

Any class implementing this interface must contain non-primitive elements (ObjectArray.elementType() must not return a primitive type).

Author:

Daniel Alievsky

Method Summary

Modifier and Type	Method	Description
UpdatableObjectArray<E>	asUnresizable()	Returns an unresizable view of this array.
<D> UpdatableObjectArray<D>	cast(Class<D> elementType)	Returns this array cast to the specified generic element type or throws ClassCastException if the elements cannot be cast to the required type (because the element type is not its subclass).
UpdatableObjectArray<E>	fill(long position, long count, E value)	Fills count elements of this array, starting from position index, by the specified value.
UpdatableObjectArray<E>	fill(E value)	Fills all elements of this array by the specified value.
default Matrix<UpdatableObjectArray<E>>	matrix(long... dim)	Equivalent to matrix(thisArray, dim).
void	set(long index, E value)	Equivalent to setElement(index, value).
UpdatableObjectArray<E>	subArr(long position, long count)	Equivalent to subArray(position, position + count).
UpdatableObjectArray<E>	subArray(long fromIndex, long toIndex)	Returns a view of the portion of this array between fromIndex, inclusive, and toIndex, exclusive.

Methods inherited from interface net.algart.arrays.Array

byteOrder, capacity, checkUnallowedMutation, equals, flushResources, flushResources, freeResources, freeResources, getData, getData, getElement, hashCode, isCopyOnNextWrite, isEmpty, isImmutable, isLazy, isNew, isNewReadOnlyView, isUnresizable, length, length32, loadResources, newJavaArray, toString

Methods inherited from interface net.algart.arrays.ObjectArray

asImmutable, asTrustedImmutable, buffer, buffer, buffer, buffer, elementType, get, indexOf, ja, lastIndexOf, mutableClone, mutableType, type, updatableClone, updatableType

Methods inherited from interface net.algart.arrays.UpdatableArray

asCopyOnNextWrite, copy, copy, copy, setData, setData, setElement, setNonNew, shallowClone, swap, swap, swap

Method Details

set

void set(long index,
 E value)

Equivalent to setElement(index, value).

Parameters:

index - index of element to replace.

value - element to be stored at the specified position.

Throws:

IndexOutOfBoundsException - if index is out of range 0..length()-1.

NullPointerException - if value == null and it is an array of primitive elements.

ArrayStoreException - if value is not an instance of ObjectArray.elementType() class.

fill

UpdatableObjectArray<E> fill(E value)

Fills all elements of this array by the specified value. Equivalent to fill(0, thisArray.length(), value).

Parameters:

value - the value to be stored in all elements of the array.

Returns:

a reference to this array.

See Also:

• fill(long, long, Object)
• Arrays.zeroFill(UpdatableArray)

fill

UpdatableObjectArray<E> fill(long position,
 long count,
 E value)

Fills count elements of this array, starting from position index, by the specified value. Equivalent to the following loop:

 for (long k = 0; k < count; k++) {
     set(position + k, value);
 }

but works much faster and checks indexes (and throws possible IndexOutOfBoundsException) in the very beginning.

If value == null, this method does not throw NullPointerException, but may fill the elements by some default value, if null elements are not supported by the memory model (as in a case of CombinedMemoryModel).

Parameters:

position - start index (inclusive) to be filled.

count - number of filled elements.

value - the value to be stored in the elements of the array.

Returns:

a reference to this array.

Throws:

IndexOutOfBoundsException - for illegal position and count (position < 0 || count < 0 || position + count > length()).

See Also:

• fill(Object)
• Arrays.zeroFill(UpdatableArray)

cast

<D> UpdatableObjectArray<D> cast(Class<D> elementType)

Description copied from interface: ObjectArray

Returns this array cast to the specified generic element type or throws ClassCastException if the elements cannot be cast to the required type (because the element type is not its subclass). Equivalent to (ObjectArray)thisArray, but is compiled without "unchecked cast" warning or "inconvertible type" error.

Unlike ArrayList architecture, such casting is safe here, because all methods, storing data in the AlgART array, always check the element type and do not allow saving illegal elements.

Specified by:

cast in interface ObjectArray<E>

Parameters:

elementType - the required generic type.

Returns:

this array cast to the specified generic element type.

subArray

UpdatableObjectArray<E> 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

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:

• Array.subArr(long, long)

subArr

UpdatableObjectArray<E> 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

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:

• Array.subArray(long, long)

asUnresizable

UpdatableObjectArray<E> 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

Returns:

an unresizable view of this array.

See Also:

• Array.isUnresizable()

matrix

default Matrix<UpdatableObjectArray<E>> matrix(long... dim)

Description copied from interface: Array

Equivalent to matrix(thisArray, dim).

Specified by:

matrix in interface Array

Specified by:

matrix in interface ObjectArray<E>

Specified by:

matrix in interface UpdatableArray

Parameters:

dim - the matrix dimensions.

Returns:

new matrix backed by array with the given dimensions.