The cl-wordcut Reference Manual

This is the cl-wordcut Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Aug 15 04:09:34 2022 GMT+0.

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

2 Systems

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

cl-wordcut

2.1 `cl-wordcut`

Word segmentation tools for ASEAN languages written in Common Lisp

Author

Vee Satayamas

License

LLGPL

Dependency

asdf (system).

Source

cl-wordcut.asd.

Child Components

packages.lisp (file).
wordcut.lisp (file).

3 Files

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

Lisp

3.1.1 `cl-wordcut/cl-wordcut.asd`

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

3.1.2 `cl-wordcut/packages.lisp`

Source: cl-wordcut.asd.
Parent Component: cl-wordcut (system).
Packages: cl-wordcut.

3.1.3 `cl-wordcut/wordcut.lisp`

Dependency

packages.lisp (file).

Source

cl-wordcut.asd.

Parent Component

cl-wordcut (system).

Public Interface

basic-update-dag (function).
best-edge (function).
build-dag (function).
chunk (reader method).
(setf chunk) (writer method).
create-basic-wordcut (function).
create-edges-builder (function).
create-pointers-updater (function).
dag-to-list (function).
dict (reader method).
(setf dict) (writer method).
dict-pointer (class).
dict-seek (function).
edge (class).
etype (reader method).
(setf etype) (writer method).
is-better-than (generic function).
is-final (reader method).
is-final (reader method).
(setf is-final) (writer method).
(setf is-final) (writer method).
l (reader method).
(setf l) (writer method).
load-dict-from-bundle (function).
offset (reader method).
offset (reader method).
(setf offset) (writer method).
(setf offset) (writer method).
print-object (method).
print-object (method).
proto-dag-to-list (function).
s (reader method).
s (reader method).
s (reader method).
(setf s) (writer method).
(setf s) (writer method).
(setf s) (writer method).
space-info (class).
unk (reader method).
(setf unk) (writer method).
update (generic function).
update-lookahead (generic function).

Internals

is-space (function).
r (reader method).
(setf r) (writer method).
unk-edge (function).
update-dag-dict (function).
update-dag-space (function).
update-dag-unk (function).
update-space-info (function).

4 Packages

Packages are listed by definition order.

cl-wordcut

4.1 `cl-wordcut`

Source

packages.lisp.

Use List

common-lisp.

Public Interface

basic-update-dag (function).
best-edge (function).
build-dag (function).
chunk (generic reader).
(setf chunk) (generic writer).
create-basic-wordcut (function).
create-edges-builder (function).
create-pointers-updater (function).
dag-to-list (function).
dict (generic reader).
(setf dict) (generic writer).
dict-pointer (class).
dict-seek (function).
edge (class).
etype (generic reader).
(setf etype) (generic writer).
is-better-than (generic function).
is-final (generic reader).
(setf is-final) (generic writer).
l (generic reader).
(setf l) (generic writer).
load-dict-from-bundle (function).
offset (generic reader).
(setf offset) (generic writer).
proto-dag-to-list (function).
s (generic reader).
(setf s) (generic writer).
space-info (class).
unk (generic reader).
(setf unk) (generic writer).
update (generic function).
update-lookahead (generic function).

Internals

is-space (function).
r (generic reader).
(setf r) (generic writer).
unk-edge (function).
update-dag-dict (function).
update-dag-space (function).
update-dag-unk (function).
update-space-info (function).

5 Definitions

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

Public Interface
Internals

5.1 Public Interface

Ordinary functions
Generic functions
Standalone methods
Classes

5.1.1 Ordinary functions

Function: basic-update-dag (dag i left pointers build-edges space-info edge-class) ¶

Package: cl-wordcut.
Source: wordcut.lisp.

Function: best-edge (all-edges) ¶

Package: cl-wordcut.
Source: wordcut.lisp.

Function: build-dag (text build-edges update-pointers update-dag edge-class) ¶

Package: cl-wordcut.
Source: wordcut.lisp.

Function: create-basic-wordcut (dict) ¶

Package: cl-wordcut.
Source: wordcut.lisp.

Function: create-edges-builder (edge-class) ¶

Package: cl-wordcut.
Source: wordcut.lisp.

Function: create-pointers-updater (pointer-class dict) ¶

