The equals Reference Manual

Table of Contents

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

The equals Reference Manual

This is the equals Reference Manual, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:44:24 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

equals

equals purports to implement CDR 8: Generic Equality and Comparison for Common Lisp

http://cdr.eurolisp.org/document/8/index.html


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


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

2.1 equals

Author

cszi

License

MIT

Description

Generic Equality and Comparison for Common Lisp

Source

equals.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

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


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

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 equals.asd

Location

equals.asd

Systems

equals (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 equals/package.lisp

Parent

equals (system)

Location

package.lisp

Packages

equals


Previous: , Up: Lisp files   [Contents][Index]

3.1.3 equals/equals.lisp

Dependency

package.lisp (file)

Parent

equals (system)

Location

equals.lisp

Exported Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


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

4.1 equals

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

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


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

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Functions

Function: greaterp X Y &rest KEYS &key RECURSIVE &allow-other-keys

Returns T when COMPARE returns >.

Package

equals

Source

equals.lisp (file)

Function: gt X Y &rest KEYS &key RECURSIVE &allow-other-keys

Returns T when COMPARE returns >.

Package

equals

Source

equals.lisp (file)

Function: gte X Y &rest KEYS &key RECURSIVE &allow-other-keys

Returns T when COMPARE returns > or =.

Package

equals

Source

equals.lisp (file)

Function: lessp X Y &rest KEYS &key RECURSIVE &allow-other-keys

Returns T when COMPARE returns <.

Package

equals

Source

equals.lisp (file)

Function: lt X Y &rest KEYS &key RECURSIVE &allow-other-keys

Returns T when COMPARE returns <.

Package

equals

Source

equals.lisp (file)

Function: lte X Y &rest KEYS &key RECURSIVE &allow-other-keys

Returns T when COMPARE returns < or =.

Package

equals

Source

equals.lisp (file)

Function: not-greaterp X Y &rest KEYS &key RECURSIVE &allow-other-keys

Returns T when COMPARE returns < or =.

Package

equals

Source

equals.lisp (file)

Function: not-lessp X Y &rest KEYS &key RECURSIVE &allow-other-keys

Returns T when COMPARE returns > or =.

Package

equals

Source

equals.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

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 (file)

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 (file)

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 (file)

Methods
Method: hash-code OBJ

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

Appendix A Indexes


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

A.1 Concepts

Jump to:   E   F   L  
Index Entry  Section

E
equals.asd: The equals<dot>asd file
equals/equals.lisp: The equals/equals<dot>lisp file
equals/package.lisp: The equals/package<dot>lisp file

F
File, Lisp, equals.asd: The equals<dot>asd file
File, Lisp, equals/equals.lisp: The equals/equals<dot>lisp file
File, Lisp, equals/package.lisp: The equals/package<dot>lisp file

L
Lisp File, equals.asd: The equals<dot>asd file
Lisp File, equals/equals.lisp: The equals/equals<dot>lisp file
Lisp File, equals/package.lisp: The equals/package<dot>lisp file

Jump to:   E   F   L  

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

A.2 Functions

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

C
compare: Exported generic functions
compare: Exported generic functions
compare: Exported generic functions
compare: Exported generic functions
compare: Exported generic functions
compare: Exported generic functions

E
equals: Exported generic functions
equals: Exported generic functions
equals: Exported generic functions
equals: Exported generic functions
equals: Exported generic functions
equals: Exported generic functions
equals: Exported generic functions
equals: Exported generic functions
equals: Exported generic functions
equals: Exported generic functions

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

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

H
hash-code: Exported generic functions
hash-code: Exported generic functions

L
lessp: Exported functions
lt: Exported functions
lte: Exported functions

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

N
not-greaterp: Exported functions
not-lessp: Exported functions

Jump to:   C   E   F   G   H   L   M   N  

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

A.3 Variables


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

A.4 Data types

Jump to:   E   P   S  
Index Entry  Section

E
equals: The equals system
equals: The equals package

P
Package, equals: The equals package

S
System, equals: The equals system

Jump to:   E   P   S