The synonyms Reference Manual

Table of Contents

The synonyms Reference Manual

This is the synonyms Reference Manual, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 12:38:20 2018 GMT+0.

1 Introduction

                               SYNONYMS
                               ========

                           by Robert Smith

SYNONYMS is a package to provide synonyms to equivalent CL
functionality. It is a library existing for its utilitarian value, but
differs from other utility libraries in that it does not present any
new functionality, algorithms, or data structures to Common Lisp.

SYNONYMS provides synonyms for a variety of functional and stylistic
reasons. It provides synonyms that are

   * useful for readability's sake, such as TRUE and FALSE.
   * useful for functional programming, such as STRCAT
   * useful for particular styles of programming

Not all functionality provided by SYNONYMS are precise duplicates of
the functionality of another symbol in Common Lisp. For example,
NON-ZERO-P, a function useful for functional programming, does not
have a direct synonymous equivalent; it is defined as

    (not (zerop n)).

However, this is small enough and close enough to act as a synonym.

2 Systems

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

2.1 synonyms

Author

Robert Smith

License

Public Domain

Description

A package containing useful synonyms to Common Lisp functionalities.

Source

synonyms.asd (file)

Components

• package.lisp (file)
• synonyms.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 synonyms.asd

Location

synonyms.asd

Systems

synonyms (system)

3.1.2 synonyms/package.lisp

Parent

synonyms (system)

Location

package.lisp

Packages

synonyms

3.1.3 synonyms/synonyms.lisp

Dependency

package.lisp (file)

Parent

synonyms (system)

Location

synonyms.lisp

Exported Definitions

• false (constant)
• head (function)
• negativep (function)
• no (function)
• non-negative-p (function)
• non-positive-p (function)
• non-zero-p (function)
• positivep (function)
• strcat (function)
• tail (function)
• true (constant)
• yes (function)

4 Packages

Packages are listed by definition order.

4.1 synonyms

Source

package.lisp (file)

Nickname

syn

Use List

common-lisp

Exported Definitions

• false (constant)
• head (function)
• negativep (function)
• no (function)
• non-negative-p (function)
• non-positive-p (function)
• non-zero-p (function)
• positivep (function)
• strcat (function)
• tail (function)
• true (constant)
• yes (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Constants

Constant: false

The false value.

Package

synonyms

Source

synonyms.lisp (file)

Constant: true

The canonical truth value.

Package

synonyms

Source

synonyms.lisp (file)

5.1.2 Functions

Function: head LIST

Return the head of a list.

Package

synonyms

Source

synonyms.lisp (file)

Function: negativep N

Check if a number N is negative.

Package

synonyms

Source

synonyms.lisp (file)

Function: no &rest IGNORED

A function that akways returns a false value. Equivalent to (CONSTANTLY NIL).

Package

synonyms

Source

synonyms.lisp (file)

Function: non-negative-p N

Check if a number N is non-negative (greater or equal to zero).

Package

synonyms

Source

synonyms.lisp (file)

Function: non-positive-p N

Check if a number N is non-positive (less than or equal to zero).

Package

synonyms

Source

synonyms.lisp (file)

Function: non-zero-p N

Check if a number is non-zero.

Package

synonyms

Source

synonyms.lisp (file)

Function: positivep N

Check if a number N is positive.

Package

synonyms

Source

synonyms.lisp (file)

Function: strcat A B

Concatenate two strings A and B.

Package

synonyms

Source

synonyms.lisp (file)

Function: tail LIST

Return the tail (rest) of the list.

Package

synonyms

Source

synonyms.lisp (file)

Function: yes &rest IGNORED

A function that always returns a truth vale. Equivalent to (CONSTANTLY T).

Package

synonyms

Source

synonyms.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types