Package: cl-wordcut.
Source: wordcut.lisp.

Function: dag-to-list (dag text) ¶

Package: cl-wordcut.
Source: wordcut.lisp.

Function: dict-seek (dict policy l r offset ch) ¶

Package: cl-wordcut.
Source: wordcut.lisp.

Function: load-dict-from-bundle (file-name) ¶

Package: cl-wordcut.
Source: wordcut.lisp.

Function: proto-dag-to-list (dag text make-entry) ¶

Package: cl-wordcut.
Source: wordcut.lisp.

5.1.2 Generic functions

Generic Reader: chunk (object) ¶

Package

cl-wordcut.

Methods

Reader Method: chunk ((edge edge)) ¶

automatically generated reader method

Source: wordcut.lisp.
Target Slot: chunk.

Generic Writer: (setf chunk) (object) ¶

Package

cl-wordcut.

Methods

Writer Method: (setf chunk) ((edge edge)) ¶

automatically generated writer method

Source: wordcut.lisp.
Target Slot: chunk.

Generic Reader: dict (object) ¶

Package

cl-wordcut.

Methods

Reader Method: dict ((dict-pointer dict-pointer)) ¶

automatically generated reader method

Source: wordcut.lisp.
Target Slot: dict.

Generic Writer: (setf dict) (object) ¶

Package

cl-wordcut.

Methods

Writer Method: (setf dict) ((dict-pointer dict-pointer)) ¶

automatically generated writer method

Source: wordcut.lisp.
Target Slot: dict.

Generic Reader: etype (object) ¶

Package

cl-wordcut.

Methods

Reader Method: etype ((edge edge)) ¶

automatically generated reader method

Source: wordcut.lisp.
Target Slot: etype.

Generic Writer: (setf etype) (object) ¶

Package

cl-wordcut.

Methods

Writer Method: (setf etype) ((edge edge)) ¶

automatically generated writer method

Source: wordcut.lisp.
Target Slot: etype.

Generic Function: is-better-than (o1 o2) ¶

Package

cl-wordcut.

Source

wordcut.lisp.

Methods

Method: is-better-than ((o1 edge) (o2 edge)) ¶

Generic Reader: is-final (object) ¶

Package

cl-wordcut.

Methods

Reader Method: is-final ((space-info space-info)) ¶

automatically generated reader method

Source: wordcut.lisp.
Target Slot: is-final.

Reader Method: is-final ((dict-pointer dict-pointer)) ¶

automatically generated reader method

Source: wordcut.lisp.
Target Slot: is-final.

Generic Writer: (setf is-final) (object) ¶

Package

cl-wordcut.

Methods

Writer Method: (setf is-final) ((space-info space-info)) ¶

automatically generated writer method

Source: wordcut.lisp.
Target Slot: is-final.

Writer Method: (setf is-final) ((dict-pointer dict-pointer)) ¶

automatically generated writer method

Source: wordcut.lisp.
Target Slot: is-final.

Generic Reader: l (object) ¶

Package

cl-wordcut.

Methods

Reader Method: l ((dict-pointer dict-pointer)) ¶

automatically generated reader method

Source: wordcut.lisp.
Target Slot: l.

Generic Writer: (setf l) (object) ¶

Package

cl-wordcut.

Methods

Writer Method: (setf l) ((dict-pointer dict-pointer)) ¶

automatically generated writer method

Source: wordcut.lisp.
Target Slot: l.

Generic Reader: offset (object) ¶

Package

cl-wordcut.

Methods

Reader Method: offset ((space-info space-info)) ¶

automatically generated reader method

Source: wordcut.lisp.
Target Slot: offset.

Reader Method: offset ((dict-pointer dict-pointer)) ¶

automatically generated reader method

Source: wordcut.lisp.
Target Slot: offset.

Generic Writer: (setf offset) (object) ¶

Package

cl-wordcut.

Methods

Writer Method: (setf offset) ((space-info space-info)) ¶

automatically generated writer method

Source: wordcut.lisp.
Target Slot: offset.

Writer Method: (setf offset) ((dict-pointer dict-pointer)) ¶

automatically generated writer method

Source: wordcut.lisp.
Target Slot: offset.

Generic Reader: s (object) ¶

Package

cl-wordcut.

