Package net.algart.arrays

Class AbstractUpdatableDoubleArray

java.lang.Object

net.algart.arrays.AbstractArray

net.algart.arrays.AbstractDoubleArray

net.algart.arrays.AbstractUpdatableDoubleArray

All Implemented Interfaces:

Cloneable, Array, ArrayExchanger, DoubleArray, PArray, PFloatingArray, PNumberArray, UpdatableArray, UpdatableDoubleArray, UpdatablePArray, UpdatablePFloatingArray, UpdatablePNumberArray

public abstract class AbstractUpdatableDoubleArray
extends AbstractDoubleArray
implements UpdatableDoubleArray

Implementation of almost all basic functions of UpdatableDoubleArray interface. The only DoubleArray.getDouble(long) and UpdatableDoubleArray.setDouble(long, double) 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

Constructors

Modifier	Constructor	Description
protected	AbstractUpdatableDoubleArray(long initialCapacityAndLength, boolean underlyingArraysAreParallel, Array... underlyingArrays)	Equivalent to the constructor AbstractUpdatableDoubleArray(long, long, boolean, Array...), where both initialCapacity and initialLength arguments are equal to initialCapacityAndLength.
protected	AbstractUpdatableDoubleArray(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	Description
UpdatableArray	asCopyOnNextWrite()	This implementation returns updatableClone(Arrays.SMM).
DoubleArray	asImmutable()	This implementation returns an instance of the subclass of AbstractDoubleArray, where the following method are overridden and call the same methods of this instance: AbstractDoubleArray.getDouble(long), AbstractDoubleArray.getData(long, Object, int, int), AbstractDoubleArray.getData(long, Object), AbstractDoubleArray.loadResources(ArrayContext, long, long), AbstractDoubleArray.flushResources(ArrayContext, long, long, boolean) and AbstractDoubleArray.freeResources(ArrayContext, long, long, boolean).
UpdatableDoubleArray	asUnresizable()	This implementation returns this object.
void	copy(long destIndex, long srcIndex)	This implementation calls setDouble(destIndex, getDouble(srcIndex)).
void	copy(long destIndex, long srcIndex, long count)	This implementation is based on a loop of calls of copy(long, long) method.
UpdatableArray	copy(Array src)	This implementation calls defaultCopy(thisInstance, src).
final UpdatableDoubleArray	fill(double value)	This implementation just calls fill(0, thisArray.length(), value).
final UpdatableDoubleArray	fill(long value)	This implementation just calls fill(0, thisArray.length(), value).
UpdatableDoubleArray	fill(long position, long count, double value)	This implementation does the following: subArr(position, count).copy(Arrays.nDoubleCopies(count, value)).
UpdatableDoubleArray	fill(long position, long count, long value)	This implementation just calls fill(position, count, (double)value).
boolean	isImmutable()	This implementation returns false.
UpdatableArray	setData(long arrayPos, Object srcArray)	This implementation calls setData(long, Object, int, int) with corresponding arguments.
UpdatableArray	setData(long arrayPos, Object srcArray, int srcArrayOffset, int count)	This implementation is based on a loop of calls of setDouble(long, double) method.
abstract void	setDouble(long index, double value)	Sets the element #index to specified value.
void	setElement(long index, Object value)	This implementation calls setDouble(index, (Double)value).doubleValue()).
void	setInt(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.
void	setLong(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.
void	setNonNew()	This implementation calls setNewStatus(false).
UpdatableArray	shallowClone()	This implementation returns (UpdatableArray)super.shallowClone().
UpdatableDoubleArray	subArr(long position, long count)	This implementation returns subArray(position, position + count).
UpdatableDoubleArray	subArray(long fromIndex, long toIndex)	This implementation returns new instance of AbstractUpdatableDoubleArray with the same memory model and underlying arrays, that were passed to the constructor of this instance, and with overridden methods AbstractDoubleArray.getDouble(long), setDouble(long, double), AbstractDoubleArray.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 AbstractDoubleArray.getDouble(long) and setDouble(long, double) 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).
String	toString()	Returns a brief string description of this object.

Methods inherited from class net.algart.arrays.AbstractDoubleArray

asTrustedImmutable, bitsPerElement, buffer, buffer, buffer, buffer, checkUnallowedMutation, elementType, flushResources, flushResources, freeResources, freeResources, getData, getData, getDouble, getElement, indexOf, isCopyOnNextWrite, isUnresizable, ja, lastIndexOf, loadResources, loadResources, maxPossibleValue, 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.Array

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

Methods inherited from interface net.algart.arrays.DoubleArray

asTrustedImmutable, buffer, buffer, buffer, buffer, getDouble, indexOf, ja, jaDouble, lastIndexOf, mutableClone, mutableType, type, updatableClone, updatableType

Methods inherited from interface net.algart.arrays.PArray

bitsPerElement, isZeroFilled, jaByte, jaFloat, jaInt, jaLong, jaShort, maxPossibleValue, minPossibleValue

Methods inherited from interface net.algart.arrays.UpdatableDoubleArray

matrix

Methods inherited from interface net.algart.arrays.UpdatablePArray

updatableType

Constructor Details

AbstractUpdatableDoubleArray

protected AbstractUpdatableDoubleArray(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 AbstractDoubleArray(long, long, boolean, Array...).

underlyingArrays - see the same argument of AbstractArray(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.

AbstractUpdatableDoubleArray

protected AbstractUpdatableDoubleArray(long initialCapacityAndLength,
 boolean underlyingArraysAreParallel,
 Array... underlyingArrays)

Equivalent to the constructor AbstractUpdatableDoubleArray(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 AbstractUpdatableDoubleArray(long, long, boolean, Array...).

underlyingArrays - see AbstractUpdatableDoubleArray(long, long, boolean, Array...)

Throws:

IllegalArgumentException - if the passed argument are illegal (negative).

Method Details

subArray

public UpdatableDoubleArray subArray(long fromIndex,
 long toIndex)

This implementation returns new instance of AbstractUpdatableDoubleArray with the same memory model and underlying arrays, that were passed to the constructor of this instance, and with overridden methods AbstractDoubleArray.getDouble(long), setDouble(long, double), AbstractDoubleArray.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 AbstractDoubleArray.loadResources(ArrayContext, long, long), AbstractDoubleArray.flushResources(ArrayContext, long, long, boolean) and AbstractDoubleArray.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 UpdatableDoubleArray

Specified by:

subArray in interface UpdatablePArray

Specified by:

subArray in interface UpdatablePFloatingArray

Overrides:

subArray in class AbstractDoubleArray

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:

• Array.subArr(long, long)

subArr

public UpdatableDoubleArray 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 UpdatableDoubleArray

Specified by:

subArr in interface UpdatablePArray

Specified by:

subArr in interface UpdatablePFloatingArray

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)

setLong

public void setLong(long index,
 long value)

Description copied from interface: UpdatablePArray

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.

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:

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 void setInt(long index,
 int value)

Description copied from interface: UpdatablePArray

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.

This method is equivalent to both setLong(index, (long) value) and setDouble(index, (double) value), but can work little faster.

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)

setDouble

public abstract void setDouble(long index,
 double value)

Description copied from interface: UpdatableDoubleArray

Sets the element #index to specified value.

Specified by:

setDouble in interface UpdatableDoubleArray

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)

fill

public final UpdatableDoubleArray 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 UpdatableDoubleArray fill(long position,
 long count,
 long value)

This implementation just calls fill(position, count, (double)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:

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

See Also:

• UpdatablePArray.fill(long)
• Arrays.zeroFill(UpdatableArray)

fill

public final UpdatableDoubleArray fill(double value)

This implementation just calls fill(0, thisArray.length(), value).

Specified by:

fill in interface UpdatableDoubleArray

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:

• UpdatableDoubleArray.fill(long, long, double)
• Arrays.zeroFill(UpdatableArray)

fill

public UpdatableDoubleArray fill(long position,
 long count,
 double value)

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

Specified by:

fill in interface UpdatableDoubleArray

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:

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

See Also:

• UpdatableDoubleArray.fill(double)
• Arrays.zeroFill(UpdatableArray)

isImmutable

public boolean isImmutable()

This implementation returns false.

Specified by:

isImmutable in interface Array

Overrides:

isImmutable in class AbstractDoubleArray

Returns:

true if this instance is immutable.

See Also:

• Array.asImmutable()

asImmutable

public DoubleArray asImmutable()

This implementation returns an instance of the subclass of AbstractDoubleArray, where the following method are overridden and call the same methods of this instance: AbstractDoubleArray.getDouble(long), AbstractDoubleArray.getData(long, Object, int, int), AbstractDoubleArray.getData(long, Object), AbstractDoubleArray.loadResources(ArrayContext, long, long), AbstractDoubleArray.flushResources(ArrayContext, long, long, boolean) and AbstractDoubleArray.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 DoubleArray

Specified by:

asImmutable in interface PArray

Specified by:

asImmutable in interface PFloatingArray

Overrides:

asImmutable in class AbstractDoubleArray

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,
 Object value)

This implementation calls setDouble(index, (Double)value).doubleValue()).

