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

The cl-itertools Reference Manual

This is the cl-itertools Reference Manual, version 0.2, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 05:03:19 2024 GMT+0.

Next: Systems, Previous: The cl-itertools Reference Manual, Up: The cl-itertools Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The cl-itertools Reference Manual [Contents][Index]

2 Systems

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

cl-itertools

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

2.1 `cl-itertools`

itertools Python lib ported to CL

Author

Alexandr Popolitov <popolit@gmail.com>

License

MIT

Version

0.2

Dependencies

cl-coroutine (system).
iterate (system).
alexandria (system).

Source

cl-itertools.asd.

Child Components

package.lisp (file).
cl-itertools.lisp (file).

Next: Packages, Previous: Systems, Up: The cl-itertools Reference Manual [Contents][Index]

3 Files

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

Lisp

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

Next: cl-itertools/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `cl-itertools/cl-itertools.asd`

Source: cl-itertools.asd.
Parent Component: cl-itertools (system).
ASDF Systems: cl-itertools.
Packages: cl-itertools-system.

Next: cl-itertools/cl-itertools.lisp, Previous: cl-itertools/cl-itertools.asd, Up: Lisp [Contents][Index]

3.1.2 `cl-itertools/package.lisp`

Source: cl-itertools.asd.
Parent Component: cl-itertools (system).
Packages: cl-itertools.

Previous: cl-itertools/package.lisp, Up: Lisp [Contents][Index]

3.1.3 `cl-itertools/cl-itertools.lisp`

Dependency

package.lisp (file).

Source

cl-itertools.asd.

Parent Component

cl-itertools (system).

Public Interface

coexit! (macro).
collect-iter (function).
def-launched-iter (macro).
defiter (macro).
ichain (function).
icompress (function).
icount (function).
icycle (function).
idropwhile (function).
ifilter (function).
ifilterfalse (function).
igroupby (function).
imap (function).
inext (macro).
inext-noexit (macro).
inext-or-error (macro).
irange (function).
irepeat (function).
istarmap (function).
itakewhile (function).
izip (function).
izip-longest (function).
lambda-coro (macro).
mk-iter (generic function).
stop-iteration (condition).

Internals

clause-for-in-coro-1 (macro).
clause-for-in-it-2 (macro).
i-coro (reader method).
(setf i-coro) (writer method).
i-printing-count (function).
iterator (class).
parse-out-keywords (function).

Next: Definitions, Previous: Files, Up: The cl-itertools Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

cl-itertools
cl-itertools-system

Next: cl-itertools-system, Previous: Packages, Up: Packages [Contents][Index]

4.1 `cl-itertools`

Source

package.lisp.

Use List

cl-coroutine.
common-lisp.
iterate.

Public Interface

coexit! (macro).
collect-iter (function).
def-launched-iter (macro).
defiter (macro).
ichain (function).
icompress (function).
icount (function).
icycle (function).
idropwhile (function).
ifilter (function).
ifilterfalse (function).
igroupby (function).
imap (function).
inext (macro).
inext-noexit (macro).
inext-or-error (macro).
irange (function).
irepeat (function).
istarmap (function).
itakewhile (function).
izip (function).
izip-longest (function).
lambda-coro (macro).
mk-iter (generic function).
stop-iteration (condition).

Internals

clause-for-in-coro-1 (macro).
clause-for-in-it-2 (macro).
i-coro (generic reader).
(setf i-coro) (generic writer).
i-printing-count (function).
iterator (class).
parse-out-keywords (function).

Previous: cl-itertools, Up: Packages [Contents][Index]

4.2 `cl-itertools-system`

Source

cl-itertools.asd.

Use List

asdf/interface.
common-lisp.

Next: Indexes, Previous: Packages, Up: The cl-itertools Reference Manual [Contents][Index]

5 Definitions

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

Public Interface
Internals

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

5.1 Public Interface

Macros
Ordinary functions
Generic functions
Conditions

