The cl-libpuzzle Reference Manual

This is the cl-libpuzzle Reference Manual, version 0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 10:20:26 2020 GMT+0.

1 Introduction

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

2 Systems

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

2.1 `cl-libpuzzle`

Author

Masato Sogame

License

LLGPL

Description

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

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

Source

cl-libpuzzle.asd (file)

Component

src (module)

3 Modules

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

3.1 `cl-libpuzzle/src`

Parent: cl-libpuzzle (system)
Location: src/
Component: cl-libpuzzle.lisp (file)

4 Files

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

4.1 Lisp

4.1.1 `cl-libpuzzle.asd`

Location: cl-libpuzzle.asd
Systems: cl-libpuzzle (system)
Packages: cl-libpuzzle-asd

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

Parent

src (module)

Location

src/cl-libpuzzle.lisp

Packages

cl-libpuzzle

Exported Definitions

*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)

Internal Definitions

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

5 Packages

Packages are listed by definition order.

5.1 `cl-libpuzzle-asd`

Source

cl-libpuzzle.asd

Use List

asdf/interface
common-lisp

5.2 `cl-libpuzzle`

Source

cl-libpuzzle.lisp (file)

Use List

cffi
common-lisp

Exported Definitions

*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)

Internal Definitions

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 function)
puzzle-error-code (method)

6 Definitions

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

6.1 Exported definitions

6.1.1 Special variables

Special Variable: *similarity-high-threshold*

Package: cl-libpuzzle
Source: cl-libpuzzle.lisp (file)

Special Variable: *similarity-low-threshold*

Package: cl-libpuzzle
Source: cl-libpuzzle.lisp (file)

Special Variable: *similarity-lower-threshold*

Package: cl-libpuzzle
Source: cl-libpuzzle.lisp (file)

Special Variable: *similarity-threshold*

Package: cl-libpuzzle
Source: cl-libpuzzle.lisp (file)

6.1.2 Macros

Macro: with-context-cvecs CONTEXT CVECS &body BODY

Package: cl-libpuzzle
Source: cl-libpuzzle.lisp (file)

6.1.3 Functions

Function: puzzle-compress-cvec CONTEXT COMPRESSED-CVEC CVEC

Package: cl-libpuzzle
Source: cl-libpuzzle.lisp (file)

Function: puzzle-cvec-cksum CONTEXT CVEC SUM

Package: cl-libpuzzle
Source: cl-libpuzzle.lisp (file)

Function: puzzle-dump-cvec CONTEXT CVEC

Package: cl-libpuzzle
Source: cl-libpuzzle.lisp (file)

Function: puzzle-dump-dvec CONTEXT DVEC

Package: cl-libpuzzle
Source: cl-libpuzzle.lisp (file)

Function: puzzle-fill-cvec-from-dvec CONTEXT CVEC DVEC

Package: cl-libpuzzle
Source: cl-libpuzzle.lisp (file)

Function: puzzle-fill-cvec-from-file CONTEXT CVEC FILE

Package: cl-libpuzzle
Source: cl-libpuzzle.lisp (file)

Function: puzzle-fill-dvec-from-file CONTEXT DVEC FILE

Package: cl-libpuzzle
Source: cl-libpuzzle.lisp (file)

Function: puzzle-free-compressed-cvec CONTEXT COMPRESSED-CVEC

Package: cl-libpuzzle
Source: cl-libpuzzle.lisp (file)

Function: puzzle-free-context CONTEXT

Package: cl-libpuzzle
Source: cl-libpuzzle.lisp (file)

Function: puzzle-free-cvec CONTEXT CVEC

Package: cl-libpuzzle
Source: cl-libpuzzle.lisp (file)

Function: puzzle-free-dvec CONTEXT DVEC

Package: cl-libpuzzle
Source: cl-libpuzzle.lisp (file)

Function: puzzle-init-compressed-cvec CONTEXT COMPRESSED-CVEC

Package: cl-libpuzzle
Source: cl-libpuzzle.lisp (file)

Function: puzzle-init-context CONTEXT

Package: cl-libpuzzle
Source: cl-libpuzzle.lisp (file)

Function: puzzle-init-cvec CONTEXT CVEC

Package: cl-libpuzzle
Source: cl-libpuzzle.lisp (file)

Function: puzzle-init-dvec CONTEXT DVEC

Package: cl-libpuzzle
Source: cl-libpuzzle.lisp (file)

Function: puzzle-set-autocrop CONTEXT ENABLE

Package: cl-libpuzzle
Source: cl-libpuzzle.lisp (file)

Function: puzzle-set-contrast-barrier-for-cropping CONTEXT BARRIER

Package: cl-libpuzzle
Source: cl-libpuzzle.lisp (file)

Function: puzzle-set-lambdas CONTEXT LAMBDAS

Package: cl-libpuzzle
Source: cl-libpuzzle.lisp (file)

Function: puzzle-set-max-cropping-ratio CONTEXT RATIO

Package: cl-libpuzzle
Source: cl-libpuzzle.lisp (file)

Function: puzzle-set-max-height CONTEXT HEIGHT

Package: cl-libpuzzle
Source: cl-libpuzzle.lisp (file)

Function: puzzle-set-max-width CONTEXT WIDTH

Package: cl-libpuzzle
Source: cl-libpuzzle.lisp (file)

Function: puzzle-set-noise-cutoff CONTEXT NOISE-CUTOFF