Specified by:

setElement in interface UpdatableArray

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

ClassCastException - 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 of AbstractDoubleArray.elementType() class

setData

public UpdatableArray setData(long arrayPos,
 Object srcArray,
 int srcArrayOffset,
 int count)

This implementation is based on a loop of calls of setDouble(long, double) 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:

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 array elementType().

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,
 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:

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 array AbstractDoubleArray.elementType().

ClassCastException - if destArray element type mismatches with this array AbstractDoubleArray.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 setDouble(destIndex, getDouble(srcIndex)).

Specified by:

copy in interface UpdatableArray

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 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:

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 AbstractDoubleArray.getDouble(long) and setDouble(long, double) 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:

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:

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:

NullPointerException - if src argument is null.

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:

NullPointerException - if another argument is null.

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 AbstractDoubleArray

Returns:

a copy of this object.

See Also:

• Array.isCopyOnNextWrite()
• MemoryModel.newLazyCopy(Array)
• MemoryModel.newUnresizableLazyCopy(Array)

asUnresizable

public UpdatableDoubleArray 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 UpdatableDoubleArray

Specified by:

asUnresizable in interface UpdatablePArray

Specified by:

asUnresizable in interface UpdatablePFloatingArray

Returns:

an unresizable view of this array.

See Also:

• Array.isUnresizable()

toString

public 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 AbstractDoubleArray

Returns:

a brief string description of this object.