The simple-parallel-tasks Reference Manual

Table of Contents

The simple-parallel-tasks Reference Manual

This is the simple-parallel-tasks Reference Manual, version 1.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Dec 02 11:20:04 2019 GMT+0.

1 Introduction

#+TITLE: simple-parallel-tasks

This is a simple Common Lisp library to evaluate some forms in parallel.

* Installation

/simple-parallel-tasks/ requires the /chanl/ library.

** With Quicklisp

#+BEGIN_SRC lisp
(ql:quickload "simple-parallel-tasks")
#+END_SRC

** With ASDF

Put the directories of /simple-parallel-tasks/ and the dependencies where
/ASDF/ can find them and use:

#+BEGIN_SRC lisp
(asdf:load-system "simple-parallel-tasks")
#+END_SRC

* API

#+BEGIN_SRC lisp
(defmacro plist (&rest forms))
#+END_SRC

Evaluate /forms/ in parallel and return the results in a list.

#+BEGIN_SRC lisp
(defmacro pvalues (&rest forms))
#+END_SRC

Evaluate /forms/ in parallel and return the results as multiple values.

#+BEGIN_SRC lisp
(defmacro plet (bindings &body body))
#+END_SRC

Like /let/, but the /bindings/ are evaluated in parallel.

* Examples

#+BEGIN_SRC lisp
(time (simple-parallel-tasks:plist 1 (+ 4 5) (sleep 2) 8 (sleep 1) (/ 3 5)))

Evaluation took:
  2.004 seconds of real time

(1 9 NIL 8 NIL 3/5)
#+END_SRC

#+BEGIN_SRC lisp
(time (simple-parallel-tasks:pvalues 1 (+ 4 5) (sleep 2) 8 (sleep 1) (/ 3 5)))

Evaluation took:
  2.007 seconds of real time

1
9
NIL
8
NIL
3/5
#+END_SRC

#+BEGIN_SRC lisp
(time (simple-parallel-tasks:plet ((x (sleep 2))
                                   (y (+ 3 4))
                                   a
                                   (b (sleep 3))
                                   (z (floor 12 5)))
        (list x y a b z)))

Evaluation took:
  3.0000 seconds of real time

(NIL 7 NIL NIL 2)
#+END_SRC

* Tests

The tests require the /fiveam/ library.

#+BEGIN_SRC lisp
(asdf:test-system "simple-parallel-tasks")
#+END_SRC

2 Systems

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

2.1 simple-parallel-tasks

Author

Guillaume Le Vaillant

License

GPL-3

Description

Evaluate forms in parallel

Version

1.0

Dependency

chanl

Source

simple-parallel-tasks.asd (file)

Component

simple-parallel-tasks.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 simple-parallel-tasks.asd

Location

simple-parallel-tasks.asd

Systems

simple-parallel-tasks (system)

3.1.2 simple-parallel-tasks/simple-parallel-tasks.lisp

Parent

simple-parallel-tasks (system)

Location

simple-parallel-tasks.lisp

Packages

simple-parallel-tasks

Exported Definitions

• plet (macro)
• plist (macro)
• pvalues (macro)

4 Packages

Packages are listed by definition order.

4.1 simple-parallel-tasks

Source

simple-parallel-tasks.lisp (file)

Use List

• chanl
• common-lisp

Exported Definitions

• plet (macro)
• plist (macro)
• pvalues (macro)

5 Definitions

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

5.1 Exported definitions

5.1.1 Macros

Macro: plet BINDINGS &body BODY

Like LET, but the BINDINGS are evaluated in parallel.

Package

simple-parallel-tasks

Source

simple-parallel-tasks.lisp (file)

Macro: plist &rest FORMS

Evaluate FORMS in parallel and return the results in a list.

Package

simple-parallel-tasks

Source

simple-parallel-tasks.lisp (file)

Macro: pvalues &rest FORMS

Evaluate FORMS in parallel and return the results as multiple values.

Package

simple-parallel-tasks

Source

simple-parallel-tasks.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types