The cl-crc64 Reference Manual

This is the cl-crc64 Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 03:51:28 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-crc64

Computes 64-bit cyclic redundancy checks

Author

Rob Blackwell <>

License

BSD

Version

0.1

Source

cl-crc64.asd.

Child Component

crc64.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 cl-crc64/cl-crc64.asd

Source

cl-crc64.asd.

Parent Component

cl-crc64 (system).

ASDF Systems

cl-crc64.

Packages

cl-crc64-asd.


3.1.2 cl-crc64/crc64.lisp

Source

cl-crc64.asd.

Parent Component

cl-crc64 (system).

Packages

cl-crc64.

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 cl-crc64

Source

crc64.lisp.

Use List

common-lisp.

Public Interface
Internals

4.2 cl-crc64-asd

Source

cl-crc64.asd.

Use List
  • asdf/interface.
  • common-lisp.

5 Definitions

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


5.1 Public Interface


5.1.1 Constants

Constant: +improved-polynomial+
Package

cl-crc64.

Source

crc64.lisp.

Constant: +polynomial+
Package

cl-crc64.

Source

crc64.lisp.


5.1.2 Ordinary functions

Function: crc64-file (pathname)

Calculates the CRC64 of the file specified by pathname.

Package

cl-crc64.

Source

crc64.lisp.

Function: crc64-sequence (sequence &key initial-crc start end)

Calculates the CRC64 from sequence, which is either a simple-string or a simple-array with element-type (unsigned-byte 8)

Package

cl-crc64.

Source

crc64.lisp.

Function: crc64-stream (stream &key initial-crc)

Calculates the CRC64 on the given stream.

Package

cl-crc64.

Source

crc64.lisp.

Function: initialise-crc64 (polynomial)

Computes lookup tables of CRC values for byte values 0 thru 255

Package

cl-crc64.

Source

crc64.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *crc-table-h*
Package

cl-crc64.

Source

crc64.lisp.

Special Variable: *crc-table-l*
Package

cl-crc64.

Source

crc64.lisp.


Appendix A Indexes


A.1 Concepts