The cl-mecab Reference Manual

Table of Contents

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

The cl-mecab Reference Manual

This is the cl-mecab Reference Manual, version 0.1, generated automatically by Declt version 2.4 patchlevel 1 "Will Decker" on Fri May 24 08:15:48 2019 GMT+0.


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

1 Introduction

cl-mecab

Usage

(ql:quickload :cl-mecab)

(cl-mecab:with-mecab ()
  (cl-mecab:parse* "今日の天気は晴れです"))
;; =>
;; (("今日" "名詞" "副詞可能" "*" "*" "*" "*" "今日" "キョウ" "キョー")
;;  ("の" "助詞" "連体化" "*" "*" "*" "*" "の" "ノ" "ノ")
;;  ("天気" "名詞" "一般" "*" "*" "*" "*" "天気" "テンキ" "テンキ")
;;  ("は" "助詞" "係助詞" "*" "*" "*" "*" "は" "ハ" "ワ")
;;  ("晴れ" "名詞" "一般" "*" "*" "*" "*" "晴れ" "ハレ" "ハレ")
;;  ("です" "助動詞" "*" "*" "*" "特殊・デス" "基本形" "です" "デス" "デス"))

Installation

Assuming you already installed MeCab.

(ql:quickload :cl-mecab)

APIs

(with-mecab (&optional (option "")) &body body)

This macro makes MeCab Tagger and enables function parse within the body. The MeCab Tagger will be made only once while that execution. The option is taken MeCab Tagger initialization.

(with-mecab* (&optional (option "")) &body body)

This macro similar to with-mecab. but, this creates MeCab Tagger each call.

(load-tagger &optional (option ""))

This function makes MeCab Tagger on global. You can use function parse after calling the load-tagger only once. This is useful for experimental implementations.

(parse text)

This function parses the text by MeCab Tagger and returns result as a string.

(parse* text)

This function parses the text by MeCab Tagger and returns result as list seems above example


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

Author

carrotflakes

License

LLGPL

Description

Interface of MeCab that is a morpheme analyzer

Long Description

# cl-mecab

## Usage

“‘lisp
(ql:quickload :cl-mecab)

(cl-mecab:with-mecab ()
(cl-mecab:parse* "今日の天気は晴れです"))
;; =>
;; (("今日" "名詞" "副詞可能" "*" "*" "*" "*" "今日" "キョウ" "キョー")
;; ("の" "助詞" "連体化" "*" "*" "*" "*" "の" "ノ" "ノ")
;; ("天気" "名詞" "一般" "*" "*" "*" "*" "天気" "テンキ" "テンキ")
;; ("は" "助詞" "係助詞" "*" "*" "*" "*" "は" "ハ" "ワ")
;; ("晴れ" "名詞" "一般" "*" "*" "*" "*" "晴れ" "ハレ" "ハレ")
;; ("です" "助動詞" "*" "*" "*" "特殊・デス" "基本形" "です" "デス" "デス"))
“‘

## Installation

Assuming you already installed [MeCab](http://taku910.github.io/mecab/).

“‘ lisp
(ql:quickload :cl-mecab)
“‘

## APIs
### ‘(with-mecab (&optional (option "")) &body body)‘
This macro makes MeCab Tagger and enables function ‘parse‘ within the ‘body‘.
The MeCab Tagger will be made only once while that execution.
The ‘option‘ is taken MeCab Tagger initialization.

### ‘(with-mecab* (&optional (option "")) &body body)‘
This macro similar to ‘with-mecab‘. but, this creates MeCab Tagger each call.

### ‘(load-tagger &optional (option ""))‘
This function makes MeCab Tagger on global.
You can use function ‘parse‘ after calling the ‘load-tagger‘ only once.
This is useful for experimental implementations.

### ‘(parse text)‘
This function parses the text by MeCab Tagger and returns result as a string.

### ‘(parse* text)‘
This function parses the text by MeCab Tagger and returns result as list seems above example.

## Author

* carrotflakes (carrotflakes@gmail.com)

## Copyright

Copyright (c) 2016-2018 carrotflakes (carrotflakes@gmail.com)

## License

Licensed under the LLGPL License.

Version

0.1

Dependencies
Source

cl-mecab.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-mecab/src

Parent

cl-mecab (system)

Location

src/

Component

cl-mecab.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-mecab.asd

Location

cl-mecab.asd

Systems

cl-mecab (system)

Packages

cl-mecab-asd


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

4.1.2 cl-mecab/src/cl-mecab.lisp

Parent

src (module)

Location

src/cl-mecab.lisp

Packages

cl-mecab

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-mecab-asd

Source

cl-mecab.asd

Use List

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

5.2 cl-mecab

Source

cl-mecab.lisp (file)

Use List

common-lisp

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 Macros

Macro: with-mecab (&optional OPTION) &body BODY
Package

cl-mecab

Source

cl-mecab.lisp (file)

Macro: with-mecab* (&optional OPTION) &body BODY
Package

cl-mecab

Source

cl-mecab.lisp (file)


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

6.1.2 Functions

Function: load-tagger &optional OPTION
Package

cl-mecab

Source

cl-mecab.lisp (file)

Function: make-mecab &optional OPTION
Package

cl-mecab

Source

cl-mecab.lisp (file)

Function: parse TEXT &optional *MECAB*
Package

cl-mecab

Source

cl-mecab.lisp (file)

Function: parse* TEXT &optional *MECAB*
Package

cl-mecab

Source

cl-mecab.lisp (file)


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

6.2 Internal definitions


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

6.2.1 Special variables

Special Variable: *mecab*
Package

cl-mecab

Source

cl-mecab.lisp (file)


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

6.2.2 Functions

Function: %mecab_destroy% MECAB
Package

cl-mecab

Source

cl-mecab.lisp (file)

Function: %mecab_new2% ARG
Package

cl-mecab

Source

cl-mecab.lisp (file)

Function: %mecab_sparse_tostr% MECAB STR
Package

cl-mecab

Source

cl-mecab.lisp (file)


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-mecab.asd: The cl-mecab<dot>asd file
cl-mecab/src: The cl-mecab/src module
cl-mecab/src/cl-mecab.lisp: The cl-mecab/src/cl-mecab<dot>lisp file

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

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

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

Jump to:   C   F   L   M  

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

A.2 Functions

Jump to:   %  
F   L   M   P   W  
Index Entry  Section

%
%mecab_destroy%: Internal functions
%mecab_new2%: Internal functions
%mecab_sparse_tostr%: Internal functions

F
Function, %mecab_destroy%: Internal functions
Function, %mecab_new2%: Internal functions
Function, %mecab_sparse_tostr%: Internal functions
Function, load-tagger: Exported functions
Function, make-mecab: Exported functions
Function, parse: Exported functions
Function, parse*: Exported functions

L
load-tagger: Exported functions

M
Macro, with-mecab: Exported macros
Macro, with-mecab*: Exported macros
make-mecab: Exported functions

P
parse: Exported functions
parse*: Exported functions

W
with-mecab: Exported macros
with-mecab*: Exported macros

Jump to:   %  
F   L   M   P   W  

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

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*mecab*: Internal special variables

S
Special Variable, *mecab*: Internal special variables

Jump to:   *  
S  

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

A.4 Data types

Jump to:   C   P   S  
Index Entry  Section

C
cl-mecab: The cl-mecab system
cl-mecab: The cl-mecab package
cl-mecab-asd: The cl-mecab-asd package

P
Package, cl-mecab: The cl-mecab package
Package, cl-mecab-asd: The cl-mecab-asd package

S
System, cl-mecab: The cl-mecab system

Jump to:   C   P   S