Package: cl-libpuzzle
Source: cl-libpuzzle.lisp (file)

Function: puzzle-set-p-ratio CONTEXT P-RATIO

Package: cl-libpuzzle
Source: cl-libpuzzle.lisp (file)

Function: puzzle-uncompress-cvec CONTEXT COMPRESSED-CVEC CVEC

Package: cl-libpuzzle
Source: cl-libpuzzle.lisp (file)

Function: puzzle-vector-euclidean-length CONTEXT CVEC

Package: cl-libpuzzle
Source: cl-libpuzzle.lisp (file)

Function: puzzle-vector-normalized-distance CONTEXT CVEC1 CVEC2 FIX-FOR-TEXTS

Package: cl-libpuzzle
Source: cl-libpuzzle.lisp (file)

Function: puzzle-vector-sub CONTEXT CVEC1 CVEC2 FIX-FOR-TEXTS

Package: cl-libpuzzle
Source: cl-libpuzzle.lisp (file)

6.2 Internal definitions

6.2.1 Generic functions

Generic Function: puzzle-error-code CONDITION

Package

cl-libpuzzle

Methods

Method: puzzle-error-code (CONDITION puzzle-code-error)

Source: cl-libpuzzle.lisp (file)

6.2.2 Conditions

Condition: puzzle-code-error ()

Package

cl-libpuzzle

Source

cl-libpuzzle.lisp (file)

Direct superclasses

condition (condition)

Direct methods

puzzle-error-code (method)

Direct slots

Slot: $code

Initargs: :puzzle-code
Readers: puzzle-error-code (generic function)

6.2.3 Classes

Class: puzzle-code-type ()

Package

cl-libpuzzle

Source

cl-libpuzzle.lisp (file)

Direct superclasses

enhanced-foreign-type (class)

Direct methods

translate-from-foreign (method)

Direct Default Initargs

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

Class: puzzle-compressed-cvec-tclass ()

Package

cl-libpuzzle

Source

cl-libpuzzle.lisp (file)

Direct superclasses

translatable-foreign-type (class)
foreign-struct-type (class)

Class: puzzle-context-tclass ()

Package

cl-libpuzzle

Source

cl-libpuzzle.lisp (file)

Direct superclasses

translatable-foreign-type (class)
foreign-struct-type (class)

Class: puzzle-cvec-tclass ()

Package

cl-libpuzzle

Source

cl-libpuzzle.lisp (file)

Direct superclasses

translatable-foreign-type (class)
foreign-struct-type (class)

Class: puzzle-dvec-tclass ()

Package

cl-libpuzzle

Source

cl-libpuzzle.lisp (file)

Direct superclasses

translatable-foreign-type (class)
foreign-struct-type (class)

Appendix A Indexes

A.1 Concepts

Jump to:	C F L M

	Index Entry	Section

C
	`cl-libpuzzle.asd`:	The cl-libpuzzle․asd file
	`cl-libpuzzle/src`:	The cl-libpuzzle/src module
	`cl-libpuzzle/src/cl-libpuzzle.lisp`:	The cl-libpuzzle/src/cl-libpuzzle․lisp file

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

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

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

Jump to:	C F L M

A.2 Functions

Jump to:	F G M P W

	Index Entry	Section

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

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

M
	`Macro, with-context-cvecs`:	Exported macros
	`Method, puzzle-error-code`:	Internal generic functions

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

W
	`with-context-cvecs`:	Exported macros

Jump to:	F G M P W

A.3 Variables

Jump to:	$ * S

	Index Entry	Section

$
	`$code`:	Internal conditions

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

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

Jump to:	$ * S

A.4 Data types

Jump to:	C 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
	`Class, puzzle-code-type`:	Internal classes
	`Class, puzzle-compressed-cvec-tclass`:	Internal classes
	`Class, puzzle-context-tclass`:	Internal classes
	`Class, puzzle-cvec-tclass`:	Internal classes
	`Class, puzzle-dvec-tclass`:	Internal classes
	`Condition, puzzle-code-error`:	Internal conditions

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

S
	`System, cl-libpuzzle`:	The cl-libpuzzle system

Jump to:	C P S

• Introduction		What cl-libpuzzle is all about
• Systems		The systems documentation
• Modules		The modules documentation
• Files		The files documentation
• Packages		The packages documentation
• Definitions		The symbols documentation
• Indexes		Concepts, functions, variables and data types

• Concept index
• Function index
• Variable index
• Data type index

• The cl-libpuzzle.asd file
• The cl-libpuzzle/src/cl-libpuzzle.lisp file

• The cl-libpuzzle-asd package
• The cl-libpuzzle package

• Exported special variables
• Exported macros
• Exported functions

• Internal generic functions
• Internal conditions
• Internal classes

The cl-libpuzzle Reference Manual

Table of Contents

The cl-libpuzzle Reference Manual

1 Introduction

Cl-Libpuzzle

Usage

Extra

Author

Copyright

2 Systems

2.1 cl-libpuzzle

3 Modules

3.1 cl-libpuzzle/src

4 Files

4.1 Lisp

4.1.1 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 Exported definitions

6.1.1 Special variables

6.1.2 Macros

6.1.3 Functions

6.2 Internal definitions

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.asd`

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

5.1 `cl-libpuzzle-asd`

5.2 `cl-libpuzzle`