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

The portmanteau Reference Manual

This is the portmanteau Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:34:54 2024 GMT+0.

Table of Contents

Next: Systems, Previous: The portmanteau Reference Manual, Up: The portmanteau Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The portmanteau Reference Manual [Contents][Index]

2 Systems

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

portmanteau

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

2.1 `portmanteau`

cl-portmanteau

Author: Sergey Polzunov <sergey@polzunov.com>
License: OSI approved 3-clause ’New BSD License’
Dependency: vom (system).
Source: portmanteau.asd.
Child Component: portmanteau.lisp (file).

Next: Packages, Previous: Systems, Up: The portmanteau 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]

3.1 Lisp

portmanteau/portmanteau.asd
portmanteau/portmanteau.lisp

Next: portmanteau/portmanteau.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `portmanteau/portmanteau.asd`

Source: portmanteau.asd.
Parent Component: portmanteau (system).
ASDF Systems: portmanteau.

Previous: portmanteau/portmanteau.asd, Up: Lisp [Contents][Index]

3.1.2 `portmanteau/portmanteau.lisp`

Source

portmanteau.asd.

Parent Component

portmanteau (system).

Packages

Public Interface

portmanteau (function).

Internals

*margin* (special variable).
*min-word-size* (special variable).
calculate-max-window-size (function).
contains-vowel (function).
filter-out-without-vowels (function).
find-matches (function).
is-far-enough-from-end (function).
is-far-enough-from-start (function).
is-long-enough (function).
merge-words (function).
run-moving-window (function).
valid-result (function).

Next: Definitions, Previous: Files, Up: The portmanteau Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

portmanteau

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

4.1 `portmanteau`

Source

portmanteau.lisp.

Use List

common-lisp.

Public Interface

portmanteau (function).

Internals

*margin* (special variable).
*min-word-size* (special variable).
calculate-max-window-size (function).
contains-vowel (function).
filter-out-without-vowels (function).
find-matches (function).
is-far-enough-from-end (function).
is-far-enough-from-start (function).
is-long-enough (function).
merge-words (function).
run-moving-window (function).
valid-result (function).

Next: Indexes, Previous: Packages, Up: The portmanteau 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

Ordinary functions

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

5.1.1 Ordinary functions

Function: portmanteau (word-a word-b &key max-win-size) ¶

Calculate portmanteau of 2 input words

Package: portmanteau.
Source: portmanteau.lisp.

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

5.2 Internals

Special variables
Ordinary functions

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

5.2.1 Special variables

Special Variable: *margin* ¶

Package: portmanteau.
Source: portmanteau.lisp.

Special Variable: *min-word-size* ¶

Package: portmanteau.
Source: portmanteau.lisp.

Previous: Special variables, Up: Internals [Contents][Index]

5.2.2 Ordinary functions

Function: calculate-max-window-size (word-a word-b) ¶

Calulate max matching window size from the size
of input words by dividing length of the longest word by 3. The result must not be less than 3

Package: portmanteau.
Source: portmanteau.lisp.

Function: contains-vowel (word) ¶

Package: portmanteau.
Source: portmanteau.lisp.

Function: filter-out-without-vowels (seq) ¶

Package: portmanteau.
Source: portmanteau.lisp.

Function: find-matches (seq-a seq-b word-b-size) ¶

Package: portmanteau.
Source: portmanteau.lisp.

Function: is-far-enough-from-end (idx elem word-len) ¶

Check if the beginning of an element is placed no closer than *margin* from the end of the string

Package: portmanteau.
Source: portmanteau.lisp.

Function: is-far-enough-from-start (idx elem) ¶

Check if the end of an element is placed no closer than *margin* from the beginning of the string

Package: portmanteau.
Source: portmanteau.lisp.

Function: is-long-enough (word &key size) ¶

Package: portmanteau.
Source: portmanteau.lisp.

Function: merge-words (word-a index-a word-b index-b) ¶

Package: portmanteau.
Source: portmanteau.lisp.

Function: run-moving-window (word size) ¶

Package: portmanteau.
Source: portmanteau.lisp.

Function: valid-result (result word-a word-b) ¶

Validate result word.
Criteria:
- result must not be smaller than one of the input words

Package: portmanteau.
Source: portmanteau.lisp.

Previous: Definitions, Up: The portmanteau 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 F I M P R V

	Index Entry		Section

C
	`calculate-max-window-size`:		Private ordinary functions
	`contains-vowel`:		Private ordinary functions

F
	`filter-out-without-vowels`:		Private ordinary functions
	`find-matches`:		Private ordinary functions
	`Function, calculate-max-window-size`:		Private ordinary functions
	`Function, contains-vowel`:		Private ordinary functions
	`Function, filter-out-without-vowels`:		Private ordinary functions
	`Function, find-matches`:		Private ordinary functions
	`Function, is-far-enough-from-end`:		Private ordinary functions
	`Function, is-far-enough-from-start`:		Private ordinary functions
	`Function, is-long-enough`:		Private ordinary functions
	`Function, merge-words`:		Private ordinary functions
	`Function, portmanteau`:		Public ordinary functions
	`Function, run-moving-window`:		Private ordinary functions
	`Function, valid-result`:		Private ordinary functions

I
	`is-far-enough-from-end`:		Private ordinary functions
	`is-far-enough-from-start`:		Private ordinary functions
	`is-long-enough`:		Private ordinary functions

M
	`merge-words`:		Private ordinary functions

P
	`portmanteau`:		Public ordinary functions

R
	`run-moving-window`:		Private ordinary functions

V
	`valid-result`:		Private ordinary functions

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

A.3 Variables

Jump to:	* S

	Index Entry		Section

*
	`margin`:		Private special variables
	`min-word-size`:		Private special variables

S
	`Special Variable, margin`:		Private special variables
	`Special Variable, min-word-size`:		Private special variables

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

A.4 Data types

Jump to:	F P S

	Index Entry		Section

F
	`File, portmanteau.asd`:		The portmanteau/portmanteau․asd file
	`File, portmanteau.lisp`:		The portmanteau/portmanteau․lisp file

P
	`Package, portmanteau`:		The portmanteau package
	`portmanteau`:		The portmanteau system
	`portmanteau`:		The portmanteau package
	`portmanteau.asd`:		The portmanteau/portmanteau․asd file
	`portmanteau.lisp`:		The portmanteau/portmanteau․lisp file

S
	`System, portmanteau`:		The portmanteau system