The com.clearly-useful.iterate+ Reference Manual

Table of Contents

The com.clearly-useful.iterate+ Reference Manual

This is the com.clearly-useful.iterate+ Reference Manual, version 0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 15:43:26 2021 GMT+0.

1 Introduction

#+TITLE: iterate extensions for seqs and iterators in common lisp

* com.clearly-useful.iterate+

  *Overview*:
    This package provides a new keyword for iterate, =per=,
   and four styles of iteration:

   =(iter (per x in y))=
   similar to doseq, binds x to each element of
   the result of calling =seq= on y.

   =(iter (per x on y))=
   similar to =loop .. on=, binds x to subsequent
   =tails= of the result of calling =seq= on y.

   =(iter (per x across y))=
   similar to =loop .. across=, calls =indexable= on y,
   and loops by index below =count-elements= binding x to
   subsequent values of =element-at=
   
   =(iter (per x of y))=
   similar to do-iterator, calls =iterator= on
   y, and binds x to subsequent values it produces.  ensures that
   =iterator-finish!= is called.  since =iterator= provides a default
   implementation for =seq=, =indexable=, and =associative=, any of
   those may also be used in a =per ... of= clause.

   *Usage*:
     This package is intended to be used with iterate. Since
    Iterate tests clauses on symbol-equality, this package
    will have no effect unless you explicitly :use it, e.g.

    #+begin_src lisp
      (defpackage #:foo
        (:use #:cl
              #:iterate
              #:com.clearly-useful.iterate+))
    #+end_src
    
* Exported symbols
  this package exports two symbols.
  
** per
   /iterate driver/

** of
   /iterate keyword/

2 Systems

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

2.1 com.clearly-useful.iterate+

Author

Jason Aeschliman <j.aeschliman@gmail.com>

License

revised BSD

Description

iterate extensions for the sequence and iterator protocols

Version

0.1

Dependencies

• com.clearly-useful.protocols
• com.clearly-useful.generic-collection-interface
• com.clearly-useful.iterator-protocol
• iterate

Source

com.clearly-useful.iterate+.asd (file)

Components

• package.lisp (file)
• com.clearly-useful.iterate+.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 com.clearly-useful.iterate+.asd

Location

com.clearly-useful.iterate+.asd

Systems

com.clearly-useful.iterate+ (system)

3.1.2 com.clearly-useful.iterate+/package.lisp

Parent

com.clearly-useful.iterate+ (system)

Location

package.lisp

Packages

com.clearly-useful.iterate+

3.1.3 com.clearly-useful.iterate+/com.clearly-useful.iterate+.lisp

Dependency

package.lisp (file)

Parent

com.clearly-useful.iterate+ (system)

Location

com.clearly-useful.iterate+.lisp

Internal Definitions

• clause-per-across-3 (macro)
• clause-per-in-1 (macro)
• clause-per-of-4 (macro)
• clause-per-on-2 (macro)

4 Packages

Packages are listed by definition order.

4.1 com.clearly-useful.iterate+

Source

package.lisp (file)

Use List

• iterate
• com.clearly-useful.iterator-protocol
• com.clearly-useful.generic-collection-interface
• common-lisp

Internal Definitions

• clause-per-across-3 (macro)
• clause-per-in-1 (macro)
• clause-per-of-4 (macro)
• clause-per-on-2 (macro)

5 Definitions

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

5.1 Internal definitions

5.1.1 Macros

Macro: clause-per-across-3 &key (PER V) (ACROSS S)

Package

com.clearly-useful.iterate+

Source

com.clearly-useful.iterate+.lisp (file)

Macro: clause-per-in-1 &key (PER V) (IN S)

Package

com.clearly-useful.iterate+

Source

com.clearly-useful.iterate+.lisp (file)

Macro: clause-per-of-4 &key (PER V) (OF S)

Package

com.clearly-useful.iterate+

Source

com.clearly-useful.iterate+.lisp (file)

Macro: clause-per-on-2 &key (PER V) (ON S)

Package

com.clearly-useful.iterate+

Source

com.clearly-useful.iterate+.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types