Next: Ordinary functions, Previous: Public Interface, Up: Public Interface [Contents][Index]

5.1.1 Macros

Macro: coexit! () ¶

Package: cl-itertools.
Source: cl-itertools.lisp.

Macro: def-launched-iter (name args &body body) ¶

Package: cl-itertools.
Source: cl-itertools.lisp.

Macro: defiter (name args &body body) ¶

Package: cl-itertools.
Source: cl-itertools.lisp.

Macro: inext (iter-var &optional arg) ¶

Iter is supposed to be created using DEFITER or MK-ITER – hence its coro always accepts an arg.

Package: cl-itertools.
Source: cl-itertools.lisp.

Macro: inext-noexit (iter-var &optional arg) ¶

Like INEXT, only when iterator is depleted, return (VALUES NIL NIL) and don’t COEXIT.

Package: cl-itertools.
Source: cl-itertools.lisp.

Macro: inext-or-error (iter-var &optional arg) ¶

Package: cl-itertools.
Source: cl-itertools.lisp.

Macro: lambda-coro (&body body) ¶

The coroutine argument is passed through YIELD macro.

Package: cl-itertools.
Source: cl-itertools.lisp.

Next: Generic functions, Previous: Macros, Up: Public Interface [Contents][Index]

5.1.2 Ordinary functions

Function: collect-iter (thing) ¶

Package: cl-itertools.
Source: cl-itertools.lisp.

Function: ichain (&rest things) ¶

Package: cl-itertools.
Source: cl-itertools.lisp.

Function: icompress (data selectors) ¶

Package: cl-itertools.
Source: cl-itertools.lisp.

Function: icount (start &optional step) ¶

start, start + step, start + 2*step, ...

Package: cl-itertools.
Source: cl-itertools.lisp.

Function: icycle (p) ¶

p0, p1, ... plast, p0, p1, ...

Package: cl-itertools.
Source: cl-itertools.lisp.

Function: idropwhile (pred seq) ¶

Package: cl-itertools.
Source: cl-itertools.lisp.

Function: ifilter (pred seq) ¶

Package: cl-itertools.
Source: cl-itertools.lisp.

Function: ifilterfalse (pred seq) ¶

Package: cl-itertools.
Source: cl-itertools.lisp.

Function: igroupby (iterable &optional key) ¶

Package: cl-itertools.
Source: cl-itertools.lisp.

Function: imap (func &rest things) ¶

Package: cl-itertools.
Source: cl-itertools.lisp.

Function: irange (&rest args) ¶

Package: cl-itertools.
Source: cl-itertools.lisp.

Function: irepeat (elem &optional n) ¶

elem, elem, elem, ... endlessly or up to n times

Package: cl-itertools.
Source: cl-itertools.lisp.

Function: istarmap (func seq) ¶

Package: cl-itertools.
Source: cl-itertools.lisp.

Function: itakewhile (pred seq) ¶

Package: cl-itertools.
Source: cl-itertools.lisp.

Function: izip (&rest things) ¶

Package: cl-itertools.
Source: cl-itertools.lisp.

Function: izip-longest (&rest things) ¶

Package: cl-itertools.
Source: cl-itertools.lisp.

Next: Conditions, Previous: Ordinary functions, Up: Public Interface [Contents][Index]

5.1.3 Generic functions

Generic Function: mk-iter (thing) ¶

Package

cl-itertools.

Source

cl-itertools.lisp.

Methods

Method: mk-iter ((thing vector)) ¶

Method: mk-iter ((thing string)) ¶

Method: mk-iter ((thing list)) ¶

Method: mk-iter ((thing function)) ¶

Method: mk-iter ((thing iterator)) ¶

Method: mk-iter (thing) ¶

Previous: Generic functions, Up: Public Interface [Contents][Index]

5.1.4 Conditions

Condition: stop-iteration ¶

Package: cl-itertools.
Source: cl-itertools.lisp.
Direct superclasses: error.

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

5.2 Internals

Macros
Ordinary functions
Generic functions
Classes

