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

The cl-libpuzzle Reference Manual

This is the cl-libpuzzle Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Fri Sep 15 04:08:34 2023 GMT+0.

Next: Systems, Previous: The cl-libpuzzle Reference Manual, Up: The cl-libpuzzle Reference Manual [Contents][Index]

1 Introduction

Next: Modules, Previous: Introduction, Up: The cl-libpuzzle Reference Manual [Contents][Index]

2 Systems

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

cl-libpuzzle

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

2.1 `cl-libpuzzle`

libpuzzle(http://www.pureftpd.org/project/libpuzzle) binding for Common Lisp

Author

Masato Sogame

License

LLGPL

Long Description

# Cl-Libpuzzle

libpuzzle binding for Common Lisp

## Usage

cl-libpuzzle provides libpuzzle FFI interface.

### Extra

Provide macro interface for easy use.

(with-context-cvecs ctx (cv1 cv2) (puzzle-fill-cvec-from-file ctx cv1 "/path/to/your/file1") (puzzle-fill-cvec-from-file ctx cv2 "/path/to/your/file2") (puzzle-vector-normalized-distance ctx cv1 cv2 1))

(CFFI:WITH-FOREIGN-OBJECTS ((CTX ’CL-LIBPUZZLE::PUZZLE-CONTEXT) (CV1 ’CL-LIBPUZZLE::PUZZLE-CVEC) (CV2 ’CL-LIBPUZZLE::PUZZLE-CVEC)) (UNWIND-PROTECT
(PROGN
(PUZZLE-INIT-CONTEXT CTX)
(PUZZLE-INIT-CVEC CTX CV1)
(PUZZLE-INIT-CVEC CTX CV2)
(PUZZLE-FILL-CVEC-FROM-FILE CTX CV1 "/path/to/your/file1")
(PUZZLE-FILL-CVEC-FROM-FILE CTX CV2 "/path/to/your/file2") (PUZZLE-VECTOR-NORMALIZED-DISTANCE CTX CV1 CV2 1)) (PUZZLE-FREE-CVEC CTX CV1)
(PUZZLE-FREE-CVEC CTX CV2)
(PUZZLE-FREE-CONTEXT CTX)))

## Author

* Masato Sogame (poketo7878@gmail.com)

## Copyright

Version

0.1

Dependency

cffi (system).

Source

cl-libpuzzle.asd.

Child Component

src (module).

Next: Files, Previous: Systems, Up: The cl-libpuzzle Reference Manual [Contents][Index]

3 Modules

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

cl-libpuzzle/src

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

3.1 `cl-libpuzzle/src`

Source: cl-libpuzzle.asd.
Parent Component: cl-libpuzzle (system).
Child Component: cl-libpuzzle.lisp (file).

Next: Packages, Previous: Modules, Up: The cl-libpuzzle Reference Manual [Contents][Index]

4 Files

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

Lisp

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

Next: cl-libpuzzle/src/cl-libpuzzle.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

4.1.1 `cl-libpuzzle/cl-libpuzzle.asd`

Source: cl-libpuzzle.asd.
Parent Component: cl-libpuzzle (system).
ASDF Systems: cl-libpuzzle.
Packages: cl-libpuzzle-asd.

Previous: cl-libpuzzle/cl-libpuzzle.asd, Up: Lisp [Contents][Index]

4.1.2 `cl-libpuzzle/src/cl-libpuzzle.lisp`

Source

cl-libpuzzle.asd.

Parent Component

src (module).

Packages

cl-libpuzzle.

Public Interface

*similarity-high-threshold* (special variable).
*similarity-low-threshold* (special variable).
*similarity-lower-threshold* (special variable).
*similarity-threshold* (special variable).
puzzle-compress-cvec (function).
puzzle-cvec-cksum (function).
puzzle-dump-cvec (function).
puzzle-dump-dvec (function).
puzzle-fill-cvec-from-dvec (function).
puzzle-fill-cvec-from-file (function).
puzzle-fill-dvec-from-file (function).
puzzle-free-compressed-cvec (function).
puzzle-free-context (function).
puzzle-free-cvec (function).
puzzle-free-dvec (function).
puzzle-init-compressed-cvec (function).
puzzle-init-context (function).
puzzle-init-cvec (function).
puzzle-init-dvec (function).
puzzle-set-autocrop (function).
puzzle-set-contrast-barrier-for-cropping (function).
puzzle-set-lambdas (function).
puzzle-set-max-cropping-ratio (function).
puzzle-set-max-height (function).
puzzle-set-max-width (function).
puzzle-set-noise-cutoff (function).
puzzle-set-p-ratio (function).
puzzle-uncompress-cvec (function).
puzzle-vector-euclidean-length (function).
puzzle-vector-normalized-distance (function).
puzzle-vector-sub (function).
translate-from-foreign (method).
with-context-cvecs (macro).

Internals

puzzle-code-error (condition).
puzzle-code-type (class).
puzzle-compressed-cvec-tclass (class).
puzzle-context-tclass (class).
puzzle-cvec-tclass (class).
puzzle-dvec-tclass (class).
puzzle-error-code (reader method).

Next: Definitions, Previous: Files, Up: The cl-libpuzzle Reference Manual [Contents][Index]

5 Packages

Packages are listed by definition order.

cl-libpuzzle-asd
cl-libpuzzle

Next: cl-libpuzzle, Previous: Packages, Up: Packages [Contents][Index]

5.1 `cl-libpuzzle-asd`

Source

cl-libpuzzle.asd.

Use List

asdf/interface.
common-lisp.

Previous: cl-libpuzzle-asd, Up: Packages [Contents][Index]

5.2 `cl-libpuzzle`

Source

cl-libpuzzle.lisp.

Use List

cffi.
common-lisp.

Public Interface

*similarity-high-threshold* (special variable).
*similarity-low-threshold* (special variable).
*similarity-lower-threshold* (special variable).
*similarity-threshold* (special variable).
puzzle-compress-cvec (function).
puzzle-cvec-cksum (function).
puzzle-dump-cvec (function).
puzzle-dump-dvec (function).
puzzle-fill-cvec-from-dvec (function).
puzzle-fill-cvec-from-file (function).
puzzle-fill-dvec-from-file (function).
puzzle-free-compressed-cvec (function).
puzzle-free-context (function).
puzzle-free-cvec (function).
puzzle-free-dvec (function).
puzzle-init-compressed-cvec (function).
puzzle-init-context (function).
puzzle-init-cvec (function).
puzzle-init-dvec (function).
puzzle-set-autocrop (function).
puzzle-set-contrast-barrier-for-cropping (function).
puzzle-set-lambdas (function).
puzzle-set-max-cropping-ratio (function).
puzzle-set-max-height (function).
puzzle-set-max-width (function).
puzzle-set-noise-cutoff (function).
puzzle-set-p-ratio (function).
puzzle-uncompress-cvec (function).
puzzle-vector-euclidean-length (function).
puzzle-vector-normalized-distance (function).
puzzle-vector-sub (function).
with-context-cvecs (macro).

Internals

puzzle-code-error (condition).
puzzle-code-type (class).
puzzle-compressed-cvec-tclass (class).
puzzle-context-tclass (class).
puzzle-cvec-tclass (class).
puzzle-dvec-tclass (class).
puzzle-error-code (generic reader).

Next: Indexes, Previous: Packages, Up: The cl-libpuzzle Reference Manual [Contents][Index]

6 Definitions

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

Public Interface
Internals

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

6.1 Public Interface

Special variables
Macros
Ordinary functions
Standalone methods

Next: Macros, Previous: Public Interface, Up: Public Interface [Contents][Index]

6.1.1 Special variables

Special Variable: *similarity-high-threshold* ¶

Package: cl-libpuzzle.
Source: cl-libpuzzle.lisp.

Special Variable: *similarity-low-threshold* ¶

Package: cl-libpuzzle.
Source: cl-libpuzzle.lisp.

Special Variable: *similarity-lower-threshold* ¶

Package: cl-libpuzzle.
Source: cl-libpuzzle.lisp.

Special Variable: *similarity-threshold* ¶

Package: cl-libpuzzle.
Source: cl-libpuzzle.lisp.

Next: Ordinary functions, Previous: Special variables, Up: Public Interface [Contents][Index]

6.1.2 Macros

Macro: with-context-cvecs (context cvecs &body body) ¶

Package: cl-libpuzzle.
Source: cl-libpuzzle.lisp.

Next: Standalone methods, Previous: Macros, Up: Public Interface [Contents][Index]

6.1.3 Ordinary functions

Function: puzzle-compress-cvec (context compressed-cvec cvec) ¶

Package: cl-libpuzzle.
Source: cl-libpuzzle.lisp.

Function: puzzle-cvec-cksum (context cvec sum) ¶

Package: cl-libpuzzle.
Source: cl-libpuzzle.lisp.

Function: puzzle-dump-cvec (context cvec) ¶

Package: cl-libpuzzle.
Source: cl-libpuzzle.lisp.

Function: puzzle-dump-dvec (context dvec) ¶

Package: cl-libpuzzle.
Source: cl-libpuzzle.lisp.

Function: puzzle-fill-cvec-from-dvec (context cvec dvec) ¶

Package: cl-libpuzzle.
Source: cl-libpuzzle.lisp.

Function: puzzle-fill-cvec-from-file (context cvec file) ¶

Package: cl-libpuzzle.
Source: cl-libpuzzle.lisp.

Function: puzzle-fill-dvec-from-file (context dvec file) ¶

Package: cl-libpuzzle.
Source: cl-libpuzzle.lisp.

Function: puzzle-free-compressed-cvec (context compressed-cvec) ¶

Package: cl-libpuzzle.
Source: cl-libpuzzle.lisp.

Function: puzzle-free-context (context) ¶

Package: cl-libpuzzle.
Source: cl-libpuzzle.lisp.

Function: puzzle-free-cvec (context cvec) ¶

Package: cl-libpuzzle.
Source: cl-libpuzzle.lisp.

Function: puzzle-free-dvec (context dvec) ¶

Package: cl-libpuzzle.
Source: cl-libpuzzle.lisp.

Function: puzzle-init-compressed-cvec (context compressed-cvec) ¶

Package: cl-libpuzzle.
Source: cl-libpuzzle.lisp.

Function: puzzle-init-context (context) ¶

Package: cl-libpuzzle.
Source: cl-libpuzzle.lisp.

Function: puzzle-init-cvec (context cvec) ¶

Package: cl-libpuzzle.
Source: cl-libpuzzle.lisp.

Function: puzzle-init-dvec (context dvec) ¶

Package: cl-libpuzzle.
Source: cl-libpuzzle.lisp.

Function: puzzle-set-autocrop (context enable) ¶

Package: cl-libpuzzle.
Source: cl-libpuzzle.lisp.

Function: puzzle-set-contrast-barrier-for-cropping (context barrier) ¶

Package: cl-libpuzzle.
Source: cl-libpuzzle.lisp.

Function: puzzle-set-lambdas (context lambdas) ¶

Package: cl-libpuzzle.
Source: cl-libpuzzle.lisp.

Function: puzzle-set-max-cropping-ratio (context ratio) ¶

Package: cl-libpuzzle.
Source: cl-libpuzzle.lisp.

Function: puzzle-set-max-height (context height) ¶

Package: cl-libpuzzle.
Source: cl-libpuzzle.lisp.

Function: puzzle-set-max-width (context width) ¶

Package: cl-libpuzzle.
Source: cl-libpuzzle.lisp.

Function: puzzle-set-noise-cutoff (context noise-cutoff) ¶

Package: cl-libpuzzle.
Source: cl-libpuzzle.lisp.

Function: puzzle-set-p-ratio (context p-ratio) ¶

Package: cl-libpuzzle.
Source: cl-libpuzzle.lisp.

Function: puzzle-uncompress-cvec (context compressed-cvec cvec) ¶

Package: cl-libpuzzle.
Source: cl-libpuzzle.lisp.

Function: puzzle-vector-euclidean-length (context cvec) ¶

Package: cl-libpuzzle.
Source: cl-libpuzzle.lisp.

Function: puzzle-vector-normalized-distance (context cvec1 cvec2 fix-for-texts) ¶

Package: cl-libpuzzle.
Source: cl-libpuzzle.lisp.

Function: puzzle-vector-sub (context cvec1 cvec2 fix-for-texts) ¶

Package: cl-libpuzzle.
Source: cl-libpuzzle.lisp.

Previous: Ordinary functions, Up: Public Interface [Contents][Index]

6.1.4 Standalone methods

Method: translate-from-foreign (value (type puzzle-code-type)) ¶

Package: cffi.
Source: cl-libpuzzle.lisp.

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

6.2 Internals

Generic functions
Conditions
Classes

Next: Conditions, Previous: Internals, Up: Internals [Contents][Index]

6.2.1 Generic functions

Generic Reader: puzzle-error-code (condition) ¶

Package

cl-libpuzzle.

Methods

Reader Method: puzzle-error-code ((condition puzzle-code-error)) ¶

Source: cl-libpuzzle.lisp.
Target Slot: $code.

Next: Classes, Previous: Generic functions, Up: Internals [Contents][Index]

6.2.2 Conditions

Condition: puzzle-code-error ¶

Package

cl-libpuzzle.

Source

cl-libpuzzle.lisp.

Direct superclasses

condition.

Direct methods

puzzle-error-code.

Direct slots

Slot: $code ¶

Initargs: :puzzle-code
Readers: puzzle-error-code.
Writers: This slot is read-only.

Previous: Conditions, Up: Internals [Contents][Index]

6.2.3 Classes

Class: puzzle-code-type ¶

Package

cl-libpuzzle.

Source

cl-libpuzzle.lisp.

Direct superclasses

enhanced-foreign-type.

Direct methods

translate-from-foreign.

Direct Default Initargs

Initarg	Value
`:actual-type`	`(quote (int))`

Class: puzzle-compressed-cvec-tclass ¶

Package

cl-libpuzzle.

Source

cl-libpuzzle.lisp.

Direct superclasses

foreign-struct-type.
translatable-foreign-type.

Class: puzzle-context-tclass ¶

Package

cl-libpuzzle.

Source

cl-libpuzzle.lisp.

Direct superclasses

foreign-struct-type.
translatable-foreign-type.

Class: puzzle-cvec-tclass ¶

Package

cl-libpuzzle.

Source

cl-libpuzzle.lisp.

Direct superclasses

foreign-struct-type.
translatable-foreign-type.

Class: puzzle-dvec-tclass ¶

Package

cl-libpuzzle.

Source

cl-libpuzzle.lisp.

Direct superclasses

foreign-struct-type.
translatable-foreign-type.

Previous: Definitions, Up: The cl-libpuzzle Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

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

A.1 Concepts

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

A.2 Functions

Jump to:	F G M P T W

	Index Entry	Section

F
	`Function, puzzle-compress-cvec`:	Public ordinary functions
	`Function, puzzle-cvec-cksum`:	Public ordinary functions
	`Function, puzzle-dump-cvec`:	Public ordinary functions
	`Function, puzzle-dump-dvec`:	Public ordinary functions
	`Function, puzzle-fill-cvec-from-dvec`:	Public ordinary functions
	`Function, puzzle-fill-cvec-from-file`:	Public ordinary functions
	`Function, puzzle-fill-dvec-from-file`:	Public ordinary functions
	`Function, puzzle-free-compressed-cvec`:	Public ordinary functions
	`Function, puzzle-free-context`:	Public ordinary functions
	`Function, puzzle-free-cvec`:	Public ordinary functions
	`Function, puzzle-free-dvec`:	Public ordinary functions
	`Function, puzzle-init-compressed-cvec`:	Public ordinary functions
	`Function, puzzle-init-context`:	Public ordinary functions
	`Function, puzzle-init-cvec`:	Public ordinary functions
	`Function, puzzle-init-dvec`:	Public ordinary functions
	`Function, puzzle-set-autocrop`:	Public ordinary functions
	`Function, puzzle-set-contrast-barrier-for-cropping`:	Public ordinary functions
	`Function, puzzle-set-lambdas`:	Public ordinary functions
	`Function, puzzle-set-max-cropping-ratio`:	Public ordinary functions
	`Function, puzzle-set-max-height`:	Public ordinary functions
	`Function, puzzle-set-max-width`:	Public ordinary functions
	`Function, puzzle-set-noise-cutoff`:	Public ordinary functions
	`Function, puzzle-set-p-ratio`:	Public ordinary functions
	`Function, puzzle-uncompress-cvec`:	Public ordinary functions
	`Function, puzzle-vector-euclidean-length`:	Public ordinary functions
	`Function, puzzle-vector-normalized-distance`:	Public ordinary functions
	`Function, puzzle-vector-sub`:	Public ordinary functions

G
	`Generic Function, puzzle-error-code`:	Private generic functions

M
	`Macro, with-context-cvecs`:	Public macros
	`Method, puzzle-error-code`:	Private generic functions
	`Method, translate-from-foreign`:	Public standalone methods

P
	`puzzle-compress-cvec`:	Public ordinary functions
	`puzzle-cvec-cksum`:	Public ordinary functions
	`puzzle-dump-cvec`:	Public ordinary functions
	`puzzle-dump-dvec`:	Public ordinary functions
	`puzzle-error-code`:	Private generic functions
	`puzzle-error-code`:	Private generic functions
	`puzzle-fill-cvec-from-dvec`:	Public ordinary functions
	`puzzle-fill-cvec-from-file`:	Public ordinary functions
	`puzzle-fill-dvec-from-file`:	Public ordinary functions
	`puzzle-free-compressed-cvec`:	Public ordinary functions
	`puzzle-free-context`:	Public ordinary functions
	`puzzle-free-cvec`:	Public ordinary functions
	`puzzle-free-dvec`:	Public ordinary functions
	`puzzle-init-compressed-cvec`:	Public ordinary functions
	`puzzle-init-context`:	Public ordinary functions
	`puzzle-init-cvec`:	Public ordinary functions
	`puzzle-init-dvec`:	Public ordinary functions
	`puzzle-set-autocrop`:	Public ordinary functions
	`puzzle-set-contrast-barrier-for-cropping`:	Public ordinary functions
	`puzzle-set-lambdas`:	Public ordinary functions
	`puzzle-set-max-cropping-ratio`:	Public ordinary functions
	`puzzle-set-max-height`:	Public ordinary functions
	`puzzle-set-max-width`:	Public ordinary functions
	`puzzle-set-noise-cutoff`:	Public ordinary functions
	`puzzle-set-p-ratio`:	Public ordinary functions
	`puzzle-uncompress-cvec`:	Public ordinary functions
	`puzzle-vector-euclidean-length`:	Public ordinary functions
	`puzzle-vector-normalized-distance`:	Public ordinary functions
	`puzzle-vector-sub`:	Public ordinary functions

T
	`translate-from-foreign`:	Public standalone methods

W
	`with-context-cvecs`:	Public macros

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Jump to:	$ * S

	Index Entry	Section

$
	`$code`:	Private conditions

*
	`similarity-high-threshold`:	Public special variables
	`similarity-low-threshold`:	Public special variables
	`similarity-lower-threshold`:	Public special variables
	`similarity-threshold`:	Public special variables

S
	`Slot, $code`:	Private conditions
	`Special Variable, similarity-high-threshold`:	Public special variables
	`Special Variable, similarity-low-threshold`:	Public special variables
	`Special Variable, similarity-lower-threshold`:	Public special variables
	`Special Variable, similarity-threshold`:	Public special variables

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

A.4 Data types

Jump to:	C F M P S

	Index Entry	Section

C
	`cl-libpuzzle`:	The cl-libpuzzle system
	`cl-libpuzzle`:	The cl-libpuzzle package
	`cl-libpuzzle-asd`:	The cl-libpuzzle-asd package
	`cl-libpuzzle.asd`:	The cl-libpuzzle/cl-libpuzzle․asd file
	`cl-libpuzzle.lisp`:	The cl-libpuzzle/src/cl-libpuzzle․lisp file
	`Class, puzzle-code-type`:	Private classes
	`Class, puzzle-compressed-cvec-tclass`:	Private classes
	`Class, puzzle-context-tclass`:	Private classes
	`Class, puzzle-cvec-tclass`:	Private classes
	`Class, puzzle-dvec-tclass`:	Private classes
	`Condition, puzzle-code-error`:	Private conditions

F
	`File, cl-libpuzzle.asd`:	The cl-libpuzzle/cl-libpuzzle․asd file
	`File, cl-libpuzzle.lisp`:	The cl-libpuzzle/src/cl-libpuzzle․lisp file

M
	`Module, src`:	The cl-libpuzzle/src module

P
	`Package, cl-libpuzzle`:	The cl-libpuzzle package
	`Package, cl-libpuzzle-asd`:	The cl-libpuzzle-asd package
	`puzzle-code-error`:	Private conditions
	`puzzle-code-type`:	Private classes
	`puzzle-compressed-cvec-tclass`:	Private classes
	`puzzle-context-tclass`:	Private classes
	`puzzle-cvec-tclass`:	Private classes
	`puzzle-dvec-tclass`:	Private classes

S
	`src`:	The cl-libpuzzle/src module
	`System, cl-libpuzzle`:	The cl-libpuzzle system

The cl-libpuzzle Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 cl-libpuzzle

3 Modules

3.1 cl-libpuzzle/src

4 Files

4.1 Lisp

4.1.1 cl-libpuzzle/cl-libpuzzle.asd

4.1.2 cl-libpuzzle/src/cl-libpuzzle.lisp

5 Packages

5.1 cl-libpuzzle-asd

5.2 cl-libpuzzle

6 Definitions

6.1 Public Interface

6.1.1 Special variables

6.1.2 Macros

6.1.3 Ordinary functions

6.1.4 Standalone methods

6.2 Internals

6.2.1 Generic functions

6.2.2 Conditions

6.2.3 Classes

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `cl-libpuzzle`

3.1 `cl-libpuzzle/src`

4.1.1 `cl-libpuzzle/cl-libpuzzle.asd`

4.1.2 `cl-libpuzzle/src/cl-libpuzzle.lisp`

5.1 `cl-libpuzzle-asd`

5.2 `cl-libpuzzle`