Gpseq

---

Description:

Content:

Namespaces:

• Collectors - Various collector implementations.
• Compares
• Overflow

Interfaces:

• Channel - Multi-producer multi-consumer channels. Channels are the pipes that provide communication between threads.
• ChannelBase - A base interface for senders and receivers.
• Collector - An object for mutable reduction operation that accumulates input elements into a mutable accumulator, and transforms it into a final result.
• Executor - An object that executes tasks. the execution is performed sequentially or in parallel, depending on the executor implementation.
• Receiver - The receiver side of a channel.
• Result - A result object that holds a value or an error.
• Sender - The sender side of a channel.
• Spliterator - An object for traversing and partitioning elements of a data source.
• Supplier - An object that supplies results.
• Task - A task that will be executed by a Executor.
• ThreadFactory - An object that creates new worker threads.

Classes:

• ArraySpliterator - A spliterator of an array.
• ForkJoinTask - A base class for fork- join tasks that run within a worker pool.
• FuncTask - A function task.
• Future - A value which might not yet be available, but will be available at some point.
• GenericArraySpliterator - A spliterator of a generic array.
• IteratorSpliterator - A spliterator of an iterator.
• ListSpliterator - A spliterator of a list.
• Optional - A container object which may or may not contain a value.
• Promise - A promise allows to set a value or an exception with an associated future.
• Seq - A sequence of elements, supporting sequential and parallel operations.
• SpliteratorTask - A base class for spliterator based fork-join tasks.
• SubArray - An unowned slice of an array.
• SubArraySpliterator - A spliterator of a sub array.
• SupplierSpliterator - An infinite unordered spliterator, which each element is generated by a supplier.
• TaskEnv - An object to configure the environment of execution of tasks
• WaitGroup
• WorkerPool - A thread pool for executing tasks in parallel.
• WorkerThread - A worker thread.
• Wrapper - A wrapper object containing a value.

Structs:

• CacheLinePad

Enums:

• CollectorFeatures - Hints that can be used to optimize collect operations.

Error domains:

• ChannelError
• MapError
• OptionalError

Delegates:

• public delegate G CombineFunc<G> (owned G a, owned G b) throws Error
  Combines two values and returns the result.
• public delegate bool EachChunkFunc<G> (G[] chunk) throws Error
• public delegate Iterator<A> FlatMapFunc<A,G> (owned G g) throws Error
• public delegate A FoldFunc<A,G> (owned G g, owned A a) throws Error
• public delegate void Func<G> (G g) throws Error
• public delegate A MapFunc<A,G> (owned G g) throws Error
• public delegate bool Predicate<G> (G g) throws Error
• public delegate G SupplyFunc<G> ()
  A delegate that supplies results.
• public delegate G TaskFunc<G> () throws Error
• public delegate A TeeMergeFunc<A> (Object[] results) throws Error
  Merges the given results and returns the final result.
• public delegate void VoidFunc ()
• public delegate void VoidTaskFunc () throws Error

Functions:

• public int64 atomic_int64_add (ref int64 atomic, int64 val)
  Atomically adds val to the value of atomic.
• public uint64 atomic_int64_and (ref uint64 atomic, uint64 val)
  Performs an atomic bitwise 'and' of the value of atomic and val , storing the result back in atomic.
• public bool atomic_int64_compare_and_exchange (ref int64 atomic, int64 oldval, int64 newval)
  Compares atomic to oldval and, if equal, sets it to newval . If atomic was not equal to oldval then no change occurs.
• public bool atomic_int64_dec_and_test (ref int64 atomic)
  Decrements the value of atomic by 1.
• public int64 atomic_int64_get (ref int64 atomic)
  Gets the current value of atomic.
• public void atomic_int64_inc (ref int64 atomic)
  Increments the value of atomic by 1.
• public uint64 atomic_int64_or (ref uint64 atomic, uint64 val)
  Performs an atomic bitwise 'or' of the value of atomic and val , storing the result back in atomic.
• public void atomic_int64_set (ref int64 atomic, int64 newval)
  Sets the value of atomic to newval.
• public uint64 atomic_int64_xor (ref uint64 atomic, uint64 val)
  Performs an atomic bitwise 'xor' of the value of atomic and val , storing the result back in atomic.
• public void blocking (VoidTaskFunc func) throws Error
  Runs the given blocking task.
• public G blocking_get<G> (TaskFunc<G> func) throws Error
  Runs the given blocking task and returns the result.
• public G[] join<G> (owned TaskFunc<G> left, owned TaskFunc<G> right) throws Error
  Runs the subtasks and returns the results.
• public Future<void*> parallel_sort<G> (G[] array, owned CompareDataFunc<G>? compare = null)
  Sorts the given array by comparing with the specified compare function, in parallel. The sort is stable.
• public Future<void*> run (owned VoidTaskFunc func)
  Schedules the given function to execute asynchronously.
• public Future<G> task<G> (owned TaskFunc<G> func)
  Schedules the given function to execute asynchronously.