Overview  Package   Class  Tree  Deprecated  Index  Help 
AlgART Home
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

net.algart.arrays
Class AbstractUpdatableIntArray

java.lang.Object
  extended by net.algart.arrays.AbstractArray
      extended by net.algart.arrays.AbstractIntArray
          extended by net.algart.arrays.AbstractUpdatableIntArray
All Implemented Interfaces:
java.lang.Cloneable, Array, ArrayExchanger, IntArray, PArray, PFixedArray, PIntegerArray, PNumberArray, UpdatableArray, UpdatableIntArray, UpdatablePArray, UpdatablePFixedArray, UpdatablePIntegerArray, UpdatablePNumberArray
public abstract class AbstractUpdatableIntArray
extends AbstractIntArray
implements UpdatableIntArray

Implementation of almost all basic functions of UpdatableIntArray interface. The only IntArray.getInt(long) and UpdatableIntArray.setInt(long, int) methods are not defined in this class; all other methods are implemented via calls of these 2 methods.

AlgART Laboratory 2007-2013

Since:
JDK 1.5
Version:
1.2
Author:
Daniel Alievsky

Field Summary
Modifier and Type Field and Description
 
Fields inherited from class net.algart.arrays.AbstractArray
capacity, length, underlyingArrays
 
Constructor Summary
Modifier Constructor and Description
protected AbstractUpdatableIntArray(long initialCapacityAndLength, boolean underlyingArraysAreParallel, Array... underlyingArrays)
          Equivalent to the constructor AbstractUpdatableIntArray(long, long, boolean, Array...), where both initialCapacity and initialLength arguments are equal to initialCapacityAndLength.
protected AbstractUpdatableIntArray(long initialCapacity, long initialLength, boolean underlyingArraysAreParallel, Array... underlyingArrays)
          Creates an updatable array with the given initial capacity and length.
 
Method Summary
Modifier and Type Method and Description
 UpdatableArray asCopyOnNextWrite()
          This implementation returns updatableClone(Arrays.SMM).
 IntArray asImmutable()
          This implementation returns an instance of the subclass of AbstractIntArray, where the following method are overridden and call the same methods of this instance: AbstractIntArray.getInt(long), AbstractIntArray.getData(long, Object, int, int), AbstractIntArray.getData(long, Object), AbstractIntArray.loadResources(ArrayContext, long, long), AbstractIntArray.flushResources(ArrayContext, long, long, boolean) and AbstractIntArray.freeResources(ArrayContext, long, long, boolean).
 UpdatableIntArray asUnresizable()
          This implementation returns this object.
 UpdatableArray copy(Array src)
          This implementation calls defaultCopy(thisInstance, src).
 void copy(long destIndex, long srcIndex)
          This implementation calls setInt(destIndex, getInt(srcIndex)).
 void copy(long destIndex, long srcIndex, long count)
          This implementation is based on a loop of calls of copy(long, long) method.
 UpdatableIntArray fill(double value)
          This implementation just calls fill(0, thisArray.length(), value).
 UpdatableIntArray fill(int value)
          This implementation just calls fill(0, thisArray.length(), value).
 UpdatableIntArray fill(long value)
          This implementation just calls fill(0, thisArray.length(), value).
 UpdatableIntArray fill(long position, long count, double value)
          This implementation just calls fill(position, count, (int)value).
 UpdatableIntArray fill(long position, long count, int value)
          This implementation does the following: subArr(position, count).copy(Arrays.nIntCopies(count, value)).
 UpdatableIntArray fill(long position, long count, long value)
          This implementation just calls fill(position, count, (int)value).
 boolean isImmutable()
          This implementation returns false.
 UpdatableArray setData(long arrayPos, java.lang.Object srcArray)
          This implementation calls setData(long, Object, int, int) with corresponding arguments.
 UpdatableArray setData(long arrayPos, java.lang.Object srcArray, int srcArrayOffset, int count)
          This implementation is based on a loop of calls of setInt(long, int) method.
 void setDouble(long index, double value)
          Sets the element #index by convertion 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.
 void setElement(long index, java.lang.Object value)
          This implementation calls setInt(index, (Integer)value).intValue()).