Next: Ordinary functions, Previous: Internals, Up: Internals [Contents][Index]

5.2.1 Macros

Macro: clause-for-in-coro-1 (&key for in-coro with-arg generate) ¶

Package: cl-itertools.
Source: cl-itertools.lisp.

Macro: clause-for-in-it-2 (&key for in-it with-arg generate) ¶

Package: cl-itertools.
Source: cl-itertools.lisp.

Next: Generic functions, Previous: Macros, Up: Internals [Contents][Index]

5.2.2 Ordinary functions

Function: i-printing-count (start &optional step) ¶

Package: cl-itertools.
Source: cl-itertools.lisp.

Function: parse-out-keywords (kwd-lst lambda-list) ¶

Return list (KWD1 KWD2 ... KWDn . OTHER-ARGS) collecting all keyword-looking pairs of arguments in lambda list

Package: cl-itertools.
Source: cl-itertools.lisp.

Next: Classes, Previous: Ordinary functions, Up: Internals [Contents][Index]

5.2.3 Generic functions

Generic Reader: i-coro (object) ¶

Package

cl-itertools.

Methods

Reader Method: i-coro ((iterator iterator)) ¶

automatically generated reader method

Source: cl-itertools.lisp.
Target Slot: coro.

Generic Writer: (setf i-coro) (object) ¶

Package

cl-itertools.

Methods

Writer Method: (setf i-coro) ((iterator iterator)) ¶

automatically generated writer method

Source: cl-itertools.lisp.
Target Slot: coro.

Previous: Generic functions, Up: Internals [Contents][Index]

5.2.4 Classes

Class: iterator ¶

Package

cl-itertools.

Source

cl-itertools.lisp.

Direct methods

(setf i-coro).
i-coro.
mk-iter.

Direct slots

Slot: coro ¶

Initargs: :coro
Readers: i-coro.
Writers: (setf i-coro).

Previous: Definitions, Up: The cl-itertools Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

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

A.1 Concepts

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

A.2 Functions

