The cl-parallel Reference Manual

2.1.1 cl-parallel/cl-parallel.asd

Source

cl-parallel.asd.

Parent Component

cl-parallel (system).

ASDF Systems

cl-parallel.

---

2.1.2 cl-parallel/src/package.lisp

Source

cl-parallel.asd.

Parent Component

cl-parallel (system).

Packages

parallel.

---

2.1.3 cl-parallel/src/future.lisp

Dependency

src/package.lisp (file).

Source

cl-parallel.asd.

Parent Component

cl-parallel (system).

Public Interface

• future (macro).
• future-finished-p (function).
• future-p (function).
• realize (function).
• realize-if-finished (function).

---

2.1.4 cl-parallel/src/list.lisp

Dependencies

• src/package.lisp (file).
• src/future.lisp (file).

Source

cl-parallel.asd.

Parent Component

cl-parallel (system).

Public Interface

• par-calls (macro).
• par-every (function).
• par-find (function).
• par-find-if (function).
• par-map (function).
• par-map-chunked (function).
• par-map-reduce (function).
• par-some (function).

Internals

• partition-if (function).
• with-sequential-thread-queue (macro).
• with-thread-queue (macro).

---

4.1.1 Macros

Macro: future (&rest body) ¶

This macro essentially creates a new future type – a computation that happens seperately from the rest of the program, and may or may not be finished

Package

parallel.

Source

src/future.lisp.

Macro: par-calls (&rest calls) ¶

Make multiple calls in parallel.

Package

parallel.

Source

src/list.lisp.

---

4.1.2 Ordinary functions

Function: future-finished-p (f) ¶

Return true iff the argument is a live thread

Package

parallel.

Source

src/future.lisp.

Function: future-p (f) ¶

Test whether or not a value is a future.

Package

parallel.

Source

src/future.lisp.

Function: par-every (pred xs &key max-threads sleep-time) ¶

Given a predicate and a list, will determine if every element of the list satisfies that predicate.

Package

parallel.

Source

src/list.lisp.

Function: par-find (item xs &key max-threads from-end) ¶

Given an item and a list, will return that item if it is found, nil otherwise.

Package

parallel.

Source

src/list.lisp.

Function: par-find-if (pred xs &key max-threads key from-end) ¶

Given a predicate and a list, will return the first element in the list that satisfies that predicate.

Package

parallel.

Source

src/list.lisp.

Function: par-map (f xs &key max-threads sleep-time) ¶

This function computes a function upon a list in parallel.

Package

parallel.

Source

src/list.lisp.

Function: par-map-chunked (f xs &key chunk-size max-threads sleep-time) ¶

Break a list up into ‘size‘ chunks, and process those chunks in parallel.

Package

parallel.

Source

src/list.lisp.

Function: par-map-reduce (map-fn reduce-fn xs &key max-threads sleep-time initial-value) ¶

Given a mapping function, reducing function, and list, will map the values accross the list in parallel, then reduce them in the order that the computations finish.

Package

parallel.

Source

src/list.lisp.

Function: par-some (pred xs &key max-threads sleep-time) ¶

Given a predicate and a list, return true if at least one element in the list satifies the predicate.

Package

parallel.

Source

src/list.lisp.

Function: realize (f) ¶

Force a future to be evaluated, or return nil if the value is not a future.

Package

parallel.

Source

src/future.lisp.

Function: realize-if-finished (f) ¶

If the future is finished, return the value; if the future is still running, return the future; if the value is not a future, return it.

Package

parallel.

Source

src/future.lisp.

---

4.2.1 Macros

Macro: with-sequential-thread-queue (lst (to-do running) &key max-threads done down up) ¶

Package

parallel.

Source

src/list.lisp.

Macro: with-thread-queue (lst (in out) &key max-threads sleep-time done down up) ¶

Package

parallel.

Source

src/list.lisp.

---

4.2.2 Ordinary functions

Function: partition-if (pred xs) ¶

Given a predicate and a list, will return a list with the first element being all of the elements that satisfy the predicate, and the second element being all of the elements that do not satisfy the predicate.

Package

parallel.

Source

src/list.lisp.

---