The cl-wordcut Reference Manual

Table of Contents

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

The cl-wordcut Reference Manual

This is the cl-wordcut Reference Manual, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:27:53 2018 GMT+0.


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

1 Introduction

cl-wordcut

cl-wordcut is a word segmentation tool for ASEAN languages written in Common Lisp.

Example

Khmer (Cambodian)

(require 'cl-wordcut)
(defvar *dict* (cl-wordcut:load-dict-from-bundle "khmerwords.txt"))
(defvar *wordcut* (cl-wordcut:create-basic-wordcut *dict*))
(funcall *wordcut* "ភាសាខ្មែរ")

Lao

(require 'cl-wordcut)
(defvar *dict* (cl-wordcut:load-dict-from-bundle "laowords.txt"))
(defvar *wordcut* (cl-wordcut:create-basic-wordcut *dict*))
(funcall *wordcut* "ພາສາລາວມີ")

Thai

(require 'cl-wordcut)
(defvar *dict* (cl-wordcut:load-dict-from-bundle "tdict-std.txt"))
(defvar *wordcut* (cl-wordcut:create-basic-wordcut *dict

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-wordcut

Author

Vee Satayamas

License

LLGPL

Description

Word segmentation tools for ASEAN languages written in Common Lisp

Dependency

asdf

Source

cl-wordcut.asd (file)

Components

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

3 Files

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


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

3.1 Lisp


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

3.1.1 cl-wordcut.asd

Location

/home/quickref/quicklisp/dists/quicklisp/software/cl-wordcut-20160421-git/cl-wordcut.asd

Systems

cl-wordcut (system)


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

3.1.2 cl-wordcut/packages.lisp

Parent

cl-wordcut (system)

Location

packages.lisp

Packages

cl-wordcut


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

3.1.3 cl-wordcut/wordcut.lisp

Dependency

packages.lisp (file)

Parent

cl-wordcut (system)

Location

wordcut.lisp

Exported Definitions
Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 cl-wordcut

Source

packages.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

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

5 Definitions

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


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

5.1 Exported definitions


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

5.1.1 Functions

Function: basic-update-dag DAG I LEFT POINTERS BUILD-EDGES SPACE-INFO EDGE-CLASS
Package

cl-wordcut

Source

wordcut.lisp (file)

Function: best-edge ALL-EDGES
Package

cl-wordcut

Source

wordcut.lisp (file)

Function: build-dag TEXT BUILD-EDGES UPDATE-POINTERS UPDATE-DAG EDGE-CLASS
Package

cl-wordcut

Source

wordcut.lisp (file)

Function: create-basic-wordcut DICT
Package

cl-wordcut

Source

wordcut.lisp (file)

Function: create-edges-builder EDGE-CLASS
Package

cl-wordcut

Source

wordcut.lisp (file)

Function: create-pointers-updater POINTER-CLASS DICT
Package

cl-wordcut

Source

wordcut.lisp (file)

Function: dag-to-list DAG TEXT
Package

cl-wordcut

Source

wordcut.lisp (file)

Function: dict-seek DICT POLICY L R OFFSET CH
Package

cl-wordcut

Source

wordcut.lisp (file)

Function: load-dict-from-bundle FILE-NAME
Package

cl-wordcut

Source

wordcut.lisp (file)

Function: proto-dag-to-list DAG TEXT MAKE-ENTRY
Package

cl-wordcut

Source

wordcut.lisp (file)


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

5.1.2 Generic functions

Generic Function: chunk OBJECT
Generic Function: (setf chunk) NEW-VALUE OBJECT
Package

cl-wordcut

Methods
Method: chunk (EDGE edge)

automatically generated reader method

Source

wordcut.lisp (file)

Method: (setf chunk) NEW-VALUE (EDGE edge)

automatically generated writer method

Source

wordcut.lisp (file)

Generic Function: dict OBJECT
Generic Function: (setf dict) NEW-VALUE OBJECT
Package

cl-wordcut

Methods
Method: dict (DICT-POINTER dict-pointer)

automatically generated reader method

Source

wordcut.lisp (file)

Method: (setf dict) NEW-VALUE (DICT-POINTER dict-pointer)

automatically generated writer method

Source

wordcut.lisp (file)

Generic Function: etype OBJECT
Generic Function: (setf etype) NEW-VALUE OBJECT
Package

cl-wordcut

Methods
Method: etype (EDGE edge)

automatically generated reader method

Source

wordcut.lisp (file)

Method: (setf etype) NEW-VALUE (EDGE edge)

automatically generated writer method

Source

wordcut.lisp (file)

Generic Function: is-better-than O1 O2
Package

cl-wordcut

Source

wordcut.lisp (file)

Methods
Method: is-better-than (O1 edge) (O2 edge)
Generic Function: is-final OBJECT
Generic Function: (setf is-final) NEW-VALUE OBJECT
Package

cl-wordcut

Methods
Method: is-final (SPACE-INFO space-info)

automatically generated reader method

Source

wordcut.lisp (file)

Method: (setf is-final) NEW-VALUE (SPACE-INFO space-info)

automatically generated writer method

Source

wordcut.lisp (file)

Method: is-final (DICT-POINTER dict-pointer)

automatically generated reader method

Source

wordcut.lisp (file)

Method: (setf is-final) NEW-VALUE (DICT-POINTER dict-pointer)

automatically generated writer method

Source

wordcut.lisp (file)

Generic Function: l OBJECT
Generic Function: (setf l) NEW-VALUE OBJECT
Package

cl-wordcut

Methods
Method: l (DICT-POINTER dict-pointer)

automatically generated reader method

Source

wordcut.lisp (file)

Method: (setf l) NEW-VALUE (DICT-POINTER dict-pointer)

automatically generated writer method

Source

wordcut.lisp (file)

Generic Function: offset OBJECT
Generic Function: (setf offset) NEW-VALUE OBJECT
Package

cl-wordcut

Methods
Method: offset (SPACE-INFO space-info)

automatically generated reader method

Source

wordcut.lisp (file)

Method: (setf offset) NEW-VALUE (SPACE-INFO space-info)

automatically generated writer method

Source

wordcut.lisp (file)

Method: offset (DICT-POINTER dict-pointer)

automatically generated reader method

Source

wordcut.lisp (file)

Method: (setf offset) NEW-VALUE (DICT-POINTER dict-pointer)

automatically generated writer method

Source

wordcut.lisp (file)

Generic Function: s OBJECT
Generic Function: (setf s) NEW-VALUE OBJECT
Package

cl-wordcut

Methods
Method: s (SPACE-INFO space-info)

automatically generated reader method

Source

wordcut.lisp (file)

Method: (setf s) NEW-VALUE (SPACE-INFO space-info)

automatically generated writer method

Source

wordcut.lisp (file)

Method: s (EDGE edge)

automatically generated reader method

Source

wordcut.lisp (file)

Method: (setf s) NEW-VALUE (EDGE edge)

automatically generated writer method

Source

wordcut.lisp (file)

Method: s (DICT-POINTER dict-pointer)

automatically generated reader method

Source

wordcut.lisp (file)

Method: (setf s) NEW-VALUE (DICT-POINTER dict-pointer)

automatically generated writer method

Source

wordcut.lisp (file)

Generic Function: unk OBJECT
Generic Function: (setf unk) NEW-VALUE OBJECT
Package

cl-wordcut

Methods
Method: unk (EDGE edge)

automatically generated reader method

Source

wordcut.lisp (file)

Method: (setf unk) NEW-VALUE (EDGE edge)

automatically generated writer method

Source

wordcut.lisp (file)

Generic Function: update POINTER CH
Package

cl-wordcut

Source

wordcut.lisp (file)

Methods
Method: update (POINTER dict-pointer) (CH character)
Generic Function: update-lookahead INFO CH NEXT-CH
Package

cl-wordcut

Source

wordcut.lisp (file)

Methods
Method: update-lookahead (INFO space-info) (CH character) (NEXT-CH null)
Method: update-lookahead (INFO space-info) (CH character) (NEXT-CH character)

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

5.1.3 Classes

Class: dict-pointer ()
Package

cl-wordcut

Source

wordcut.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
  • print-object (method)
  • update (method)
  • dict (method)
  • dict (method)
  • is-final (method)
  • is-final (method)
  • offset (method)
  • offset (method)
  • r (method)
  • r (method)
  • l (method)
  • l (method)
  • s (method)
  • s (method)
Direct slots
Slot: s
Initargs

:s

Initform

0

Readers

s (generic function)

Writers

(setf s) (generic function)

Slot: l
Initargs

:l

Initform

0

Readers

l (generic function)

Writers

(setf l) (generic function)

Slot: r
Initargs

:r

Initform

0

Readers

r (generic function)

Writers

(setf r) (generic function)

Slot: offset
Initargs

:offset

Initform

0

Readers

offset (generic function)

Writers

(setf offset) (generic function)

Slot: is-final
Initargs

:is-final

Readers

is-final (generic function)

Writers

(setf is-final) (generic function)

Slot: dict
Initargs

:dict

Readers

dict (generic function)

Writers

(setf dict) (generic function)

Class: edge ()
Package

cl-wordcut

Source

wordcut.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
  • print-object (method)
  • is-better-than (method)
  • etype (method)
  • etype (method)
  • chunk (method)
  • chunk (method)
  • unk (method)
  • unk (method)
  • s (method)
  • s (method)
Direct slots
Slot: s
Initargs

:s

Initform

0

Readers

s (generic function)

Writers

(setf s) (generic function)

Slot: unk
Initargs

:unk

Initform

0

Readers

unk (generic function)

Writers

(setf unk) (generic function)

Slot: chunk
Initargs

:chunk

Initform

0

Readers

chunk (generic function)

Writers

(setf chunk) (generic function)

Slot: etype
Initargs

:etype

Initform

:init

Readers

etype (generic function)

Writers

(setf etype) (generic function)

Class: space-info ()
Package

cl-wordcut

Source

wordcut.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: s
Initargs

:s

Initform

0

Readers

s (generic function)

Writers

(setf s) (generic function)

Slot: offset
Initargs

:offset

Initform

0

Readers

offset (generic function)

Writers

(setf offset) (generic function)

Slot: is-final
Initargs

:is-final

Readers

is-final (generic function)

Writers

(setf is-final) (generic function)


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

5.2 Internal definitions


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

5.2.1 Functions

Function: is-space CH
Package

cl-wordcut

Source

wordcut.lisp (file)

Function: unk-edge DAG LEFT EDGE-CLASS
Package

cl-wordcut

Source

wordcut.lisp (file)

Function: update-dag-dict DAG I FINAL-POINTERS BUILD-EDGES
Package

cl-wordcut

Source

wordcut.lisp (file)

Function: update-dag-space DAG I SPACE-INFO EDGE-CLASS
Package

cl-wordcut

Source

wordcut.lisp (file)

Function: update-dag-unk DAG I LEFT EDGE-CLASS
Package

cl-wordcut

Source

wordcut.lisp (file)

Function: update-space-info INFO CURRENT-IS-SPACE NEXT-IS-SPACE
Package

cl-wordcut

Source

wordcut.lisp (file)


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

5.2.2 Generic functions

Generic Function: r OBJECT
Generic Function: (setf r) NEW-VALUE OBJECT
Package

cl-wordcut

Methods
Method: r (DICT-POINTER dict-pointer)

automatically generated reader method

Source

wordcut.lisp (file)

Method: (setf r) NEW-VALUE (DICT-POINTER dict-pointer)

automatically generated writer method

Source

wordcut.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
cl-wordcut.asd: The cl-wordcut<dot>asd file
cl-wordcut/packages.lisp: The cl-wordcut/packages<dot>lisp file
cl-wordcut/wordcut.lisp: The cl-wordcut/wordcut<dot>lisp file

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

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

Jump to:   C   F   L  

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

A.2 Functions

Jump to:   (  
B   C   D   E   F   G   I   L   M   O   P   R   S   U  
Index Entry  Section

(
(setf chunk): Exported generic functions
(setf chunk): Exported generic functions
(setf dict): Exported generic functions
(setf dict): Exported generic functions
(setf etype): Exported generic functions
(setf etype): Exported generic functions
(setf is-final): Exported generic functions
(setf is-final): Exported generic functions
(setf is-final): Exported generic functions
(setf l): Exported generic functions
(setf l): Exported generic functions
(setf offset): Exported generic functions
(setf offset): Exported generic functions
(setf offset): Exported generic functions
(setf r): Internal generic functions
(setf r): Internal generic functions
(setf s): Exported generic functions
(setf s): Exported generic functions
(setf s): Exported generic functions
(setf s): Exported generic functions
(setf unk): Exported generic functions
(setf unk): Exported generic functions

B
basic-update-dag: Exported functions
best-edge: Exported functions
build-dag: Exported functions

C
chunk: Exported generic functions
chunk: Exported generic functions
create-basic-wordcut: Exported functions
create-edges-builder: Exported functions
create-pointers-updater: Exported functions

D
dag-to-list: Exported functions
dict: Exported generic functions
dict: Exported generic functions
dict-seek: Exported functions

E
etype: Exported generic functions
etype: Exported generic functions

F
Function, basic-update-dag: Exported functions
Function, best-edge: Exported functions
Function, build-dag: Exported functions
Function, create-basic-wordcut: Exported functions
Function, create-edges-builder: Exported functions
Function, create-pointers-updater: Exported functions
Function, dag-to-list: Exported functions
Function, dict-seek: Exported functions
Function, is-space: Internal functions
Function, load-dict-from-bundle: Exported functions
Function, proto-dag-to-list: Exported functions
Function, unk-edge: Internal functions
Function, update-dag-dict: Internal functions
Function, update-dag-space: Internal functions
Function, update-dag-unk: Internal functions
Function, update-space-info: Internal functions

G
Generic Function, (setf chunk): Exported generic functions
Generic Function, (setf dict): Exported generic functions
Generic Function, (setf etype): Exported generic functions
Generic Function, (setf is-final): Exported generic functions
Generic Function, (setf l): Exported generic functions
Generic Function, (setf offset): Exported generic functions
Generic Function, (setf r): Internal generic functions
Generic Function, (setf s): Exported generic functions
Generic Function, (setf unk): Exported generic functions
Generic Function, chunk: Exported generic functions
Generic Function, dict: Exported generic functions
Generic Function, etype: Exported generic functions
Generic Function, is-better-than: Exported generic functions
Generic Function, is-final: Exported generic functions
Generic Function, l: Exported generic functions
Generic Function, offset: Exported generic functions
Generic Function, r: Internal generic functions
Generic Function, s: Exported generic functions
Generic Function, unk: Exported generic functions
Generic Function, update: Exported generic functions
Generic Function, update-lookahead: Exported generic functions

I
is-better-than: Exported generic functions
is-better-than: Exported generic functions
is-final: Exported generic functions
is-final: Exported generic functions
is-final: Exported generic functions
is-space: Internal functions

L
l: Exported generic functions
l: Exported generic functions
load-dict-from-bundle: Exported functions

M
Method, (setf chunk): Exported generic functions
Method, (setf dict): Exported generic functions
Method, (setf etype): Exported generic functions
Method, (setf is-final): Exported generic functions
Method, (setf is-final): Exported generic functions
Method, (setf l): Exported generic functions
Method, (setf offset): Exported generic functions
Method, (setf offset): Exported generic functions
Method, (setf r): Internal generic functions
Method, (setf s): Exported generic functions
Method, (setf s): Exported generic functions
Method, (setf s): Exported generic functions
Method, (setf unk): Exported generic functions
Method, chunk: Exported generic functions
Method, dict: Exported generic functions
Method, etype: Exported generic functions
Method, is-better-than: Exported generic functions
Method, is-final: Exported generic functions
Method, is-final: Exported generic functions
Method, l: Exported generic functions
Method, offset: Exported generic functions
Method, offset: Exported generic functions
Method, r: Internal generic functions
Method, s: Exported generic functions
Method, s: Exported generic functions
Method, s: Exported generic functions
Method, unk: Exported generic functions
Method, update: Exported generic functions
Method, update-lookahead: Exported generic functions
Method, update-lookahead: Exported generic functions

O
offset: Exported generic functions
offset: Exported generic functions
offset: Exported generic functions

P
proto-dag-to-list: Exported functions

R
r: Internal generic functions
r: Internal generic functions

S
s: Exported generic functions
s: Exported generic functions
s: Exported generic functions
s: Exported generic functions

U
unk: Exported generic functions
unk: Exported generic functions
unk-edge: Internal functions
update: Exported generic functions
update: Exported generic functions
update-dag-dict: Internal functions
update-dag-space: Internal functions
update-dag-unk: Internal functions
update-lookahead: Exported generic functions
update-lookahead: Exported generic functions
update-lookahead: Exported generic functions
update-space-info: Internal functions

Jump to:   (  
B   C   D   E   F   G   I   L   M   O   P   R   S   U  

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

A.3 Variables

Jump to:   C   D   E   I   L   O   R   S   U  
Index Entry  Section

C
chunk: Exported classes

D
dict: Exported classes

E
etype: Exported classes

I
is-final: Exported classes
is-final: Exported classes

L
l: Exported classes

O
offset: Exported classes
offset: Exported classes

R
r: Exported classes

S
s: Exported classes
s: Exported classes
s: Exported classes
Slot, chunk: Exported classes
Slot, dict: Exported classes
Slot, etype: Exported classes
Slot, is-final: Exported classes
Slot, is-final: Exported classes
Slot, l: Exported classes
Slot, offset: Exported classes
Slot, offset: Exported classes
Slot, r: Exported classes
Slot, s: Exported classes
Slot, s: Exported classes
Slot, s: Exported classes
Slot, unk: Exported classes

U
unk: Exported classes

Jump to:   C   D   E   I   L   O   R   S   U  

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

A.4 Data types

Jump to:   C   D   E   P   S  
Index Entry  Section

C
cl-wordcut: The cl-wordcut system
cl-wordcut: The cl-wordcut package
Class, dict-pointer: Exported classes
Class, edge: Exported classes
Class, space-info: Exported classes

D
dict-pointer: Exported classes

E
edge: Exported classes

P
Package, cl-wordcut: The cl-wordcut package

S
space-info: Exported classes
System, cl-wordcut: The cl-wordcut system

Jump to:   C   D   E   P   S