Jump to:	( C D F G I L M P

	Index Entry	Section

(
	`(setf i-coro)`:	Private generic functions
	`(setf i-coro)`:	Private generic functions

C
	`clause-for-in-coro-1`:	Private macros
	`clause-for-in-it-2`:	Private macros
	`coexit!`:	Public macros
	`collect-iter`:	Public ordinary functions

D
	`def-launched-iter`:	Public macros
	`defiter`:	Public macros

F
	`Function, collect-iter`:	Public ordinary functions
	`Function, i-printing-count`:	Private ordinary functions
	`Function, ichain`:	Public ordinary functions
	`Function, icompress`:	Public ordinary functions
	`Function, icount`:	Public ordinary functions
	`Function, icycle`:	Public ordinary functions
	`Function, idropwhile`:	Public ordinary functions
	`Function, ifilter`:	Public ordinary functions
	`Function, ifilterfalse`:	Public ordinary functions
	`Function, igroupby`:	Public ordinary functions
	`Function, imap`:	Public ordinary functions
	`Function, irange`:	Public ordinary functions
	`Function, irepeat`:	Public ordinary functions
	`Function, istarmap`:	Public ordinary functions
	`Function, itakewhile`:	Public ordinary functions
	`Function, izip`:	Public ordinary functions
	`Function, izip-longest`:	Public ordinary functions
	`Function, parse-out-keywords`:	Private ordinary functions

G
	`Generic Function, (setf i-coro)`:	Private generic functions
	`Generic Function, i-coro`:	Private generic functions
	`Generic Function, mk-iter`:	Public generic functions

I
	`i-coro`:	Private generic functions
	`i-coro`:	Private generic functions
	`i-printing-count`:	Private ordinary functions
	`ichain`:	Public ordinary functions
	`icompress`:	Public ordinary functions
	`icount`:	Public ordinary functions
	`icycle`:	Public ordinary functions
	`idropwhile`:	Public ordinary functions
	`ifilter`:	Public ordinary functions
	`ifilterfalse`:	Public ordinary functions
	`igroupby`:	Public ordinary functions
	`imap`:	Public ordinary functions
	`inext`:	Public macros
	`inext-noexit`:	Public macros
	`inext-or-error`:	Public macros
	`irange`:	Public ordinary functions
	`irepeat`:	Public ordinary functions
	`istarmap`:	Public ordinary functions
	`itakewhile`:	Public ordinary functions
	`izip`:	Public ordinary functions
	`izip-longest`:	Public ordinary functions

L
	`lambda-coro`:	Public macros

M
	`Macro, clause-for-in-coro-1`:	Private macros
	`Macro, clause-for-in-it-2`:	Private macros
	`Macro, coexit!`:	Public macros
	`Macro, def-launched-iter`:	Public macros
	`Macro, defiter`:	Public macros
	`Macro, inext`:	Public macros
	`Macro, inext-noexit`:	Public macros
	`Macro, inext-or-error`:	Public macros
	`Macro, lambda-coro`:	Public macros
	`Method, (setf i-coro)`:	Private generic functions
	`Method, i-coro`:	Private generic functions
	`Method, mk-iter`:	Public generic functions
	`Method, mk-iter`:	Public generic functions
	`Method, mk-iter`:	Public generic functions
	`Method, mk-iter`:	Public generic functions
	`Method, mk-iter`:	Public generic functions
	`Method, mk-iter`:	Public generic functions
	`mk-iter`:	Public generic functions
	`mk-iter`:	Public generic functions
	`mk-iter`:	Public generic functions
	`mk-iter`:	Public generic functions
	`mk-iter`:	Public generic functions
	`mk-iter`:	Public generic functions
	`mk-iter`:	Public generic functions

P
	`parse-out-keywords`:	Private ordinary functions

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Jump to:	C S

	Index Entry	Section

C
	`coro`:	Private classes

S
	`Slot, coro`:	Private classes

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

A.4 Data types

Jump to:	C F I P S

	Index Entry	Section

C
	`cl-itertools`:	The cl-itertools system
	`cl-itertools`:	The cl-itertools package
	`cl-itertools-system`:	The cl-itertools-system package
	`cl-itertools.asd`:	The cl-itertools/cl-itertools․asd file
	`cl-itertools.lisp`:	The cl-itertools/cl-itertools․lisp file
	`Class, iterator`:	Private classes
	`Condition, stop-iteration`:	Public conditions

F
	`File, cl-itertools.asd`:	The cl-itertools/cl-itertools․asd file
	`File, cl-itertools.lisp`:	The cl-itertools/cl-itertools․lisp file
	`File, package.lisp`:	The cl-itertools/package․lisp file

I
	`iterator`:	Private classes

P
	`Package, cl-itertools`:	The cl-itertools package
	`Package, cl-itertools-system`:	The cl-itertools-system package
	`package.lisp`:	The cl-itertools/package․lisp file

S
	`stop-iteration`:	Public conditions
	`System, cl-itertools`:	The cl-itertools system

The cl-itertools Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 cl-itertools

3 Files

3.1 Lisp

3.1.1 cl-itertools/cl-itertools.asd

3.1.2 cl-itertools/package.lisp

3.1.3 cl-itertools/cl-itertools.lisp

4 Packages

4.1 cl-itertools

4.2 cl-itertools-system

5 Definitions

5.1 Public Interface

5.1.1 Macros

5.1.2 Ordinary functions

5.1.3 Generic functions

5.1.4 Conditions

5.2 Internals

5.2.1 Macros

5.2.2 Ordinary functions

5.2.3 Generic functions

5.2.4 Classes

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `cl-itertools`

3.1.1 `cl-itertools/cl-itertools.asd`

3.1.2 `cl-itertools/package.lisp`

3.1.3 `cl-itertools/cl-itertools.lisp`

4.1 `cl-itertools`

4.2 `cl-itertools-system`