abstract  void setInt(long index, int value)
          Sets the element #index to specified value.
 void setLong(long index, long value)
          Sets the element #index by convertion 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.
 void setNonNew()
          This implementation calls setNewStatus(false).
 UpdatableArray shallowClone()
          This implementation returns (UpdatableArray)super.shallowClone().
 UpdatableIntArray subArr(long position, long count)
          This implementation returns subArray(position, position + count).
 UpdatableIntArray subArray(long fromIndex, long toIndex)
          This implementation returns new instance of AbstractUpdatableIntArray with the same memory model and underlying arrays, that were passed to the constructor of this instance, and with overridden methods AbstractIntArray.getInt(long), setInt(long, int), AbstractIntArray.getData(long, Object, int, int) and setData(long, Object, int, int) calling the same methods of this instance with corresponding corrections of the arguments.
 void swap(long firstIndex, long secondIndex)
          This implementation swaps two elements by AbstractIntArray.getInt(long) and setInt(long, int) methods.
 void swap(long firstIndex, long secondIndex, long count)
          This implementation is based on a loop of calls of swap(long, long) method.
 UpdatableArray swap(UpdatableArray another)
          This implementation calls defaultSwap(thisInstance, another).
 java.lang.String toString()
          Returns a brief string description of this object.
 
Methods inherited from class net.algart.arrays.AbstractIntArray
asTrustedImmutable, bitsPerElement, buffer, buffer, buffer, buffer, checkUnallowedMutation, elementType, flushResources, flushResources, freeResources, freeResources, getData, getData, getDouble, getElement, getInt, getLong, indexOf, indexOf, indexOf, isCopyOnNextWrite, isUnresizable, lastIndexOf, lastIndexOf, lastIndexOf, loadResources, loadResources, maxPossibleValue, maxPossibleValue, minPossibleValue, minPossibleValue, mutableClone, mutableType, type, updatableClone, updatableType
 
Methods 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, standardObjectClone
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface net.algart.arrays.IntArray
asTrustedImmutable, buffer, buffer, buffer, buffer, getInt, indexOf, lastIndexOf, mutableClone, mutableType, type, updatableClone, updatableType
 
Methods inherited from interface net.algart.arrays.PFixedArray
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
byteOrder, capacity, checkUnallowedMutation, elementType, equals, flushResources, flushResources, freeResources, freeResources, getData, getData, getElement, hashCode, isCopyOnNextWrite, isLazy, isNew, isNewReadOnlyView, isUnresizable, length, loadResources, newJavaArray
 

Constructor Detail

AbstractUpdatableIntArray

protected AbstractUpdatableIntArray(long initialCapacity,
                                    long initialLength,
                                    boolean underlyingArraysAreParallel,
                                    Array... underlyingArrays)
Creates an updatable array with the given initial capacity and length.

