Class AbstractUpdatableCharArray
- All Implemented Interfaces:
Cloneable,Array,ArrayExchanger,CharArray,PArray,PFixedArray,UpdatableArray,UpdatableCharArray,UpdatablePArray,UpdatablePFixedArray
Implementation of almost all basic functions of UpdatableCharArray interface.
The only CharArray.getChar(long) and UpdatableCharArray.setChar(long, char) methods
are not defined in this class;
all other methods are implemented via calls of these 2 methods.
- Author:
- Daniel Alievsky
-
Field Summary
Fields inherited from class net.algart.arrays.AbstractArray
capacity, length, underlyingArrays -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedAbstractUpdatableCharArray(long initialCapacityAndLength, boolean underlyingArraysAreParallel, Array... underlyingArrays) Equivalent to the constructorAbstractUpdatableCharArray(long, long, boolean, Array...), where both initialCapacity and initialLength arguments are equal to initialCapacityAndLength.protectedAbstractUpdatableCharArray(long initialCapacity, long initialLength, boolean underlyingArraysAreParallel, Array... underlyingArrays) Creates an updatable array with the given initial capacity and length. -
Method Summary
Modifier and TypeMethodDescriptionThis implementation returnsupdatableClone(Arrays.SMM).This implementation returns an instance of the subclass ofAbstractCharArray, where the following method are overridden and call the same methods of this instance:AbstractCharArray.getChar(long),AbstractCharArray.getData(long, Object, int, int),AbstractCharArray.getData(long, Object),AbstractCharArray.loadResources(ArrayContext, long, long),AbstractCharArray.flushResources(ArrayContext, long, long, boolean)andAbstractCharArray.freeResources(ArrayContext, long, long, boolean).This implementation returns this object.voidcopy(long destIndex, long srcIndex) This implementation calls setChar(destIndex, getChar(srcIndex)).voidcopy(long destIndex, long srcIndex, long count) This implementation is based on a loop of calls ofcopy(long, long)method.This implementation callsdefaultCopy(thisInstance, src).final UpdatableCharArrayfill(char value) This implementation just callsfill(0, thisArray.length(), value).final UpdatableCharArrayfill(double value) This implementation just callsfill(0, thisArray.length(), value).final UpdatableCharArrayfill(long value) This implementation just callsfill(0, thisArray.length(), value).fill(long position, long count, char value) This implementation does the following:subArr(position, count).copy(Arrays.nCharCopies(count, value)).fill(long position, long count, double value) This implementation just callsfill(position, count, (char)value).fill(long position, long count, long value) This implementation just callsfill(position, count, (char)value).booleanThis implementation returns false.abstract voidsetChar(long index, char value) Sets the element #index to specified value.This implementation callssetData(long, Object, int, int)with corresponding arguments.This implementation is based on a loop of calls ofsetChar(long, char)method.voidsetDouble(long index, double value) Sets the element #index with conversion from double, as (xxx)value for numeric element type xxx (byte, short, int, long, float, double or char), or as value!=0.0 for boolean element type.voidsetElement(long index, Object value) This implementation calls setChar(index, (Character)value).charValue()).voidsetInt(long index, int value) Sets the element #index with conversion from int, as (xxx)value for numeric element type xxx (byte, short, int, long, float, double or char), or as value!=0 for boolean element type.voidsetLong(long index, long value) Sets the element #index with conversion from long, as (xxx)value for numeric element type xxx (byte, short, int, long, float, double or char), or as value!=0 for boolean element type.voidThis implementation callssetNewStatus(false).This implementation returns (UpdatableArray)super.shallowClone().subArr(long position, long count) This implementation returnssubArray(position, position + count).subArray(long fromIndex, long toIndex) This implementation returns new instance ofAbstractUpdatableCharArraywith the same memory model and underlying arrays, that were passed to the constructor of this instance, and with overridden methodsAbstractCharArray.getChar(long),setChar(long, char),AbstractCharArray.getData(long, Object, int, int)andsetData(long, Object, int, int)calling the same methods of this instance with corresponding corrections of the arguments.voidswap(long firstIndex, long secondIndex) This implementation swaps two elements byAbstractCharArray.getChar(long)andsetChar(long, char)methods.voidswap(long firstIndex, long secondIndex, long count) This implementation is based on a loop of calls ofswap(long, long)method.swap(UpdatableArray another) This implementation callsdefaultSwap(thisInstance, another).toString()Returns a brief string description of this object.Methods inherited from class net.algart.arrays.AbstractCharArray
asTrustedImmutable, bitsPerElement, buffer, buffer, buffer, buffer, checkUnallowedMutation, elementType, flushResources, flushResources, freeResources, freeResources, getChar, getData, getData, getDouble, getElement, getInt, getLong, indexOf, indexOf, indexOf, isCopyOnNextWrite, isUnresizable, ja, lastIndexOf, lastIndexOf, lastIndexOf, loadResources, loadResources, maxPossibleValue, maxPossibleValue, minPossibleValue, minPossibleValue, mutableClone, mutableType, type, updatableClone, updatableTypeMethods inherited from class net.algart.arrays.AbstractArray
byteOrder, capacity, checkCopyArguments, checkSubArrArguments, checkSubArrayArguments, checkSwapArguments, defaultAppend, defaultBuffer, defaultBufferCapacity, defaultCopy, defaultCopy, defaultSwap, equals, equals, flushResources, freeResources, hashCode, hashCode, isLazy, isNew, isNewReadOnlyView, isZeroFilled, length, newJavaArray, setNewReadOnlyViewStatus, setNewStatus, standardObjectCloneMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface net.algart.arrays.Array
byteOrder, capacity, checkUnallowedMutation, elementType, equals, flushResources, flushResources, freeResources, freeResources, getData, getData, getElement, hashCode, isCopyOnNextWrite, isEmpty, isLazy, isNew, isNewReadOnlyView, isUnresizable, length, length32, loadResources, newJavaArrayMethods inherited from interface net.algart.arrays.CharArray
asTrustedImmutable, buffer, buffer, buffer, buffer, getChar, getInt, indexOf, ja, lastIndexOf, mutableClone, mutableType, type, updatableClone, updatableTypeMethods inherited from interface net.algart.arrays.PArray
bitsPerElement, getDouble, indexOf, isZeroFilled, jaByte, jaDouble, jaFloat, jaInt, jaLong, jaShort, lastIndexOf, maxPossibleValue, minPossibleValueMethods inherited from interface net.algart.arrays.PFixedArray
getLong, indexOf, lastIndexOf, maxPossibleValue, minPossibleValueMethods inherited from interface net.algart.arrays.UpdatableCharArray
matrixMethods inherited from interface net.algart.arrays.UpdatablePArray
updatableType
-
Constructor Details
-
AbstractUpdatableCharArray
protected AbstractUpdatableCharArray(long initialCapacity, long initialLength, boolean underlyingArraysAreParallel, Array... underlyingArrays) Creates an updatable array with the given initial capacity and length.This array is not
newby default. This is correct usually, because this class is often used for creating a view of another data. However, if the instance if this class does not depend on any other data sources, you may callsetNewStatus(true)in the constructor of your subclass.- Parameters:
initialCapacity- initial capacity of the array.initialLength- initial length of the array.underlyingArraysAreParallel- see the same argument ofAbstractCharArray(long, long, boolean, Array...).underlyingArrays- see the same argument ofAbstractArray(long, long, Array...).- Throws:
NullPointerException- if underlyingArrays argument or some of underlyingArrays[k] elements is null.IllegalArgumentException- if the initialCapacity or initialLength arguments are illegal (negative, or capacity < length).SizeMismatchException- if underlyingArraysAreParallel=true, underlyingArrays.length>1 and some of passed arrays have different lengths.
-
AbstractUpdatableCharArray
protected AbstractUpdatableCharArray(long initialCapacityAndLength, boolean underlyingArraysAreParallel, Array... underlyingArrays) Equivalent to the constructorAbstractUpdatableCharArray(long, long, boolean, Array...), where both initialCapacity and initialLength arguments are equal to initialCapacityAndLength.- Parameters:
initialCapacityAndLength- initial capacity and length of the array.underlyingArraysAreParallel- seeAbstractUpdatableCharArray(long, long, boolean, Array...).underlyingArrays- seeAbstractUpdatableCharArray(long, long, boolean, Array...)- Throws:
IllegalArgumentException- if the passed argument are illegal (negative).
-
-
Method Details
-
subArray
This implementation returns new instance ofAbstractUpdatableCharArraywith the same memory model and underlying arrays, that were passed to the constructor of this instance, and with overridden methodsAbstractCharArray.getChar(long),setChar(long, char),AbstractCharArray.getData(long, Object, int, int)andsetData(long, Object, int, int)calling the same methods of this instance with corresponding corrections of the arguments.The returned instance also have overridden methods
AbstractCharArray.loadResources(ArrayContext, long, long),AbstractCharArray.flushResources(ArrayContext, long, long, boolean)andAbstractCharArray.freeResources(ArrayContext, long, long, boolean), that also call the same methods of this instance with corresponding correction of their fromIndex argument.The returned instance also have overridden method
AbstractArray.isLazy(), that just calls the same methods of this instance with the same arguments.- Specified by:
subArrayin interfaceArray- Specified by:
subArrayin interfaceUpdatableArray- Specified by:
subArrayin interfaceUpdatableCharArray- Specified by:
subArrayin interfaceUpdatablePArray- Specified by:
subArrayin interfaceUpdatablePFixedArray- Overrides:
subArrayin classAbstractCharArray- 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.
- Throws:
IndexOutOfBoundsException- for illegal fromIndex and toIndex (fromIndex < 0 || toIndex > length() || fromIndex > toIndex).- See Also:
-
subArr
Description copied from class:AbstractArrayThis implementation returnssubArray(position, position + count). Please note that the exception message can be not fully correct for the very exotic case position+count>Long.MAX_VALUE.- Specified by:
subArrin interfaceArray- Specified by:
subArrin interfaceUpdatableArray- Specified by:
subArrin interfaceUpdatableCharArray- Specified by:
subArrin interfaceUpdatablePArray- Specified by:
subArrin interfaceUpdatablePFixedArray- Overrides:
subArrin classAbstractArray- 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:
-
setDouble
public void setDouble(long index, double value) Description copied from interface:UpdatablePArraySets the element #index with conversion from double, as (xxx)value for numeric element type xxx (byte, short, int, long, float, double or char), or as value!=0.0 for boolean element type.Depending on the specific subinterface implemented by the object, this method is equivalent to one of the following calls:
- for
UpdatableBitArray:setBit(index, value != 0.0); - for
UpdatableCharArray:setChar(index, (char) value); - for
UpdatableByteArray:setByte(index, (byte) value); - for
UpdatableShortArray:setShort(index, (short) value); - for
UpdatableLongArray:setLong(index, (long) value); - for
UpdatableFloatArray:setFloat(index, (float) value); - for
UpdatableDoubleArray: the same method is already declared in this interface.
- Specified by:
setDoublein interfaceUpdatablePArray- Parameters:
index- index of element to replace.value- element to be stored at the specified position.- See Also:
- for
-
setLong
public void setLong(long index, long value) Description copied from interface:UpdatablePArraySets the element #index with conversion from long, as (xxx)value for numeric element type xxx (byte, short, int, long, float, double or char), or as value!=0 for boolean element type.Depending on the specific subinterface implemented by the object, this method is equivalent to one of the following calls:
- for
UpdatableBitArray:setBit(index, value != 0); - for
UpdatableCharArray:setChar(index, (char) value); - for
UpdatableByteArray:setByte(index, (byte) value); - for
UpdatableShortArray:setShort(index, (short) value); - for
UpdatableLongArray: the same method is already declared in this interface; - for
UpdatableFloatArray:setFloat(index, (float) value); - for
UpdatableDoubleArray:setDouble(index, (double) value).
- Specified by:
setLongin interfaceUpdatablePArray- Parameters:
index- index of element to replace.value- element to be stored at the specified position.- See Also:
- for
-
setInt
public void setInt(long index, int value) Description copied from interface:UpdatablePArraySets the element #index with conversion from int, as (xxx)value for numeric element type xxx (byte, short, int, long, float, double or char), or as value!=0 for boolean element type.This method is equivalent to both
setLong(index, (long) value)andsetDouble(index, (double) value), but can work little faster.- Specified by:
setIntin interfaceUpdatablePArray- Parameters:
index- index of element to replace.value- element to be stored at the specified position.- See Also:
-
setChar
public abstract void setChar(long index, char value) Description copied from interface:UpdatableCharArraySets the element #index to specified value.- Specified by:
setCharin interfaceUpdatableCharArray- Parameters:
index- index of element to replace.value- element to be stored at the specified position.
-
fill
This implementation just callsfill(0, thisArray.length(), value).- Specified by:
fillin interfaceUpdatablePArray- Parameters:
value- the value to be stored in all elements of the array.- Returns:
- a reference to this array.
- See Also:
-
fill
This implementation just callsfill(position, count, (char)value).- Specified by:
fillin interfaceUpdatablePArray- 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
This implementation just callsfill(0, thisArray.length(), value).- Specified by:
fillin interfaceUpdatablePArray- Parameters:
value- the value to be stored in all elements of the array.- Returns:
- a reference to this array.
- See Also:
-
fill
This implementation just callsfill(position, count, (char)value).- Specified by:
fillin interfaceUpdatablePArray- 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
This implementation just callsfill(0, thisArray.length(), value).- Specified by:
fillin interfaceUpdatableCharArray- Parameters:
value- the value to be stored in all elements of the array.- Returns:
- a reference to this array.
- See Also:
-
fill
This implementation does the following:subArr(position, count).copy(Arrays.nCharCopies(count, value)). Please override this method if it's possible to perform the same task more efficiently.- Specified by:
fillin interfaceUpdatableCharArray- 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:
-
isImmutable
public boolean isImmutable()This implementation returns false.- Specified by:
isImmutablein interfaceArray- Overrides:
isImmutablein classAbstractCharArray- Returns:
- true if this instance is immutable.
- See Also:
-
asImmutable
This implementation returns an instance of the subclass ofAbstractCharArray, where the following method are overridden and call the same methods of this instance:AbstractCharArray.getChar(long),AbstractCharArray.getData(long, Object, int, int),AbstractCharArray.getData(long, Object),AbstractCharArray.loadResources(ArrayContext, long, long),AbstractCharArray.flushResources(ArrayContext, long, long, boolean)andAbstractCharArray.freeResources(ArrayContext, long, long, boolean).The returned instance also have overridden method
AbstractArray.isLazy(), that just calls the same methods of this instance with the same arguments.- Specified by:
asImmutablein interfaceArray- Specified by:
asImmutablein interfaceCharArray- Specified by:
asImmutablein interfacePArray- Specified by:
asImmutablein interfacePFixedArray- Overrides:
asImmutablein classAbstractCharArray- Returns:
- an immutable view of this array.
- See Also:
-
shallowClone
This implementation returns (UpdatableArray)super.shallowClone().- Specified by:
shallowClonein interfaceArray- Specified by:
shallowClonein interfaceUpdatableArray- Overrides:
shallowClonein classAbstractArray- Returns:
- a shallow copy of this object.
- See Also:
-
setElement
This implementation calls setChar(index, (Character)value).charValue()).- Specified by:
setElementin interfaceUpdatableArray- 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 elementsClassCastException- if it is an array of primitive elements and value is not a corresponding wrapped class (Boolean, Integer, etc.)ArrayStoreException- if it is an array of non-primitive elements and value is not an instance ofAbstractCharArray.elementType()class
-
setData
This implementation is based on a loop of calls ofsetChar(long, char)method. Please override this method if it's possible to perform the same task more efficiently than such a loop.- Specified by:
setDatain interfaceUpdatableArray- Parameters:
arrayPos- starting position in this AlgART array.srcArray- the source Java array.srcArrayOffset- starting position in the source Java array.count- the number of elements to be copied.- Returns:
- a reference to this AlgART array.
- Throws:
NullPointerException- if srcArray argument is null.IllegalArgumentException- if srcArray argument is not an array.IndexOutOfBoundsException- if copying would cause access of data outside this array or source Java array.ArrayStoreException- if destArray element type mismatches with this arrayelementType().ClassCastException- if destArray element type mismatches with this arrayelementType()(both this and ArrayStoreException are possible, depending on implementation).- See Also:
-
setData
This implementation callssetData(long, Object, int, int)with corresponding arguments.- Specified by:
setDatain interfaceUpdatableArray- Parameters:
arrayPos- starting position in this AlgART array.srcArray- the source Java array.- Returns:
- a reference to this AlgART array.
- Throws:
NullPointerException- if srcArray argument is null.IllegalArgumentException- if srcArray argument is not an array.IndexOutOfBoundsException- if copying would cause access of data outside this array or source Java array.ArrayStoreException- if destArray element type mismatches with this arrayAbstractCharArray.elementType().ClassCastException- if destArray element type mismatches with this arrayAbstractCharArray.elementType()(both this and ArrayStoreException are possible, depending on implementation).- See Also:
-
copy
public void copy(long destIndex, long srcIndex) This implementation calls setChar(destIndex, getChar(srcIndex)).- Specified by:
copyin interfaceUpdatableArray- Parameters:
destIndex- index of element to replace.srcIndex- index of element to be copied.- Throws:
IndexOutOfBoundsException- if one of indexes is out of range 0..length()-1.
-
copy
public void copy(long destIndex, long srcIndex, long count) This implementation is based on a loop of calls ofcopy(long, long)method.- Specified by:
copyin interfaceUpdatableArray- Parameters:
destIndex- starting index of element to replace.srcIndex- starting index of element to be copied.count- the number of elements to be copied.- Throws:
IndexOutOfBoundsException- if one of indexes is out of range 0..length()-1.
-
swap
public void swap(long firstIndex, long secondIndex) This implementation swaps two elements byAbstractCharArray.getChar(long)andsetChar(long, char)methods.- Specified by:
swapin interfaceArrayExchanger- Specified by:
swapin interfaceUpdatableArray- Parameters:
firstIndex- first index of element to exchange.secondIndex- second index of element to exchange.- Throws:
IndexOutOfBoundsException- if one of indexes is out of range 0..length()-1.
-
swap
public void swap(long firstIndex, long secondIndex, long count) This implementation is based on a loop of calls ofswap(long, long)method.- Specified by:
swapin interfaceUpdatableArray- Parameters:
firstIndex- starting first index of element to exchange.secondIndex- starting second index of element to exchange.count- the number of elements to be exchanged.- Throws:
IndexOutOfBoundsException- if one of indexes is out of range 0..length()-1.
-
copy
This implementation callsdefaultCopy(thisInstance, src).- Specified by:
copyin interfaceUpdatableArray- Parameters:
src- the source array.- Returns:
- a reference to this array.
- Throws:
NullPointerException- if src argument is null.IllegalArgumentException- if the source and this element types do not match.- See Also:
-
swap
This implementation callsdefaultSwap(thisInstance, another).- Specified by:
swapin interfaceUpdatableArray- Parameters:
another- another array.- Returns:
- a reference to this array.
- Throws:
NullPointerException- if another argument is null.IllegalArgumentException- if another and this element types do not match.
-
setNonNew
public void setNonNew()This implementation callssetNewStatus(false).- Specified by:
setNonNewin interfaceUpdatableArray
-
asCopyOnNextWrite
This implementation returnsupdatableClone(Arrays.SMM).- Specified by:
asCopyOnNextWritein interfaceArray- Specified by:
asCopyOnNextWritein interfaceUpdatableArray- Overrides:
asCopyOnNextWritein classAbstractCharArray- Returns:
- a copy of this object.
- See Also:
-
asUnresizable
This implementation returns this object. Should be overridden if the inheritor is resizable.- Specified by:
asUnresizablein interfaceUpdatableArray- Specified by:
asUnresizablein interfaceUpdatableCharArray- Specified by:
asUnresizablein interfaceUpdatablePArray- Specified by:
asUnresizablein interfaceUpdatablePFixedArray- Returns:
- an unresizable view of this array.
- See Also:
-
toString
Description copied from interface:ArrayReturns a brief string description of this object.The result of this method may depend on implementation and usually contains a short description of the array length, capacity, element type.
Note: for
character arrays, unlike CharSequence.toString(), this method works as for all other array types. If you need to convert a character array to a string, containing all characters of the array, you may useArrays.toString(CharArray)method.- Specified by:
toStringin interfaceArray- Overrides:
toStringin classAbstractCharArray- Returns:
- a brief string description of this object.
-