The cl-wordcut Reference Manual

Table of Contents

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.

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.

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

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

3 Files

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

3.1 Lisp

3.1.1 cl-wordcut.asd

Location

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

Systems

cl-wordcut (system)

3.1.2 cl-wordcut/packages.lisp

Parent

cl-wordcut (system)

Location

packages.lisp

Packages

cl-wordcut

3.1.3 cl-wordcut/wordcut.lisp

Dependency

packages.lisp (file)

Parent

cl-wordcut (system)

Location

wordcut.lisp

Exported Definitions

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

Internal Definitions

• is-space (function)
• r (method)
• (setf r) (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.

4.1 cl-wordcut

Source

packages.lisp (file)

Use List

common-lisp

Exported Definitions

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

Internal Definitions

• is-space (function)
• r (generic function)
• r (method)
• (setf r) (method)
• (setf r) (generic function)
• 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.

5.1 Exported definitions

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)

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)

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

• update-lookahead (method)
• update-lookahead (method)
• is-final (method)
• is-final (method)
• offset (method)
• offset (method)
• s (method)
• s (method)

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)

5.2 Internal definitions

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)

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)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types