Methods

Reader Method: s ((space-info space-info)) ¶

automatically generated reader method

Source: wordcut.lisp.
Target Slot: s.

Reader Method: s ((edge edge)) ¶

automatically generated reader method

Source: wordcut.lisp.
Target Slot: s.

Reader Method: s ((dict-pointer dict-pointer)) ¶

automatically generated reader method

Source: wordcut.lisp.
Target Slot: s.

Generic Writer: (setf s) (object) ¶

Package

cl-wordcut.

Methods

Writer Method: (setf s) ((space-info space-info)) ¶

automatically generated writer method

Source: wordcut.lisp.
Target Slot: s.

Writer Method: (setf s) ((edge edge)) ¶

automatically generated writer method

Source: wordcut.lisp.
Target Slot: s.

Writer Method: (setf s) ((dict-pointer dict-pointer)) ¶

automatically generated writer method

Source: wordcut.lisp.
Target Slot: s.

Generic Reader: unk (object) ¶

Package

cl-wordcut.

Methods

Reader Method: unk ((edge edge)) ¶

automatically generated reader method

Source: wordcut.lisp.
Target Slot: unk.

Generic Writer: (setf unk) (object) ¶

Package

cl-wordcut.

Methods

Writer Method: (setf unk) ((edge edge)) ¶

automatically generated writer method

Source: wordcut.lisp.
Target Slot: unk.

Generic Function: update (pointer ch) ¶

Package

cl-wordcut.

Source

wordcut.lisp.

Methods

Method: update ((pointer dict-pointer) (ch character)) ¶

Generic Function: update-lookahead (info ch next-ch) ¶

Package

cl-wordcut.

Source

wordcut.lisp.

Methods

Method: update-lookahead ((info space-info) (ch character) (next-ch null)) ¶

Method: update-lookahead ((info space-info) (ch character) (next-ch character)) ¶

5.1.3 Standalone methods

Method: print-object ((self edge) str) ¶

Source: wordcut.lisp.

Method: print-object ((self dict-pointer) str) ¶

Source: wordcut.lisp.

5.1.4 Classes

Class: dict-pointer ¶

Package

cl-wordcut.

Source

wordcut.lisp.

Direct methods

(setf dict).
dict.
(setf is-final).
is-final.
(setf l).
l.
(setf offset).
offset.
print-object.
(setf r).
r.
(setf s).
s.
update.

Direct slots

Slot: s ¶

Initform: 0
Initargs: :s
Readers: s.
Writers: (setf s).

Slot: l ¶

Initform: 0
Initargs: :l
Readers: l.
Writers: (setf l).

Slot: r ¶

Initform: 0
Initargs: :r
Readers: r.
Writers: (setf r).

Slot: offset ¶

Initform: 0
Initargs: :offset
Readers: offset.
Writers: (setf offset).

Slot: is-final ¶

Initargs: :is-final
Readers: is-final.
Writers: (setf is-final).

Slot: dict ¶

Initargs: :dict
Readers: dict.
Writers: (setf dict).

Class: edge ¶

Package

cl-wordcut.

Source

wordcut.lisp.

Direct methods

(setf chunk).
chunk.
(setf etype).
etype.
is-better-than.
print-object.
(setf s).
s.
(setf unk).
unk.

Direct slots

Slot: s ¶

Initform: 0
Initargs: :s
Readers: s.
Writers: (setf s).

Slot: unk ¶

Initform: 0
Initargs: :unk
Readers: unk.
Writers: (setf unk).

Slot: chunk ¶

Initform: 0
Initargs: :chunk
Readers: chunk.
Writers: (setf chunk).

Slot: etype ¶

Initform: :init
Initargs: :etype
Readers: etype.
Writers: (setf etype).

Class: space-info ¶

Package

cl-wordcut.

Source

wordcut.lisp.

Direct methods

(setf is-final).
is-final.
(setf offset).
offset.
(setf s).
s.
update-lookahead.
update-lookahead.

Direct slots

Slot: s ¶

Initform: 0
Initargs: :s
Readers: s.
Writers: (setf s).

Slot: offset ¶

Initform: 0
Initargs: :offset
Readers: offset.
Writers: (setf offset).

Slot: is-final ¶

