|
AlgART Home | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface PIntegerArray extends PFixedArray, PNumberArray
AlgART array of any fixed-point primitive numeric elements (byte, short, int or long), read-only access.
Any class implementing this interface must implement one of
ByteArray, ShortArray,
IntArray, LongArray subinterfaces.
AlgART Laboratory 2007-2013
| Modifier and Type | Method and Description |
|---|---|
PIntegerArray |
asImmutable()
Returns an immutable view of this array. |
PIntegerArray |
asTrustedImmutable()
Returns a trusted immutable view of this array. |
MutablePIntegerArray |
mutableClone(MemoryModel memoryModel)
Returns a mutable resizable copy of this array. |
java.lang.Class<? extends MutablePIntegerArray> |
mutableType()
Returns the canonical resizable AlgART type of arrays with the same element types: the class of one of 9 basic interfaces, describing all kinds of resizable AlgART arrays for 8 primitive and any non-primitive element types. |
java.lang.Class<? extends PIntegerArray> |
type()
Returns the canonical AlgART type of this array: the class of one of 9 basic interfaces, describing all kinds of AlgART arrays for 8 primitive and any non-primitive element types. |
UpdatablePIntegerArray |
updatableClone(MemoryModel memoryModel)
Returns an unresizable updatable copy of this array. |
java.lang.Class<? extends UpdatablePIntegerArray> |
updatableType()
Returns the canonical updatable AlgART type of arrays with the same element types: the class of one of 9 basic interfaces, describing all kinds of updatable AlgART arrays for 8 primitive and any non-primitive element types. |
| Methods inherited from interface net.algart.arrays.PFixedArray |
|---|
getInt, getLong, indexOf, lastIndexOf, maxPossibleValue, minPossibleValue |
| Methods inherited from interface net.algart.arrays.PArray |
|---|
bitsPerElement, getDouble, indexOf, isZeroFilled, lastIndexOf, maxPossibleValue, minPossibleValue |
| Methods inherited from interface net.algart.arrays.Array |
|---|
asCopyOnNextWrite, buffer, buffer, buffer, buffer, byteOrder, capacity, checkUnallowedMutation, elementType, equals, flushResources, flushResources, freeResources, freeResources, getData, getData, getElement, hashCode, isCopyOnNextWrite, isImmutable, isLazy, isNew, isNewReadOnlyView, isUnresizable, length, loadResources, newJavaArray, shallowClone, subArr, subArray, toString |
| Method Detail |
|---|
java.lang.Class<? extends PIntegerArray> type()
ArrayBitArray.class, if this object is an instance of BitArray,CharArray.class, if this object is an instance of CharArray,ByteArray.class, if this object is an instance of ByteArray,ShortArray.class, if this object is an instance of ShortArray,IntArray.class, if this object is an instance of IntArray,LongArray.class, if this object is an instance of LongArray,FloatArray.class, if this object is an instance of FloatArray,DoubleArray.class, if this object is an instance of DoubleArray,ObjectArray.class, if this object is an instance of ObjectArray.There is a guarantee that this method works very quickly (usually it just returns a constant value).
type in interface Arraytype in interface PArraytype in interface PNumberArrayjava.lang.Class<? extends UpdatablePIntegerArray> updatableType()
ArrayUpdatableBitArray.class, if this object is an instance of BitArray,UpdatableCharArray.class, if this object is an instance of CharArray,UpdatableByteArray.class, if this object is an instance of ByteArray,UpdatableShortArray.class, if this object is an instance of ShortArray,UpdatableIntArray.class, if this object is an instance of IntArray,UpdatableLongArray.class, if this object is an instance of LongArray,UpdatableFloatArray.class, if this object is an instance of FloatArray,UpdatableDoubleArray.class, if this object is an instance of DoubleArray,UpdatableObjectArray.class, if this object is an instance of ObjectArray.There is a guarantee that this method works very quickly (usually it just returns a constant value).
updatableType in interface ArrayupdatableType in interface PArrayupdatableType in interface PNumberArrayjava.lang.Class<? extends MutablePIntegerArray> mutableType()
ArrayMutableBitArray.class, if this object is an instance of BitArray,MutableCharArray.class, if this object is an instance of CharArray,MutableByteArray.class, if this object is an instance of ByteArray,MutableShortArray.class, if this object is an instance of ShortArray,MutableIntArray.class, if this object is an instance of IntArray,MutableLongArray.class, if this object is an instance of LongArray,MutableFloatArray.class, if this object is an instance of FloatArray,MutableDoubleArray.class, if this object is an instance of DoubleArray,MutableObjectArray.class, if this object is an instance of ObjectArray.There is a guarantee that this method works very quickly (usually it just returns a constant value).
mutableType in interface ArraymutableType in interface PArraymutableType in interface PNumberArrayPIntegerArray asImmutable()
ArrayArray.isImmutable() is true),
returns a reference to this object.
A array is considered to be immutable,
if there are no ways to modify its content or state with help of this instance.
In particular, immutable arrays never
implement UpdatableArray or DirectAccessible interfaces.
Moreover, any third-party implementation of Array interface
must return an instance of a class, which has no public methods or fields
allowing to change this instance.
Query operations on the returned array "read through"
to this array. The returned view is also unresizable
(see UpdatableArray.asUnresizable()).
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 Array.shallowClone() method.
If modifications of this 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.
By default, the array factories (memory models) create mutable arrays,
but they can be converted to immutable by this method.
Note: Array.isNew() method, called for the result of this method, always returns false
— because it does not implement UpdatableArray.
Also note: Array.isNewReadOnlyView() method, called for the result of this method, always returns
the same value as Array.isNewReadOnlyView() for this object.
Really,
Array.isImmutable()==true),
then it is obvious (this method just returns a reference to this array);Array.isImmutable()==false),
then, according to the contract to Array.isNewReadOnlyView() method,
Array.isNewReadOnlyView() must return false for this array
(in other case Array.isImmutable() would return true) and
it also must return false for the returned array
(because it is a view of another array and not an original view of external data —
see the beginning of the comment to Array.isNewReadOnlyView()).
asImmutable in interface ArrayasImmutable in interface PArrayasImmutable in interface PFixedArrayArray.isImmutable(),
Array.asTrustedImmutable(),
Array.mutableClone(MemoryModel),
Array.updatableClone(MemoryModel),
UpdatableArray.asUnresizable()PIntegerArray asTrustedImmutable()
ArrayA array is considered to be "trusted" immutable,
if it potentially can change its elements,
but the Java code working with this array promises that it will not change them.
The returned instance never implements UpdatableArray,
but may implement DirectAccessible, that allow quick access to its elements.
As for usual immutable view,
query operations on the returned array "read through"
to this array.
The only standard way allowing to change elements of returned array
is using DirectAccessible.javaArray() method, in a case when the array is backed
by an accessible array.
But the Java code, processing the trusted immutable array,
must use this method only for quick reading elements and not try to change them.
If, despite the promise, the elements of the trusted immutable array will be changed,
the UnallowedMutationError may be thrown by the call of
Array.checkUnallowedMutation() method.
In some implementations — for example, if DirectAccessible
interface is not supported by this array
— this method may return the same result as Array.asImmutable().
The returned view is always unresizable.
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 Array.shallowClone() method.
If modifications of this 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.
Trusted immutable view is a compromise between absolute safety, provided by
usual immutable view, and maximal efficiency,
achieved while using the original non-protected array.
Please see the package description
to learn more about possible usage of this method.
asTrustedImmutable in interface ArrayasTrustedImmutable in interface PArrayasTrustedImmutable in interface PFixedArrayArray.asImmutable(),
Array.checkUnallowedMutation()MutablePIntegerArray mutableClone(MemoryModel memoryModel)
ArraymemoryModel.newArray(thisArray).copy(thisArray);
Please note: this method is a good choice for cloning little arrays (thousands, maybe millions elements). If you clone large arrays by this method, the user, in particular, has no ways to view the progress of copying or to interrupt copying. To clone large arrays, we recommend the following code:
MutableArray clone = memoryModel.newArray(thisArray);Arrays.copy(someContext, clone, a);
mutableClone in interface ArraymutableClone in interface PArraymutableClone in interface PFixedArraymemoryModel - the memory model, used for allocation a new copy of this array.Array.updatableClone(MemoryModel)UpdatablePIntegerArray updatableClone(MemoryModel memoryModel)
ArraymemoryModel.newUnresizableArray(thisArray).copy(thisArray);
Please note: this method is a good choice for cloning little arrays (thousands, maybe millions elements). If you clone large arrays by this method, the user, in particular, has no ways to view the progress of copying or to interrupt copying. To clone large arrays, we recommend the following code:
UpdatableArray clone = memoryModel.newUnresizableArray(thisArray);Arrays.copy(someContext, clone, a);
updatableClone in interface ArrayupdatableClone in interface PArrayupdatableClone in interface PFixedArraymemoryModel - the memory model, used for allocation a new copy of this array.Array.mutableClone(MemoryModel)
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||