The cl-parallel Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The cl-parallel Reference Manual

This is the cl-parallel Reference Manual, version 0.1.1, generated automatically by Declt version 2.3 "Robert April" on Tue Jan 09 13:54:28 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Systems

The main system appears first, followed by any subsystem dependency.


Previous: , Up: Systems   [Contents][Index]

1.1 cl-parallel

Author

Tom Hulihan

License

MIT

Description

A fairly simple parallelism library for Common Lisp

Version

0.1.1

Dependency

bordeaux-threads

Source

cl-parallel.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

2 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

2.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

2.1.1 cl-parallel.asd

Location

cl-parallel.asd

Systems

cl-parallel (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

2.1.2 cl-parallel/src/package.lisp

Parent

cl-parallel (system)

Location

src/package.lisp

Packages

parallel


Next: , Previous: , Up: Lisp files   [Contents][Index]

2.1.3 cl-parallel/src/future.lisp

Dependencies
Parent

cl-parallel (system)

Location

src/future.lisp

Exported Definitions

Previous: , Up: Lisp files   [Contents][Index]

2.1.4 cl-parallel/src/list.lisp

Dependencies
Parent

cl-parallel (system)

Location

src/list.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

3 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

3.1 parallel

Source

src/package.lisp (file)

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

4.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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 (file)

Macro: par-calls &rest CALLS

Make multiple calls in parallel.

Package

parallel

Source

src/list.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

4.1.2 Functions

Function: future-finished-p F

Return true iff the argument is a live thread

Package

parallel

Source

src/future.lisp (file)

Function: future-p F

Test whether or not a value is a future.

Package

parallel

Source

src/future.lisp (file)

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 (file)

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 (file)

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 (file)

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 (file)

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 (file)

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 (file)

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 (file)

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 (file)

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 (file)


Previous: , Up: Definitions   [Contents][Index]

4.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

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 (file)

Macro: with-thread-queue LST (IN OUT) &key MAX-THREADS SLEEP-TIME DONE DOWN UP
Package

parallel

Source

src/list.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

4.2.2 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 (file)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
cl-parallel.asd: The cl-parallel<dot>asd file
cl-parallel/src/future.lisp: The cl-parallel/src/future<dot>lisp file
cl-parallel/src/list.lisp: The cl-parallel/src/list<dot>lisp file
cl-parallel/src/package.lisp: The cl-parallel/src/package<dot>lisp file

F
File, Lisp, cl-parallel.asd: The cl-parallel<dot>asd file
File, Lisp, cl-parallel/src/future.lisp: The cl-parallel/src/future<dot>lisp file
File, Lisp, cl-parallel/src/list.lisp: The cl-parallel/src/list<dot>lisp file
File, Lisp, cl-parallel/src/package.lisp: The cl-parallel/src/package<dot>lisp file

L
Lisp File, cl-parallel.asd: The cl-parallel<dot>asd file
Lisp File, cl-parallel/src/future.lisp: The cl-parallel/src/future<dot>lisp file
Lisp File, cl-parallel/src/list.lisp: The cl-parallel/src/list<dot>lisp file
Lisp File, cl-parallel/src/package.lisp: The cl-parallel/src/package<dot>lisp file

Jump to:   C   F   L  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   F   M   P   R   W  
Index Entry  Section

F
Function, future-finished-p: Exported functions
Function, future-p: Exported functions
Function, par-every: Exported functions
Function, par-find: Exported functions
Function, par-find-if: Exported functions
Function, par-map: Exported functions
Function, par-map-chunked: Exported functions
Function, par-map-reduce: Exported functions
Function, par-some: Exported functions
Function, partition-if: Internal functions
Function, realize: Exported functions
Function, realize-if-finished: Exported functions
future: Exported macros
future-finished-p: Exported functions
future-p: Exported functions

M
Macro, future: Exported macros
Macro, par-calls: Exported macros
Macro, with-sequential-thread-queue: Internal macros
Macro, with-thread-queue: Internal macros

P
par-calls: Exported macros
par-every: Exported functions
par-find: Exported functions
par-find-if: Exported functions
par-map: Exported functions
par-map-chunked: Exported functions
par-map-reduce: Exported functions
par-some: Exported functions
partition-if: Internal functions

R
realize: Exported functions
realize-if-finished: Exported functions

W
with-sequential-thread-queue: Internal macros
with-thread-queue: Internal macros

Jump to:   F   M   P   R   W  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables


Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   P   S  
Index Entry  Section

C
cl-parallel: The cl-parallel system

P
Package, parallel: The parallel package
parallel: The parallel package

S
System, cl-parallel: The cl-parallel system

Jump to:   C   P   S