Initargs: :is-final
Readers: is-final.
Writers: (setf is-final).

5.2 Internals

Ordinary functions
Generic functions

5.2.1 Ordinary functions

Function: is-space (ch) ¶

Package: cl-wordcut.
Source: wordcut.lisp.

Function: unk-edge (dag left edge-class) ¶

Package: cl-wordcut.
Source: wordcut.lisp.

Function: update-dag-dict (dag i final-pointers build-edges) ¶

Package: cl-wordcut.
Source: wordcut.lisp.

Function: update-dag-space (dag i space-info edge-class) ¶

Package: cl-wordcut.
Source: wordcut.lisp.

Function: update-dag-unk (dag i left edge-class) ¶

Package: cl-wordcut.
Source: wordcut.lisp.

Function: update-space-info (info current-is-space next-is-space) ¶

Package: cl-wordcut.
Source: wordcut.lisp.

5.2.2 Generic functions

Generic Reader: r (object) ¶

Package

cl-wordcut.

Methods

Reader Method: r ((dict-pointer dict-pointer)) ¶

automatically generated reader method

Source: wordcut.lisp.
Target Slot: r.

Generic Writer: (setf r) (object) ¶

Package

cl-wordcut.

Methods

Writer Method: (setf r) ((dict-pointer dict-pointer)) ¶

automatically generated writer method

Source: wordcut.lisp.
Target Slot: r.

Appendix A Indexes

Concepts
Functions
Variables
Data types

A.1 Concepts

A.2 Functions

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

	Index Entry	Section