This array is not new by 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 call setNewStatus(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 of AbstractIntArray.AbstractIntArray(long, long, boolean, Array...).
underlyingArrays - see the same argument of AbstractArray.AbstractArray(long, long, Array...).
Throws:
java.lang.NullPointerException - if underlyingArrays argument or some of underlyingArrays[k] elements is null.
java.lang.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.

AbstractUpdatableIntArray

protected AbstractUpdatableIntArray(long initialCapacityAndLength,
                                    boolean underlyingArraysAreParallel,
                                    Array... underlyingArrays)
Equivalent to the constructor AbstractUpdatableIntArray(long, long, boolean, Array...), where both initialCapacity and initialLength arguments are equal to initialCapacityAndLength.

Parameters:
initialCapacityAndLength - initial capacity and length of the array.
underlyingArraysAreParallel - see AbstractUpdatableIntArray(long, long, boolean, Array...).
underlyingArrays - see AbstractUpdatableIntArray(long, long, boolean, Array...)
Throws:
java.lang.IllegalArgumentException - if the passed argument are illegal (negative).
Method Detail

subArray

public UpdatableIntArray subArray(long fromIndex,
                                  long toIndex)
This implementation returns new instance of AbstractUpdatableIntArray with the same memory model and underlying arrays, that were passed to the constructor of this instance, and with overridden methods AbstractIntArray.getInt(long), setInt(long, int), AbstractIntArray.getData(long, Object, int, int) and setData(long, Object, int, int) calling the same methods of this instance with corresponding corrections of the arguments.

The returned instance also have overridden methods AbstractIntArray.loadResources(ArrayContext, long, long), AbstractIntArray.flushResources(ArrayContext, long, long, boolean) and AbstractIntArray.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:
subArray in interface Array
Specified by:
subArray in interface UpdatableArray
Specified by:
subArray in interface UpdatableIntArray
Specified by:
subArray in interface UpdatablePArray
Specified by:
subArray in interface UpdatablePFixedArray
Specified by:
subArray in interface UpdatablePIntegerArray
Overrides:
subArray in class AbstractIntArray
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:
java.lang.IndexOutOfBoundsException - for illegal fromIndex and toIndex (fromIndex < 0 || toIndex > length() || fromIndex > toIndex).
See Also:
Array.subArr(long, long)

subArr

public UpdatableIntArray subArr(long position,
                                long count)
Description copied from class: AbstractArray
This implementation returns subArray(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:
subArr in interface Array
Specified by:
subArr in interface UpdatableArray
Specified by:
subArr in interface UpdatableIntArray
Specified by:
subArr in interface UpdatablePArray
Specified by:
subArr in interface UpdatablePFixedArray
Specified by:
subArr in interface UpdatablePIntegerArray
Overrides:
subArr in class AbstractArray
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)

setDouble

public void setDouble(long index,
                      double value)
Description copied from interface: UpdatablePArray
Sets the element #index by convertion 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.

Specified by:
setDouble in interface UpdatablePArray
Parameters:
index - index of element to replace.
value - element to be stored at the specified position.
See Also:
PArray.getDouble(long)

setLong

public void setLong(long index,
                    long value)
Description copied from interface: UpdatablePArray
Sets the element #index by convertion 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.

Specified by:
setLong in interface UpdatablePArray
Parameters:
index - index of element to replace.
value - element to be stored at the specified position.
See Also:
PFixedArray.getLong(long)

setInt

public abstract void setInt(long index,
                            int value)
Description copied from interface: UpdatableIntArray
Sets the element #index to specified value.

Specified by:
setInt in interface UpdatableIntArray
Specified by:
setInt in interface UpdatablePArray
Parameters:
index - index of element to replace.
value - element to be stored at the specified position.
See Also:
PFixedArray.getInt(long)

fill

public final UpdatableIntArray fill(double value)
This implementation just calls fill(0, thisArray.length(), value).

Specified by:
fill in interface UpdatablePArray
Parameters:
value - the value to be stored in all elements of the array.
Returns:
a reference to this array.
See Also:
UpdatablePArray.fill(long, long, double), Arrays.zeroFill(UpdatableArray)

fill

public UpdatableIntArray fill(long position,
                              long count,
                              double value)
This implementation just calls fill(position, count, (int)value).

Specified by:
fill in interface UpdatablePArray
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:
java.lang.IndexOutOfBoundsException - for illegal position and count (position < 0 || count < 0 || position + count > length()).
See Also:
UpdatablePArray.fill(double), Arrays.zeroFill(UpdatableArray)

fill

public final UpdatableIntArray fill(long value)
This implementation just calls fill(0, thisArray.length(), value).

Specified by:
fill in interface UpdatablePArray
Parameters:
value - the value to be stored in all elements of the array.
Returns:
a reference to this array.
See Also:
UpdatablePArray.fill(long, long, long), Arrays.zeroFill(UpdatableArray)

fill

public UpdatableIntArray fill(long position,
                              long count,
                              long value)
This implementation just calls fill(position, count, (int)value).

Specified by:
fill in interface UpdatablePArray
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:
java.lang.IndexOutOfBoundsException - for illegal position and count (position < 0 || count < 0 || position + count > length()).
See Also:
UpdatablePArray.fill(long), Arrays.zeroFill(UpdatableArray)

fill

public final UpdatableIntArray fill(int value)
This implementation just calls fill(0, thisArray.length(), value).

Specified by:
fill in interface UpdatableIntArray
Parameters:
value - the value to be stored in all elements of the array.
Returns:
a reference to this array.
See Also:
UpdatableIntArray.fill(long, long, int), Arrays.zeroFill(UpdatableArray)

fill

public UpdatableIntArray fill(long position,
                              long count,
                              int value)
This implementation does the following: subArr(position, count).copy(Arrays.nIntCopies(count, value)). Please override this method if it's possible to perform the same task more efficiently.

Specified by:
fill in interface UpdatableIntArray
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:
java.lang.IndexOutOfBoundsException - for illegal position and count (position < 0 || count < 0 || position + count > length()).
See Also:
UpdatableIntArray.fill(int), Arrays.zeroFill(UpdatableArray)

isImmutable

public boolean isImmutable()
This implementation returns false.

Specified by:
isImmutable in interface Array
Overrides:
isImmutable in class AbstractIntArray
Returns:
true if this instance is immutable.
See Also:
Array.asImmutable()

asImmutable

public IntArray asImmutable()
This implementation returns an instance of the subclass of AbstractIntArray, where the following method are overridden and call the same methods of this instance: AbstractIntArray.getInt(long), AbstractIntArray.getData(long, Object, int, int), AbstractIntArray.getData(long, Object), AbstractIntArray.loadResources(ArrayContext, long, long), AbstractIntArray.flushResources(ArrayContext, long, long, boolean) and AbstractIntArray.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:
asImmutable in interface Array
Specified by:
asImmutable in interface IntArray
Specified by:
asImmutable in interface PArray
Specified by:
asImmutable in interface PFixedArray
Specified by:
asImmutable in interface PIntegerArray
Overrides:
asImmutable in class AbstractIntArray
Returns:
an immutable view of this array.
See Also:
Array.isImmutable(), Array.asTrustedImmutable(), Array.mutableClone(MemoryModel), Array.updatableClone(MemoryModel), UpdatableArray.asUnresizable()

shallowClone

public UpdatableArray shallowClone()
This implementation returns (UpdatableArray)super.shallowClone().

Specified by:
shallowClone in interface Array
Specified by:
shallowClone in interface UpdatableArray
Overrides:
shallowClone in class AbstractArray
Returns:
a shallow copy of this object.
See Also:
Array.length(), Array.capacity(), DirectAccessible.javaArrayOffset(), Array.isCopyOnNextWrite()

setElement

public void setElement(long index,
                       java.lang.Object value)
This implementation calls setInt(index, (Integer)value).intValue()).

