|
AlgART Home | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface ByteArray extends PIntegerArray
AlgART array of byte values, read-only access.
AlgART Laboratory 2007-2013
| Modifier and Type | Method and Description |
|---|---|
ByteArray |
asImmutable()
Returns an immutable view of this array. |
ByteArray |
asTrustedImmutable()
Returns a trusted immutable view of this array. |
DataByteBuffer |
buffer()
Equivalent to buffer(suitableMode, someCapacity), where both suitableMode and someCapacity
arguments are chosen automatically. |
DataByteBuffer |
buffer(DataBuffer.AccessMode mode)
Equivalent to buffer(mode, someCapacity), where mode is the argument of this method
and someCapacity is chosen automatically to provide good performance in typical situations. |
DataByteBuffer |
buffer(DataBuffer.AccessMode mode,
long capacity)
Returns a data buffer allowing block access to this array
with the specified access mode and buffer capacity. |
DataByteBuffer |
buffer(long capacity)
Equivalent to buffer(suitableMode, capacity), where capacity is the argument of this method
and suitableMode is chosen automatically. |
int |
getByte(long index)
Returns the unsigned byte #index. |
long |
indexOf(long lowIndex,
long highIndex,
byte value)
Returns the minimal index k, so that lowIndex<=k<min(highIndex,thisArray. length())
and getByte(k)==value,
or -1 if there is no such array element. |
long |
lastIndexOf(long lowIndex,
long highIndex,
byte value)
Returns the maximal index k, so that highIndex>k>=max(lowIndex,0) and getByte(k)==value,
or -1 if there is no such array element. |
MutableByteArray |
mutableClone(MemoryModel memoryModel)
Returns a mutable resizable copy of this array. |
java.lang.Class<? extends MutableByteArray> |
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 ByteArray> |
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. |
UpdatableByteArray |
updatableClone(MemoryModel memoryModel)
Returns an unresizable updatable copy of this array. |
java.lang.Class<? extends UpdatableByteArray> |
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, 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 ByteArray> 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 PIntegerArraytype in interface PNumberArrayjava.lang.Class<? extends UpdatableByteArray> 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 PIntegerArrayupdatableType in interface PNumberArrayjava.lang.Class<? extends MutableByteArray> 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 PIntegerArraymutableType in interface PNumberArrayint getByte(long index)
index - index of element to get.java.lang.IndexOutOfBoundsException - if index is out of range 0..length()-1.
long indexOf(long lowIndex,
long highIndex,
byte value)
length())
and getByte(k)==value,
or -1 if there is no such array element.
In particular, if lowIndex>=thisArray.length()}
or lowIndex>=highIndex, this method returns -1,
and if lowIndex<0, the result is the same as if lowIndex==0.
You may specify lowIndex=0 and highIndex=Long.MAX_VALUE to search through all array elements.
lowIndex - the low index in the array for search (inclusive).highIndex - the high index in the array for search (exclusive).value - the value to be found.
long lastIndexOf(long lowIndex,
long highIndex,
byte value)
getByte(k)==value,
or -1 if there is no such array element.
In particular, if highIndex<=0 or highIndex<=lowIndex,
this method returns -1,
and if highIndex>=thisArray.length(),
the result is the same as if highIndex==thisArray.length().
You may specify lowIndex=0 and highIndex=Long.MAX_VALUE to search through all array elements.
lowIndex - the low index in the array for search (inclusive).highIndex - the high index in the array for search (exclusive).value - the value to be found.
DataByteBuffer buffer(DataBuffer.AccessMode mode,
long capacity)
Arraydata buffer allowing block access to this array
with the specified access mode and buffer capacity.
If this array does not implement UpdatableArray interface
(so, it is probably immutable or trusted immutable), the mode argument must be DataBuffer.AccessMode.READ.
The capacity argument must be in range 0..237-1
for bit arrays or 0..231-1 for all other element types.
If the capacity argument is greater than this array Array.length(),
it is truncated to this length.
buffer in interface Arraymode - the access mode for new buffer.capacity - the capacity of the buffer.Array.buffer(net.algart.arrays.DataBuffer.AccessMode),
Array.buffer(long),
Array.buffer()DataByteBuffer buffer(DataBuffer.AccessMode mode)
Arraybuffer(mode, someCapacity), where mode is the argument of this method
and someCapacity is chosen automatically to provide good performance in typical situations.
Usually, the capacity is chosen to get a buffer occupying several kilobytes,
that can fit in an internal cache of most processors.
In any case, you can be sure that the chosen capacity will not be greater than Integer.MAX_VALUE-64.
buffer in interface Arraymode - the access mode for new buffer.DataByteBuffer buffer(long capacity)
Arraybuffer(suitableMode, capacity), where capacity is the argument of this method
and suitableMode is chosen automatically. Namely, suitableMode is:DataBuffer.AccessMode.READ_WRITE if this array implements UpdatableArray interface
(i.e., is modifiable and, maybe, resizable);DataBuffer.AccessMode.READ if this array does not implements this interface
(i.e., probably, immutable or trusted immutable).
buffer in interface Arraycapacity - the capacity of the buffer.DataByteBuffer buffer()
Arraybuffer(suitableMode, someCapacity), where both suitableMode and someCapacity
arguments are chosen automatically. The algorithm of choosing these arguments is the same
as for Array.buffer(net.algart.arrays.DataBuffer.AccessMode) and Array.buffer(long) methods.
In any case, you can be sure that the chosen capacity will not be greater than Integer.MAX_VALUE-64.
buffer in interface ArrayByteArray 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 PFixedArrayasImmutable in interface PIntegerArrayArray.isImmutable(),
Array.asTrustedImmutable(),
Array.mutableClone(MemoryModel),
Array.updatableClone(MemoryModel),
UpdatableArray.asUnresizable()ByteArray 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 PFixedArrayasTrustedImmutable in interface PIntegerArrayArray.asImmutable(),
Array.checkUnallowedMutation()MutableByteArray 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 PFixedArraymutableClone in interface PIntegerArraymemoryModel - the memory model, used for allocation a new copy of this array.Array.updatableClone(MemoryModel)UpdatableByteArray 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 PFixedArrayupdatableClone in interface PIntegerArraymemoryModel - 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 | ||||||||