The cl-libpuzzle Reference Manual

Table of Contents

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

The cl-libpuzzle Reference Manual

This is the cl-libpuzzle Reference Manual, version 0.1, generated automatically by Declt version 2.3 "Robert April" on Tue Feb 20 08:08:59 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

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

Copyright

Copyright (c) 2013 Masato Sogame (poketo7878@gmail.com)


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


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

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

Copyright (c) 2013 Masato Sogame (poketo7878@gmail.com)

Version

0.1

Dependency

cffi

Source

cl-libpuzzle.asd (file)

Component

src (module)


Next: , Previous: , Up: Top   [Contents][Index]

3 Modules

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


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

3.1 cl-libpuzzle/src

Parent

cl-libpuzzle (system)

Location

src/

Component

cl-libpuzzle.lisp (file)


Next: , Previous: , Up: Top   [Contents][Index]

4 Files

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


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

4.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.1 cl-libpuzzle.asd

Location

cl-libpuzzle.asd

Systems

cl-libpuzzle (system)

Packages

cl-libpuzzle-asd


Previous: , Up: Lisp files   [Contents][Index]

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

Parent

src (module)

Location

src/cl-libpuzzle.lisp

Packages

cl-libpuzzle

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

5.1 cl-libpuzzle-asd

Source

cl-libpuzzle.asd

Use List

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

5.2 cl-libpuzzle

Source

cl-libpuzzle.lisp (file)

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

6 Definitions

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


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

6.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.2 Macros

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

cl-libpuzzle

Source

cl-libpuzzle.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

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)


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

6.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

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)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

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)


Previous: , Up: Internal definitions   [Contents][Index]

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
InitargValue
: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)

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

Appendix A Indexes


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

A.1 Concepts

Jump to:   C   F   L   M  
Index Entry  Section

C
cl-libpuzzle.asd: The cl-libpuzzle<dot>asd file
cl-libpuzzle/src: The cl-libpuzzle/src module
cl-libpuzzle/src/cl-libpuzzle.lisp: The cl-libpuzzle/src/cl-libpuzzle<dot>lisp file

F
File, Lisp, cl-libpuzzle.asd: The cl-libpuzzle<dot>asd file
File, Lisp, cl-libpuzzle/src/cl-libpuzzle.lisp: The cl-libpuzzle/src/cl-libpuzzle<dot>lisp file

L
Lisp File, cl-libpuzzle.asd: The cl-libpuzzle<dot>asd file
Lisp File, cl-libpuzzle/src/cl-libpuzzle.lisp: The cl-libpuzzle/src/cl-libpuzzle<dot>lisp file

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

Jump to:   C   F   L   M  

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

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  

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

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  

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

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