The mw-equiv Reference Manual

Table of Contents

The mw-equiv Reference Manual

This is the mw-equiv Reference Manual, version 0.1.2, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 14:28:52 2020 GMT+0.

1 Introduction

                                                             -*- outline -*-
MW-EQUIV --- An Extensible Object Equivalence for Common Lisp

* Build

Presuming ASDF is available:

    (asdf:oos 'asdf:compile-op :mw-equiv)
    (asdf:oos 'asdf:load-op :mw-equiv)

Depending on the Lisp being used, a (require :mw-equiv) might do as
well.

* Documentation

See directory doc/

* Licence

See file LICENCE.

* Authors

See file AUTHORS.

2 Systems

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

2.1 mw-equiv

Maintainer

Michael Weber <michaelw+equiv@foldr.org>

Author

Michael Weber <michaelw+equiv@foldr.org>

License

BSD-like

Description

Extensible object equivalence protocol

Long Description

Extensible object equivalence protocol,
based on <http://home.pipeline.com/~hbaker1/ObjectIdentity.html>.

Version

0.1.2

Source

mw-equiv.asd (file)

Components

• package.lisp (file)
• equiv.lisp (file)
• readme (file)
• authors (file)
• licence (file)
• changelog (file)
• doc (module)

3 Modules

Modules are listed depth-first from the system components tree.

3.1 mw-equiv/doc

Dependency

changelog (file)

Parent

mw-equiv (system)

Location

doc/

Component

index.html (file)

4 Files

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

4.1 Lisp

4.1.1 mw-equiv.asd

Location

mw-equiv.asd

Systems

mw-equiv (system)

4.1.2 mw-equiv/package.lisp

Parent

mw-equiv (system)

Location

package.lisp

Packages

mw-equiv

4.1.3 mw-equiv/equiv.lisp

Dependency

package.lisp (file)

Parent

mw-equiv (system)

Location

equiv.lisp

Exported Definitions

• object-constituents (generic function)
• object-constituents (method)
• object-constituents (method)
• object-frozenp (generic function)
• object-frozenp (method)
• object-frozenp (method)
• object-frozenp (method)
• object-frozenp (method)
• object-frozenp (method)
• object-frozenp (method)
• object-frozenp (method)
• object-sequence= (function)
• object-vector= (function)
• object= (function)

4.2 HTML

4.2.1 mw-equiv/doc/index.html

Parent

doc (module)

Location

doc/index.html

4.3 Static

4.3.1 mw-equiv/README

Dependency

equiv.lisp (file)

Parent

mw-equiv (system)

Location

README

4.3.2 mw-equiv/AUTHORS

Dependency

readme (file)

Parent

mw-equiv (system)

Location

AUTHORS

4.3.3 mw-equiv/LICENCE

Dependency

authors (file)

Parent

mw-equiv (system)

Location

LICENCE

4.3.4 mw-equiv/ChangeLog

Dependency

licence (file)

Parent

mw-equiv (system)

Location

ChangeLog

5 Packages

Packages are listed by definition order.

5.1 mw-equiv

Source

package.lisp (file)

Nickname

equiv

Use List

common-lisp

Exported Definitions

• object-constituents (generic function)
• object-constituents (method)
• object-constituents (method)
• object-frozenp (generic function)
• object-frozenp (method)
• object-frozenp (method)
• object-frozenp (method)
• object-frozenp (method)
• object-frozenp (method)
• object-frozenp (method)
• object-frozenp (method)
• object-sequence= (function)
• object-vector= (function)
• object= (function)

6 Definitions

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

6.1 Exported definitions

6.1.1 Functions

Function: object-sequence= XS YS

Checks whether sequences XS and YS are element-wise equivalent, by means of OBJECT=, and of the same length.

Package

mw-equiv

Source

equiv.lisp (file)

Function: object-vector= XS YS

Checks whether vectors XS and YS are element-wise equivalent, by means of OBJECT=, and of the same length.
Use OBJECT-SEQUENCE= instead.

Package

mw-equiv

Source

equiv.lisp (file)

Function: object= X Y &optional FROZENP

Returns true if X and Y are (observationally) equivalent. Hence, OBJECT= is an equivalence relation:
1. (object= x x)
2. (equal (object= x y frozenp) (object= y x frozenp))
3. (implies (and (object= x y frozenp) (object= y z frozenp)) (object= x z frozenp))

Frozen objects (i.e., objects which are promised not to mutate) are compared by recursing into their constituents, as specified by OBJECT-CONSTITUENTS. Mutable (i.e., not frozen) objects are compared with the pointer equality EQ.

FROZENP can be used to override the defaults for X and Y given by OBJECT-FROZENP. It is a promise that none of the objects X and Y are referring to with their constituents, or **any of the constituents’ constituents** are mutated from the time of the call to OBJECT= onwards.

If one lies with FROZENP, OBJECT-FROZENP, or OBJECT-CONSTITUENTS, all bets are off and the result of OBJECT= is meaningless.

OBJECT= diverges if both X and Y are circular data structures.

See also: <http://home.pipeline.com/~hbaker1/ObjectIdentity.html>

Package

mw-equiv

Source

equiv.lisp (file)

6.1.2 Generic functions

Generic Function: object-constituents TYPE

Returns list of accessors used to determine equivalence of objects of type TYPE.

Package

mw-equiv

Source

equiv.lisp (file)

Methods

Method: object-constituents (TYPE (eql cons))

Method: object-constituents (TYPE (eql pathname))

Generic Function: object-frozenp OBJECT

Indicates whether OBJECT is frozen. That is,
this function may return true only if OBJECT will not be mutated in an observable way from the point of the call until the end of its life time, otherwise false.

Package

mw-equiv

Source

equiv.lisp (file)

Methods

Method: object-frozenp OBJECT

Method: object-frozenp (CONS cons)

Method: object-frozenp (STRING string)

Method: object-frozenp (VECTOR vector)

Method: object-frozenp (PATHNAME pathname)

Method: object-frozenp (NUMBER number)

Method: object-frozenp (CHAR character)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types