Specified by:
setElement in interface UpdatableArray
Parameters:
index - index of element to replace.
value - element to be stored at the specified position.
Throws:
java.lang.IndexOutOfBoundsException - if index is out of range 0..length()-1.
java.lang.NullPointerException - if value == null and it is an array of primitive elements
java.lang.ClassCastException - if it is an array of primitive elements and value is not a corresponding wrapped class (Boolean, Integer, etc.)
java.lang.ArrayStoreException - if it is an array of non-primitive elements and value is not an instance of AbstractIntArray.elementType() class

setData

public UpdatableArray setData(long arrayPos,
                              java.lang.Object srcArray,
                              int srcArrayOffset,
                              int count)
This implementation is based on a loop of calls of setInt(long, int) method. Please override this method if it's possible to perform the same task more efficiently than such a loop.

Specified by:
setData in interface UpdatableArray
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:
java.lang.NullPointerException - if srcArray argument is null.
java.lang.IllegalArgumentException - if srcArray argument is not an array.
java.lang.IndexOutOfBoundsException - if copying would cause access of data outside this array or source Java array.
java.lang.ArrayStoreException - if destArray element type mismatches with this array elementType().
java.lang.ClassCastException - if destArray element type mismatches with this array elementType() (both this and ArrayStoreException are possible, depending on implementation).
See Also:
DirectAccessible, Array.getData(long, Object, int, int)

setData

