This is the lisp-unit Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 06:52:40 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
lisp-unitCommon Lisp library that supports unit testing.
Thomas M. Hermann <thomas.m.hermann@odonata-research.com>
MIT
1.0.0
lisp-unit.lisp (file).
extensions (module).
Modules are listed depth-first from the system components tree.
lisp-unit/extensionslisp-unit.lisp (file).
lisp-unit (system).
rational.lisp (file).
floating-point.lisp (file).
test-anything-protocol.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
lisp-unit/lisp-unit.asdlisp-unit/lisp-unit.lisplisp-unit/extensions/rational.lisplisp-unit/extensions/floating-point.lisplisp-unit/extensions/test-anything-protocol.lisplisp-unit/lisp-unit.lisplisp-unit (system).
*print-errors* (special variable).
*print-failures* (special variable).
*print-summary* (special variable).
*summarize-results* (special variable).
assert-eq (macro).
assert-eql (macro).
assert-equal (macro).
assert-equality (macro).
assert-equalp (macro).
assert-error (macro).
assert-expands (macro).
assert-false (macro).
assert-nil (macro).
assert-prints (macro).
assert-true (macro).
define-test (macro).
error-tests (reader method).
(setf error-tests) (writer method).
failed-tests (reader method).
(setf failed-tests) (writer method).
list-tags (function).
list-tests (function).
logically-equal (function).
missing-tests (reader method).
(setf missing-tests) (writer method).
print-errors (generic function).
print-failures (generic function).
print-object (method).
reduce-test-results-dbs (function).
remove-tags (function).
remove-tests (function).
results (reader method).
run-tags (function).
run-tests (function).
set-equal (function).
signal-results (function).
summarize-results (function).
tagged-tests (function).
test-code (function).
test-documentation (function).
test-names (function).
test-run-complete (condition).
use-debugger (function).
%expansion-equal (function).
%record-failure (function).
%run-all-thunks (function).
%run-thunks (function).
%tests-from-all-tags (function).
%tests-from-tags (function).
*fail* (special variable).
*pass* (special variable).
*signal-results* (special variable).
*tag-db* (special variable).
*test-db* (special variable).
*use-debugger* (special variable).
actual (reader method).
assert-result (generic function).
boolean-result (class).
code (reader method).
database (reader method).
default-db-merge-function (function).
doc (reader method).
equal-result (class).
error-result (class).
exerr (reader method).
exerr (reader method).
(setf exerr) (writer method).
expand-assert (macro).
expand-error-form (macro).
expand-extras (macro).
expand-macro-form (macro).
expand-output-form (macro).
expand-t-or-f (macro).
expected (reader method).
extras (reader method).
fail (reader method).
fail (reader method).
(setf fail) (writer method).
failure-result (class).
form (reader method).
internal-assert (function).
macro-result (class).
name (reader method).
nappend-test-results-db (function).
null-tags-warning (condition).
null-tags-warning-report (function).
null-tests-warning (condition).
null-tests-warning-report (function).
output-result (class).
package-table (function).
package-tags (function).
parse-body (function).
pass (reader method).
pass (reader method).
(setf pass) (writer method).
print-summary (function).
record-failure (generic function).
record-result (function).
reset-counters (function).
run-code (function).
run-test-thunk (function).
run-time (reader method).
tags-package-name (reader method).
test (reader method).
test-name-error (condition).
test-name-error-report (function).
test-package (function).
test-result (class).
test-results-db (class).
tests-package-name (reader method).
unit-test (class).
use-debugger-p (function).
valid-test-name (function).
with-package-table (macro).
with-package-tags (macro).
lisp-unit/extensions/rational.lispextensions (module).
assert-rational-equal (macro).
rational-equal (generic function).
%seq-rational-equal (function).
lisp-unit/extensions/floating-point.lispextensions (module).
*epsilon* (special variable).
*measure* (special variable).
*significant-figures* (special variable).
array-error (function).
assert-float-equal (macro).
assert-norm-equal (macro).
assert-number-equal (macro).
assert-numerical-equal (macro).
assert-sigfig-equal (macro).
complex-random (function).
default-epsilon (generic function).
float-equal (generic function).
make-2d-list (function).
make-random-2d-array (function).
make-random-2d-list (function).
make-random-list (function).
norm (generic function).
norm-equal (generic function).
number-equal (function).
numerical-equal (generic function).
relative-error (generic function).
relative-error-norm (generic function).
sigfig-equal (generic function).
sump (generic function).
sumsq (generic function).
%array-error (function).
%array-indices (function).
%complex-float-random (function).
%complex-rational-random (function).
%float-equal (function).
%norm (generic function).
%norm-equal (function).
%normalize-float (function).
%relative-error (function).
%relative-error-norm (function).
%seq-float-equal (function).
%seq-sigfig-equal (function).
%sequence-equal (function).
%sequence-error (function).
%sigfig-equal (function).
sequence-error (function).
lisp-unit/extensions/test-anything-protocol.lispextensions (module).
write-tap (function).
write-tap-to-file (function).
%write-tap-test-result (function).
run-time-s (function).
Packages are listed by definition order.
lisp-unitcommon-lisp.
*epsilon* (special variable).
*measure* (special variable).
*print-errors* (special variable).
*print-failures* (special variable).
*print-summary* (special variable).
*significant-figures* (special variable).
*summarize-results* (special variable).
array-error (function).
assert-eq (macro).
assert-eql (macro).
assert-equal (macro).
assert-equality (macro).
assert-equalp (macro).
assert-error (macro).
assert-expands (macro).
assert-false (macro).
assert-float-equal (macro).
assert-nil (macro).
assert-norm-equal (macro).
assert-number-equal (macro).
assert-numerical-equal (macro).
assert-prints (macro).
assert-rational-equal (macro).
assert-sigfig-equal (macro).
assert-true (macro).
complex-random (function).
default-epsilon (generic function).
define-test (macro).
error-tests (generic reader).
(setf error-tests) (generic writer).
failed-tests (generic reader).
(setf failed-tests) (generic writer).
float-equal (generic function).
list-tags (function).
list-tests (function).
logically-equal (function).
make-2d-list (function).
make-random-2d-array (function).
make-random-2d-list (function).
make-random-list (function).
missing-tests (generic reader).
(setf missing-tests) (generic writer).
norm (generic function).
norm-equal (generic function).
number-equal (function).
numerical-equal (generic function).
print-errors (generic function).
print-failures (generic function).
rational-equal (generic function).
reduce-test-results-dbs (function).
relative-error (generic function).
relative-error-norm (generic function).
remove-tags (function).
remove-tests (function).
results (generic reader).
run-tags (function).
run-tests (function).
set-equal (function).
sigfig-equal (generic function).
signal-results (function).
summarize-results (function).
sump (generic function).
sumsq (generic function).
tagged-tests (function).
test-code (function).
test-documentation (function).
test-names (function).
test-run-complete (condition).
use-debugger (function).
write-tap (function).
write-tap-to-file (function).
%array-error (function).
%array-indices (function).
%complex-float-random (function).
%complex-rational-random (function).
%expansion-equal (function).
%float-equal (function).
%norm (generic function).
%norm-equal (function).
%normalize-float (function).
%record-failure (function).
%relative-error (function).
%relative-error-norm (function).
%run-all-thunks (function).
%run-thunks (function).
%seq-float-equal (function).
%seq-rational-equal (function).
%seq-sigfig-equal (function).
%sequence-equal (function).
%sequence-error (function).
%sigfig-equal (function).
%tests-from-all-tags (function).
%tests-from-tags (function).
%write-tap-test-result (function).
*fail* (special variable).
*pass* (special variable).
*signal-results* (special variable).
*tag-db* (special variable).
*test-db* (special variable).
*use-debugger* (special variable).
actual (generic reader).
assert-result (generic function).
boolean-result (class).
code (generic reader).
database (generic reader).
default-db-merge-function (function).
doc (generic reader).
equal-result (class).
error-result (class).
exerr (generic reader).
(setf exerr) (generic writer).
expand-assert (macro).
expand-error-form (macro).
expand-extras (macro).
expand-macro-form (macro).
expand-output-form (macro).
expand-t-or-f (macro).
expected (generic reader).
extras (generic reader).
fail (generic reader).
(setf fail) (generic writer).
failure-result (class).
form (generic reader).
internal-assert (function).
macro-result (class).
name (generic reader).
nappend-test-results-db (function).
null-tags-warning (condition).
null-tags-warning-report (function).
null-tests-warning (condition).
null-tests-warning-report (function).
output-result (class).
package-table (function).
package-tags (function).
parse-body (function).
pass (generic reader).
(setf pass) (generic writer).
print-summary (function).
record-failure (generic function).
record-result (function).
reset-counters (function).
run-code (function).
run-test-thunk (function).
run-time (generic reader).
run-time-s (function).
sequence-error (function).
tags-package-name (generic reader).
test (generic reader).
test-name-error (condition).
test-name-error-report (function).
test-package (function).
test-result (class).
test-results-db (class).
tests-package-name (generic reader).
unit-test (class).
use-debugger-p (function).
valid-test-name (function).
with-package-table (macro).
with-package-tags (macro).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Set the error epsilon if the defaults are not acceptable.
Print error messages if non-NIL.
Print failure messages if non-NIL.
Print a summary of the pass, fail, and error count if non-nil.
Default to 4 significant figures.
Summarize all of the unit test results.
Assert whether expected and form are EQ.
Assert whether expected and form are EQL.
Assert whether expected and form are EQUAL.
Assert whether expected and form are equal according to test.
Assert whether expected and form are EQUALP.
Assert whether form signals condition.
Assert whether form expands to expansion.
Assert whether the form is false.
Assert whether the form is false.
Assert whether printing the form generates the output.
Assert whether the form is true.
Store the test in the test database.
Return a list of the indices and error between the array elements.
Return a random complex number.
Return a list of the tags in package.
Return a list of the tests in package.
Return true if x and y are both false or both true.
Return a nested list with INITIAL-ELEMENT.
Return a 2D array of random numbers.
Return a nested list of random numbers.
Return a list of random numbers.
Return true if the numbers are equal within some epsilon, optionally requiring the types to be identical.
Return a new instance of TEST-RESULTS-DB which contains all of the
results in the sequence RESULTS. Any conflicts are handled by the
function MERGE.
The lambda list for the MERGE function is
(key value-1 value-2)
where:
KEY is the key which appears at least twice in the sequence RESULTS.
VALUE-1 and VALUE-2 are the conflicting values for the given KEY.
If MERGE is NIL, then an error is signalled when a conflict occurs.
Remove individual tags or entire sets.
Remove individual tests or entire sets.
Run the tests associated with the specified tags in package.
Run the specified tests in package.
Return true if every element of list1 is an element of list2 and vice versa.
Signal the results for extensibility.
Print a summary of all results to the stream.
Return a list of the tests associated with the tags.
Returns the code stored for the test name.
Return the documentation for the test.
Return a list of the test names in the database.
Use the debugger when testing, or not.
Write the test results to ‘stream‘ in TAP format. Returns the test results.
write the test results to ‘path‘ in TAP format, overwriting ‘path‘. Returns pathname to the output file
Return the default epsilon for the value.
array)) ¶Return the default epsilon based on the contents of the array.
vector)) ¶Return the default epsilon based on the contents of the vector.
list)) ¶Return the default epsilon based on contents of the list.
complex)) ¶Return a default epsilon value based on the complex type.
float)) ¶Return a default epsilon value based on the floating point type.
test-results-db)) ¶automatically generated reader method
test-results-db)) ¶automatically generated writer method
test-results-db)) ¶automatically generated reader method
test-results-db)) ¶automatically generated writer method
Return true if the floating point data is equal.
array) (data2 array) &optional epsilon) ¶Return true if the arrays are equal in length and element-wise comparison of the relative error is less than epsilon.
vector) (data2 vector) &optional epsilon) ¶Return true if the vectors are equal in length and element-wise comparison of the relative error is less than epsilon.
vector) (data2 list) &optional epsilon) ¶Return true if the vector and the list are equal in length and element-wise comparison of the relative error is less than epsilon.
list) (data2 vector) &optional epsilon) ¶Return true if the vector and the list are equal in length and element-wise comparison of the relative error is less than epsilon.
list) (data2 list) &optional epsilon) ¶Return true if the lists are equal in length and element-wise comparison of the relative error is less than epsilon.
complex) (data2 complex) &optional epsilon) ¶Return true if the relative error between data1 and data2 is less than epsilon.
complex) (data2 float) &optional epsilon) ¶Return true if the relative error between data1 and data2 is less than epsilon.
float) (data2 complex) &optional epsilon) ¶Return true if the relative error between data1 and data2 is less than epsilon.
rational) (data2 float) &optional epsilon) ¶Return true if the relative error between data1 and data2 is less than epsilon.
float) (data2 rational) &optional epsilon) ¶Return true if the relative error between data1 and data2 is less than epsilon.
float) (data2 float) &optional epsilon) ¶Return true if the relative error between data1 and data2 is less than epsilon.
test-results-db)) ¶automatically generated reader method
test-results-db)) ¶automatically generated writer method
Return the element-wise norm of the data.
array) &optional measure) ¶Return the entrywise norm of the array according to the measure.
vector) &optional measure) ¶Return the norm of the vector according to the measure.
list) &optional measure) ¶Return the norm of the list according to the measure.
Return true if the norm of the data is equal.
array) (data2 array) &optional epsilon measure) ¶Return true if the arrays are equal in length and the relative error norm is less than epsilon.
vector) (data2 vector) &optional epsilon measure) ¶Return true if the vectors are equal in length and the relative error norm is less than epsilon.
vector) (data2 list) &optional epsilon measure) ¶Return true if the vector and the list are equal in length and the relative error norm is less than epsilon.
list) (data2 vector) &optional epsilon measure) ¶Return true if the vector and the list are equal in length and the relative error norm is less than epsilon.
list) (data2 list) &optional epsilon measure) ¶Return true if the lists are equal in length and the relative error norm is less than epsilon.
Return true if the results are numerically equal according to :TEST.
array) (result2 array) &key test) ¶Return true if the arrays are equal in dimension and each element is equal according to :TEST.
vector) (result2 list) &key test) ¶Return true if every element of the list is equla to the corresponding element of the vector.
list) (result2 vector) &key test) ¶Return true if every element of the list is equal to the corresponding element of the vector.
vector) (result2 vector) &key test) ¶Return true if the vectors are equal in length and each element is equal according to :TEST.
list) (result2 list) &key test) ¶Return true if the lists are equal in length and each element is equal according to :TEST.
number) (result2 number) &key test) ¶Return true if the the numbers are equal according to :TEST.
Print the error condition.
test-results-db) &optional stream) ¶Print all of the error tests.
test-result) &optional stream) ¶Print the error condition.
Report the results of the failed assertion.
test-results-db) &optional stream) ¶Print all of the failure tests.
test-result) &optional stream) ¶Print the failed assertions in the unit test.
output-result) &optional stream) ¶macro-result) &optional stream) ¶error-result) &optional stream) ¶failure-result) &optional stream) ¶failure-result) &optional stream) ¶Failure header and footer output.
Return true if the rational data is equal.
array) (data2 array)) ¶Return true if the arrays are equal in dimension and element-wise equal.
vector) (data2 vector)) ¶Return true if the vectors are equal in length and element-wise equal.
vector) (data2 list)) ¶Return true if the vector and the list are equal in length and element-wise equal.
list) (data2 vector)) ¶Return true if the vector and the list are equal in length and element-wise equal.
list) (data2 list)) ¶Return true if the lists are equal in length and element-wise equal.
complex) (data2 complex)) ¶Return true if the complex parts are rational and equal.
rational) (data2 rational)) ¶Return true if the rational numbers are equal.
Return the relative-error between the 2 quantities.
complex) (approximate complex)) ¶Return the relative error of the complex numbers.
complex) (approximate float)) ¶Return the relative error between the float and complex number.
float) (approximate complex)) ¶Return the relative error between the float and complex number.
float) (approximate float)) ¶Return the error delta between the exact and approximate floating point value.
Return the relative error norm
array) (approximate vector) &optional measure) ¶Return the relative error norm of the arrays.
vector) (approximate vector) &optional measure) ¶Return the relative error norm of the vectors.
vector) (approximate list) &optional measure) ¶Return the relative error norm of the list and the vector.
list) (approximate vector) &optional measure) ¶Return the relative error norm of the list and the vector.
list) (approximate list) &optional measure) ¶Return the relative error norm of the lists.
test-run-complete)) ¶Return true if the data have equal significant figures.
array) (data2 array) &optional significant-figures) ¶Return true if the arrays are equal in length and the element-wise comparison is equal to significant figures.
vector) (data2 vector) &optional significant-figures) ¶Return true if the vectors are equal in length and the element-wise comparison is equal to significant figures.
list) (data2 vector) &optional significant-figures) ¶Return true if the list and the vector are equal in length and the element-wise comparison is equal to significant figures.
vector) (data2 list) &optional significant-figures) ¶Return true if the vector and the list are equal in length and the element-wise comparison is equal to significant figures.
list) (data2 list) &optional significant-figures) ¶Return true if the lists are equal in length and the element-wise comparison is equal to significant figures.
float) (data2 float) &optional significant-figures) ¶Return true if the floating point numbers have equal significant figures.
Return the scaling parameter and the sum of the powers of p of the ~ data.
array) (p real)) ¶Return the scaling parameter and the sum of the powers of p of the ~ array.
vector) (p real)) ¶Return the scaling parameter and the sum of the powers of p of the ~ vector.
list) (p real)) ¶Return the scaling parameter and the sum of the powers of p of the ~ data.
Return the scaling parameter and the sum of the squares of the ~ data.
array)) ¶Return the scaling parameter and the sum of the squares of the ~ array.
vector)) ¶Return the scaling parameter and the sum of the squares of the ~ vector.
list)) ¶Return the scaling parameter and the sum of the squares of the ~ list.
test-results-db) stream) ¶Print the summary counts with the object.
The failed assertion results.
The passed assertion results.
Signal the result if non NIL.
The tag database is simply a hash table.
The unit test database is simply a hash table.
If not NIL, enter the debugger when an error is encountered in an assertion.
Expand the assertion to the internal format.
Wrap the error assertion in HANDLER-CASE.
Expand extra forms.
Expand the macro form once.
Capture the output of the form in a string.
Expand the true/false assertions to report the arguments.
Execute the body only if the package table exists.
Execute the body only if the package tags exists.
Return a list of the indices, values and error of the elements that are not equal.
Recursively calculate the indices from the row major index.
Return a random complex float number.
Return a random complex rational number.
Descend into the forms checking for equality.
Return true if the relative error between the data is less than epsilon.
Return true if the relative error norm is less than epsilon.
Return the normalized floating point number and exponent.
Return an instance of the failure result.
Return the relative error of the numbers.
Return the relative error norm of the sequences.
Run all of the test thunks in the package.
Run the list of test thunks in the package.
Return true if the element-wise comparison of relative error is less than epsilon.
Return true if the sequences are equal length and at each position the corresponding elements are equal.
Return true if the element-wise comparison is equal to the specified significant figures.
Return true if the sequences are equal in length and each element is equal according to :TEST.
Return a sequence of the indice and error between the sequences.
Return true if the floating point numbers have equal significant figures.
Return all of the tests that have been tagged.
Return the tests associated with the tags.
Output a single test, taking care to ensure the indentation level is the same before and after invocation.
Signal an error by default if a merge is required.
Perform the assertion and record the results.
Merge the results of NEW-RESULTS in to RESULTS. Any conflicts between RESULTS and NEW-RESULTS are handled by the function MERGE.
The lambda list for the MERGE functions is
(key results-value new-results-value)
where:
KEY is the key which appears in RESULTS and NEW-RESULTS.
RESULTS-VALUE is the value appearing RESULTS.
NEW-RESULTS-VALUE is the value appearing in NEW-RESULTS.
If MERGE is NIL, then an error is signalled when a conflict occurs.
Write the null-tags-warning to the stream.
Write the null-tests-warning to the stream.
Return the tags DB for the package.
Separate the components of the body.
Print a summary of the test result.
Run the test code and record the result.
Reset the counters to empty lists.
Run the code to test the assertions.
calculate the run-time of the test in seconds
Return a sequence of the indice and error between the sequence elements.
Write the test-name-error to the stream.
Return the package for storing the test.
Debug or ignore errors.
Signal a type-error if the test name is not a symbol.
Return the norm of the data according to measure.
vector) (measure (eql :infinity))) ¶Return the infinity, or maximum, norm of the vector.
list) (measure (eql :infinity))) ¶Return the infinity, or maximum, norm of the list.
vector) (measure integer)) ¶Return the Euclidean norm of the vector.
list) (measure integer)) ¶Return the Euclidean norm of the list.
vector) (measure (eql 2))) ¶Return the Euclidean norm of the vector.
list) (measure (eql 2))) ¶Return the Euclidean norm of the list.
vector) (measure (eql 1))) ¶Return the Taxicab norm of the vector.
list) (measure (eql 1))) ¶Return the Taxicab norm of the list.
failure-result)) ¶automatically generated reader method
Return the result of the assertion.
(eql :output)) test expected actual) ¶Return the result of an output assertion.
(eql :result)) test expected actual) ¶Return the result of a result assertion.
(eql :macro)) test expected actual) ¶Return the result of a macro assertion.
(eql :error)) test expected actual) ¶Return the result of an error assertion.
(eql :equal)) test expected actual) ¶Return the result of an equal assertion.
test-results-db)) ¶automatically generated reader method
test-results-db)) ¶automatically generated reader method
test-result)) ¶automatically generated reader method
test-results-db)) ¶automatically generated writer method
failure-result)) ¶automatically generated reader method
failure-result)) ¶automatically generated reader method
test-results-db)) ¶automatically generated reader method
fail.
test-result)) ¶automatically generated reader method
fail.
test-results-db)) ¶automatically generated writer method
fail.
failure-result)) ¶automatically generated reader method
form.
test-result)) ¶automatically generated reader method
name.
test-results-db)) ¶automatically generated reader method
pass.
test-result)) ¶automatically generated reader method
pass.
test-results-db)) ¶automatically generated writer method
pass.
Record the details of the failure.
(eql :output)) form actual expected extras test) ¶Return an instance of an output failure result.
(eql :result)) form actual expected extras test) ¶Return an instance of a boolean failure result.
(eql :macro)) form actual expected extras test) ¶Return an instance of a macro failure result.
(eql :error)) form actual expected extras test) ¶Return an instance of an error failure result.
(eql :equal)) form actual expected extras test) ¶Return an instance of an equal failure result.
test-result)) ¶Test run time measured in internal time units
null-tags-warning)) ¶name.
failure-result)) ¶automatically generated reader method
test.
null-tests-warning)) ¶name.
simple-warning.
:name
This slot is read-only.
simple-warning.
:name
This slot is read-only.
The test name error is a type error.
type-error.
| Initarg | Value |
|---|---|
:expected-type | (quote symbol) |
Result of a failed boolean assertion.
Result of a failed equal assertion.
Result of a failed error assertion.
Failure details of the assertion.
Result of a failed macro expansion assertion.
Result of a failed output assertion.
Store the results of the unit test.
exerr.
fail.
name.
pass.
print-errors.
print-failures.
run-time.
| Initarg | Value |
|---|---|
:exerr | nil |
Store the results of the tests for further evaluation.
hash-table
(make-hash-table :test (function eq))
This slot is read-only.
fixnum
0
list
list
list
Organize the unit test documentation and code.
| Jump to: | %
(
A C D E F G I L M N P R S T U V W |
|---|
| Jump to: | %
(
A C D E F G I L M N P R S T U V W |
|---|
| Jump to: | *
A C D E F M N P R S T |
|---|
| Jump to: | *
A C D E F M N P R S T |
|---|
| Jump to: | B C E F L M N O P R S T U |
|---|
| Jump to: | B C E F L M N O P R S T U |
|---|