The equals Reference Manual

This is the equals Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 05:10:32 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 equals

Generic Equality and Comparison for Common Lisp

Author

cszi

License

MIT

Source

equals.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 equals/equals.asd

Source

equals.asd.

Parent Component

equals (system).

ASDF Systems

equals.


3.1.2 equals/package.lisp

Source

equals.asd.

Parent Component

equals (system).

Packages

equals.


3.1.3 equals/equals.lisp

Dependency

package.lisp (file).

Source

equals.asd.

Parent Component

equals (system).

Public Interface

4 Packages

Packages are listed by definition order.


4.1 equals

Source

package.lisp.

Use List

common-lisp.

Public Interface

5 Definitions

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


5.1 Public Interface


5.1.1 Ordinary functions

Function: greaterp (x y &rest keys &key recursive &allow-other-keys)

Returns T when COMPARE returns >.

Package

equals.

Alias for

gt.

Function: gt (x y &rest keys &key recursive &allow-other-keys)

Returns T when COMPARE returns >.

Package

equals.

Source

equals.lisp.

Function: gte (x y &rest keys &key recursive &allow-other-keys)

Returns T when COMPARE returns > or =.

Package

equals.

Source

equals.lisp.

Function: lessp (x y &rest keys &key recursive &allow-other-keys)

Returns T when COMPARE returns <.

Package

equals.

Alias for

lt.

Function: lt (x y &rest keys &key recursive &allow-other-keys)

Returns T when COMPARE returns <.

Package

equals.

Source

equals.lisp.

Function: lte (x y &rest keys &key recursive &allow-other-keys)

Returns T when COMPARE returns < or =.

Package

equals.

Source

equals.lisp.

Function: not-greaterp (x y &rest keys &key recursive &allow-other-keys)

Returns T when COMPARE returns < or =.

Package

equals.

Alias for

lte.

Function: not-lessp (x y &rest keys &key recursive &allow-other-keys)

Returns T when COMPARE returns > or =.

Package

equals.

Alias for

gte.


5.1.2 Generic functions

Generic Function: compare (x y &rest keys &key recursive case-sensitive &allow-other-keys)

The generic function COMPARE defines methods to test the ordering of two objects a and b, if such order exists. The result value returned by COMPARE is one of the four symbols: <, >, =, or /=. The COMPARE function returns /= as result by default; thus it can represent partial orders among objects. The equality tests should be coherent with what the generic function EQUALS does.

If the argument recursive is T, then COMPARE may recurse down the ’structure’ of a and b. The description of each known method contains the relevant information about its recursive dependent behavior.

Package

equals.

Source

equals.lisp.

Methods
Method: compare ((x symbol) (y symbol) &rest key &key recursive &allow-other-keys)
Method: compare ((x string) (y string) &rest keys &key recursive case-sensitive &allow-other-keys)
Method: compare ((x character) (y character) &rest keys &key recursive case-sensitive &allow-other-keys)
Method: compare ((x number) (y number) &rest keys &key recursive &allow-other-keys)
Method: compare (x y &rest keys &key recursive &allow-other-keys)
Generic Function: equals (x y &rest keys &key recursive by-key by-value check-properties case-sensitive epsilon &allow-other-keys)

The EQUALS generic functions defines methods to test for ’equality’
of two objects a and b. When two objects a and b are EQUALS under an appropriate and context-dependent notion of ’equality’, then the function returns T as result; otherwise EQUALS returns NIL as result.

If the argument recursive is T, then EQUALS may recurse down the ’structure’ of a and b. The description of each known method contains the relevant information about its recursive dependent behavior.

Package

equals.

Source

equals.lisp.

Methods
Method: equals ((x hash-table) (y hash-table) &rest keys &key recursive by-key by-value check-properties &allow-other-keys)
Method: equals ((x standard-object) (y standard-object) &rest keys &key recursive &allow-other-keys)
Method: equals ((x structure-object) (y structure-object) &rest keys &key recursive &allow-other-keys)
Method: equals ((x array) (y array) &rest keys &key recursive &allow-other-keys)
Method: equals ((x string) (y string) &rest keys &key recursive case-sensitive &allow-other-keys)
Method: equals ((x character) (y character) &rest keys &key recursive case-sensitive &allow-other-keys)
Method: equals ((x cons) (y cons) &rest keys &key recursive &allow-other-keys)
Method: equals ((x number) (y number) &rest keys &key recursive epsilon &allow-other-keys)
Method: equals (x y &rest keys &key recursive &allow-other-keys)
Generic Function: hash-code (obj)

Associates a unique fixnum hash-code for an object that can
be compared with EQUALS for use as hash table functions. (equals x y) should agree with (= (hash-code x) (hash-code y)). See SXHASH.

Package

equals.

Source

equals.lisp.

Methods
Method: hash-code (obj)

5.2 Internals


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   C   E   F   G   H   L   M   N  
Index Entry  Section

C
compare: Public generic functions
compare: Public generic functions
compare: Public generic functions
compare: Public generic functions
compare: Public generic functions
compare: Public generic functions

E
equals: Public generic functions
equals: Public generic functions
equals: Public generic functions
equals: Public generic functions
equals: Public generic functions
equals: Public generic functions
equals: Public generic functions
equals: Public generic functions
equals: Public generic functions
equals: Public generic functions

F
Function, greaterp: Public ordinary functions
Function, gt: Public ordinary functions
Function, gte: Public ordinary functions
Function, lessp: Public ordinary functions
Function, lt: Public ordinary functions
Function, lte: Public ordinary functions
Function, not-greaterp: Public ordinary functions
Function, not-lessp: Public ordinary functions

G
Generic Function, compare: Public generic functions
Generic Function, equals: Public generic functions
Generic Function, hash-code: Public generic functions
greaterp: Public ordinary functions
gt: Public ordinary functions
gte: Public ordinary functions

H
hash-code: Public generic functions
hash-code: Public generic functions

L
lessp: Public ordinary functions
lt: Public ordinary functions
lte: Public ordinary functions

M
Method, compare: Public generic functions
Method, compare: Public generic functions
Method, compare: Public generic functions
Method, compare: Public generic functions
Method, compare: Public generic functions
Method, equals: Public generic functions
Method, equals: Public generic functions
Method, equals: Public generic functions
Method, equals: Public generic functions
Method, equals: Public generic functions
Method, equals: Public generic functions
Method, equals: Public generic functions
Method, equals: Public generic functions
Method, equals: Public generic functions
Method, hash-code: Public generic functions

N
not-greaterp: Public ordinary functions
not-lessp: Public ordinary functions


A.3 Variables