public UpdatableArray setData(long arrayPos,
                              java.lang.Object srcArray)
This implementation calls setData(long, Object, int, int) with corresponding arguments.

Specified by:
setData in interface UpdatableArray
Parameters:
arrayPos - starting position in this AlgART array.
srcArray - the source Java array.
Returns:
a reference to this AlgART array.
Throws:
java.lang.NullPointerException - if srcArray argument is null.
java.lang.IllegalArgumentException - if srcArray argument is not an array.
java.lang.IndexOutOfBoundsException - if copying would cause access of data outside this array or source Java array.
java.lang.ArrayStoreException - if destArray element type mismatches with this array AbstractIntArray.elementType().
java.lang.ClassCastException - if destArray element type mismatches with this array AbstractIntArray.elementType() (both this and ArrayStoreException are possible, depending on implementation).
See Also:
DirectAccessible, UpdatableArray.setData(long, Object, int, int), Array.getData(long, Object), UpdatableBitArray.setBits(long, long[], long, long)

copy

public void copy(long destIndex,
                 long srcIndex)
This implementation calls setInt(destIndex, getInt(srcIndex)).

Specified by:
copy in interface UpdatableArray
Parameters:
destIndex - index of element to replace.
srcIndex - index of element to be copied.
Throws:
java.lang.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 of copy(long, long) method.

Specified by:
copy in interface UpdatableArray
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:
java.lang.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 by AbstractIntArray.getInt(long) and setInt(long, int) methods.

Specified by:
swap in interface ArrayExchanger
Specified by:
swap in interface UpdatableArray
Parameters:
firstIndex - first index of element to exchange.
secondIndex - second index of element to exchange.
Throws:
java.lang.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 of swap(long, long) method.

Specified by:
swap in interface UpdatableArray
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:
java.lang.IndexOutOfBoundsException - if one of indexes is out of range 0..length()-1.

copy

public UpdatableArray copy(Array src)
This implementation calls defaultCopy(thisInstance, src).

Specified by:
copy in interface UpdatableArray
Parameters:
src - the source array.
Returns:
a reference to this array.
Throws:
java.lang.NullPointerException - if src argument is null.
java.lang.IllegalArgumentException - if the source and this element types do not match.
See Also:
Arrays.copy(ArrayContext, UpdatableArray, Array)

swap

public UpdatableArray swap(UpdatableArray another)
This implementation calls defaultSwap(thisInstance, another).

Specified by:
swap in interface UpdatableArray
Parameters:
another - another array.
Returns:
a reference to this array.
Throws:
java.lang.NullPointerException - if another argument is null.
java.lang.IllegalArgumentException - if another and this element types do not match.

setNonNew

public void setNonNew()
This implementation calls setNewStatus(false).

Specified by:
setNonNew in interface UpdatableArray

asCopyOnNextWrite

public UpdatableArray asCopyOnNextWrite()
This implementation returns updatableClone(Arrays.SMM).

Specified by:
asCopyOnNextWrite in interface Array
Specified by:
asCopyOnNextWrite in interface UpdatableArray
Overrides:
asCopyOnNextWrite in class AbstractIntArray
Returns:
a copy of this object.
See Also:
Array.isCopyOnNextWrite(), MemoryModel.newLazyCopy(Array), MemoryModel.newUnresizableLazyCopy(Array)

asUnresizable

public UpdatableIntArray asUnresizable()
This implementation returns this object. Should be overridden if the inheritor is resizable.

Specified by:
asUnresizable in interface UpdatableArray
Specified by:
asUnresizable in interface UpdatableIntArray
Specified by:
asUnresizable in interface UpdatablePArray
Specified by:
asUnresizable in interface UpdatablePFixedArray
Specified by:
asUnresizable in interface UpdatablePIntegerArray
Returns:
an unresizable view of this array.
See Also:
Array.isUnresizable()

toString

public java.lang.String toString()
Description copied from interface: Array
Returns 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 use Arrays.toString(CharArray) method.

Specified by:
toString in interface Array
Overrides:
toString in class AbstractIntArray
Returns:
a brief string description of this object.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD