Package 

Interface AtomicArray64

  • All Implemented Interfaces:
    io.github.millibyte1.array64.Array64 , kotlin.collections.Iterable 
    
public interface AtomicArray64<E extends Object>
 implements Array64<E>

    An extension of the Array64 interface supporting atomic operations such as compareAndSet. Loosely based off the Jetbrains JDK implementation of atomic arrays.

    • Method Summary

      Modifier and Type Method Description
      abstract E get(Long index) Returns the element at the given index.
      abstract Unit set(Long index, E value) Sets the element at the given index to the given value.
      abstract E getAndSet(Long index, E new) Sets the element at position index to the given new value and returns the old value.
      abstract E getAndSet(Long index, Function1<E, E> transform) Sets the element at position index to the value resulting from applying the given transform to the old value.
      abstract E setAndGet(Long index, Function1<E, E> transform) Sets the element at position index to the resulting value from applying the given transform to the old value.
      abstract Boolean compareAndSet(Long index, E new, E expected) Sets the element at position index to the given new value if the current value matches expected.
      abstract Boolean compareAndSet(Long index, E new, Function2<E, E, Boolean> predicate) Sets the element at position index to the given new value if the provided predicate returns true when applied to the old and new values.
      abstract Unit lazySet(Long index, E value) Eventually sets the element at the given index to the given value.
      abstract AtomicArray64Iterator<E> iterator() Returns an iterator to the first element of this array which supports volatile and atomic operations.
      abstract AtomicArray64Iterator<E> iterator(Long index) Returns an iterator to the element at the given index which supports volatile and atomic operations.
      abstract Long size() The number of elements in this array.

      • Methods inherited from class io.github.millibyte1.array64.atomic.AtomicArray64

        copy

      • Methods inherited from class io.github.millibyte1.array64.Array64

        forEach, spliterator

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • get

         abstract E get(Long index)

        Returns the element at the given index. Volatile.

        Parameters:
        index - the index of the desired element

      • set

         abstract Unit set(Long index, E value)

        Sets the element at the given index to the given value. Volatile.

        Parameters:
        index - the index of the element to set
        value - the value to set the element to

      • getAndSet

         abstract E getAndSet(Long index, E new)

        Sets the element at position index to the given new value and returns the old value. Atomic.

        Parameters:
        index - the index of the element to set
        new - the value to set the element to

      • getAndSet

         abstract E getAndSet(Long index, Function1<E, E> transform)

        Sets the element at position index to the value resulting from applying the given transform to the old value. Atomic.

        Parameters:
        index - the index of the element to set
        transform - the pure (side effect-free) transform function to apply to the old value

      • setAndGet

         abstract E setAndGet(Long index, Function1<E, E> transform)

        Sets the element at position index to the resulting value from applying the given transform to the old value. Atomic.

        Parameters:
        index - the index of the element to set
        transform - the pure (side effect-free) transform function to apply to the old value

      • compareAndSet

         abstract Boolean compareAndSet(Long index, E new, E expected)

        Sets the element at position index to the given new value if the current value matches expected. Atomic.

        Parameters:
        index - the index of the element to try and set
        new - the value to set the element to
        expected - the expected value of the element

      • compareAndSet

         abstract Boolean compareAndSet(Long index, E new, Function2<E, E, Boolean> predicate)

        Sets the element at position index to the given new value if the provided predicate returns true when applied to the old and new values.

        Parameters:
        index - the index of the element to try and set
        new - the value to set the element to
        predicate - the binary predicate to apply to the old and new values to decide whether to update

      • lazySet

         abstract Unit lazySet(Long index, E value)

        Eventually sets the element at the given index to the given value. Depending on the implementation, may immediately perform a volatile write.

        Parameters:
        index - the index of the element to set
        value - the value to set the element to

      • iterator

         abstract AtomicArray64Iterator<E> iterator()

        Returns an iterator to the first element of this array which supports volatile and atomic operations.

      • size

         abstract Long size()

        The number of elements in this array.