(
	`(setf chunk)`:	Public generic functions
	`(setf chunk)`:	Public generic functions
	`(setf dict)`:	Public generic functions
	`(setf dict)`:	Public generic functions
	`(setf etype)`:	Public generic functions
	`(setf etype)`:	Public generic functions
	`(setf is-final)`:	Public generic functions
	`(setf is-final)`:	Public generic functions
	`(setf is-final)`:	Public generic functions
	`(setf l)`:	Public generic functions
	`(setf l)`:	Public generic functions
	`(setf offset)`:	Public generic functions
	`(setf offset)`:	Public generic functions
	`(setf offset)`:	Public generic functions
	`(setf r)`:	Private generic functions
	`(setf r)`:	Private generic functions
	`(setf s)`:	Public generic functions
	`(setf s)`:	Public generic functions
	`(setf s)`:	Public generic functions
	`(setf s)`:	Public generic functions
	`(setf unk)`:	Public generic functions
	`(setf unk)`:	Public generic functions

B
	`basic-update-dag`:	Public ordinary functions
	`best-edge`:	Public ordinary functions
	`build-dag`:	Public ordinary functions

C
	`chunk`:	Public generic functions
	`chunk`:	Public generic functions
	`create-basic-wordcut`:	Public ordinary functions
	`create-edges-builder`:	Public ordinary functions
	`create-pointers-updater`:	Public ordinary functions

D
	`dag-to-list`:	Public ordinary functions
	`dict`:	Public generic functions
	`dict`:	Public generic functions
	`dict-seek`:	Public ordinary functions

E
	`etype`:	Public generic functions
	`etype`:	Public generic functions

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

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

I
	`is-better-than`:	Public generic functions
	`is-better-than`:	Public generic functions
	`is-final`:	Public generic functions
	`is-final`:	Public generic functions
	`is-final`:	Public generic functions
	`is-space`:	Private ordinary functions

L
	`l`:	Public generic functions
	`l`:	Public generic functions
	`load-dict-from-bundle`:	Public ordinary functions

M
	`Method, (setf chunk)`:	Public generic functions
	`Method, (setf dict)`:	Public generic functions
	`Method, (setf etype)`:	Public generic functions
	`Method, (setf is-final)`:	Public generic functions
	`Method, (setf is-final)`:	Public generic functions
	`Method, (setf l)`:	Public generic functions
	`Method, (setf offset)`:	Public generic functions
	`Method, (setf offset)`:	Public generic functions
	`Method, (setf r)`:	Private generic functions
	`Method, (setf s)`:	Public generic functions
	`Method, (setf s)`:	Public generic functions
	`Method, (setf s)`:	Public generic functions
	`Method, (setf unk)`:	Public generic functions
	`Method, chunk`:	Public generic functions
	`Method, dict`:	Public generic functions
	`Method, etype`:	Public generic functions
	`Method, is-better-than`:	Public generic functions
	`Method, is-final`:	Public generic functions
	`Method, is-final`:	Public generic functions
	`Method, l`:	Public generic functions
	`Method, offset`:	Public generic functions
	`Method, offset`:	Public generic functions
	`Method, print-object`:	Public standalone methods
	`Method, print-object`:	Public standalone methods
	`Method, r`:	Private generic functions
	`Method, s`:	Public generic functions
	`Method, s`:	Public generic functions
	`Method, s`:	Public generic functions
	`Method, unk`:	Public generic functions
	`Method, update`:	Public generic functions
	`Method, update-lookahead`:	Public generic functions
	`Method, update-lookahead`:	Public generic functions

O
	`offset`:	Public generic functions
	`offset`:	Public generic functions
	`offset`:	Public generic functions

P
	`print-object`:	Public standalone methods
	`print-object`:	Public standalone methods
	`proto-dag-to-list`:	Public ordinary functions

R
	`r`:	Private generic functions
	`r`:	Private generic functions

S
	`s`:	Public generic functions
	`s`:	Public generic functions
	`s`:	Public generic functions
	`s`:	Public generic functions

U
	`unk`:	Public generic functions
	`unk`:	Public generic functions
	`unk-edge`:	Private ordinary functions
	`update`:	Public generic functions
	`update`:	Public generic functions
	`update-dag-dict`:	Private ordinary functions
	`update-dag-space`:	Private ordinary functions
	`update-dag-unk`:	Private ordinary functions
	`update-lookahead`:	Public generic functions
	`update-lookahead`:	Public generic functions
	`update-lookahead`:	Public generic functions
	`update-space-info`:	Private ordinary functions

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

A.3 Variables

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

	Index Entry	Section

C
	`chunk`:	Public classes

D
	`dict`:	Public classes

E
	`etype`:	Public classes

I
	`is-final`:	Public classes
	`is-final`:	Public classes

L
	`l`:	Public classes

O
	`offset`:	Public classes
	`offset`:	Public classes

R
	`r`:	Public classes

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

U
	`unk`:	Public classes

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

A.4 Data types

Jump to:	C D E F P S W

	Index Entry	Section

C
	`cl-wordcut`:	The cl-wordcut system
	`cl-wordcut`:	The cl-wordcut package
	`cl-wordcut.asd`:	The cl-wordcut/cl-wordcut․asd file
	`Class, dict-pointer`:	Public classes
	`Class, edge`:	Public classes
	`Class, space-info`:	Public classes

D
	`dict-pointer`:	Public classes

E
	`edge`:	Public classes

F
	`File, cl-wordcut.asd`:	The cl-wordcut/cl-wordcut․asd file
	`File, packages.lisp`:	The cl-wordcut/packages․lisp file
	`File, wordcut.lisp`:	The cl-wordcut/wordcut․lisp file

P
	`Package, cl-wordcut`:	The cl-wordcut package
	`packages.lisp`:	The cl-wordcut/packages․lisp file

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

W
	`wordcut.lisp`:	The cl-wordcut/wordcut․lisp file

Jump to:	C D E F P S W

The cl-wordcut Reference Manual

The cl-wordcut Reference Manual

Table of Contents

1 Introduction

cl-wordcut

Example

Khmer (Cambodian)

Lao

Thai

2 Systems

2.1 cl-wordcut

3 Files

3.1 Lisp

3.1.1 cl-wordcut/cl-wordcut.asd

3.1.2 cl-wordcut/packages.lisp

3.1.3 cl-wordcut/wordcut.lisp

4 Packages

4.1 cl-wordcut

5 Definitions

5.1 Public Interface

5.1.1 Ordinary functions

5.1.2 Generic functions

5.1.3 Standalone methods

5.1.4 Classes

5.2 Internals

5.2.1 Ordinary functions

5.2.2 Generic functions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `cl-wordcut`

3.1.1 `cl-wordcut/cl-wordcut.asd`

3.1.2 `cl-wordcut/packages.lisp`

3.1.3 `cl-wordcut/wordcut.lisp`

4.1 `cl-wordcut`