Debian Codegraph @

doc/doxygen/classMeCab_1_1Model.html

raw
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 <title>MeCab: MeCab::Model Class Reference</title>
7
8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
9 <link href="doxygen.css" rel="stylesheet" type="text/css" />
10
11
12
13 </head>
14 <body>
15 <div id="top"><!-- do not remove this div! -->
16
17
18 <div id="titlearea">
19 <table cellspacing="0" cellpadding="0">
20 <tbody>
21 <tr style="height: 56px;">
22
23
24 <td style="padding-left: 0.5em;">
25 <div id="projectname">MeCab
26
27 </div>
28
29 </td>
30
31
32
33 </tr>
34 </tbody>
35 </table>
36 </div>
37
38 <!-- Generated by Doxygen 1.7.6.1 -->
39 <div id="navrow1" class="tabs">
40 <ul class="tablist">
41 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
42 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
43 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
44 <li><a href="files.html"><span>Files</span></a></li>
45 </ul>
46 </div>
47 <div id="navrow2" class="tabs2">
48 <ul class="tablist">
49 <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
50 <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
51 </ul>
52 </div>
53 <div id="nav-path" class="navpath">
54 <ul>
55 <li class="navelem"><a class="el" href="namespaceMeCab.html">MeCab</a> </li>
56 <li class="navelem"><a class="el" href="classMeCab_1_1Model.html">Model</a> </li>
57 </ul>
58 </div>
59 </div>
60 <div class="header">
61 <div class="summary">
62 <a href="#pub-methods">Public Member Functions</a> &#124;
63 <a href="#pub-static-methods">Static Public Member Functions</a> </div>
64 <div class="headertitle">
65 <div class="title">MeCab::Model Class Reference</div> </div>
66 </div><!--header-->
67 <div class="contents">
68 <!-- doxytag: class="MeCab::Model" -->
69 <p><a class="el" href="classMeCab_1_1Model.html" title="Model class.">Model</a> class.
70 <a href="classMeCab_1_1Model.html#details">More...</a></p>
71
72 <p><code>#include &lt;<a class="el" href="mecab_8h_source.html">mecab.h</a>&gt;</code></p>
73
74 <p><a href="classMeCab_1_1Model-members.html">List of all members.</a></p>
75 <table class="memberdecls">
76 <tr><td colspan="2"><h2><a name="pub-methods"></a>
77 Public Member Functions</h2></td></tr>
78 <tr><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="namespaceMeCab.html#a581b6e7f533add983ea9dabc4a44166b">DictionaryInfo</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMeCab_1_1Model.html#a04a93b36403d155f4cedfb138a7b2b51">dictionary_info</a> () const =0</td></tr>
79 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Return DictionaryInfo linked list. <a href="#a04a93b36403d155f4cedfb138a7b2b51"></a><br/></td></tr>
80 <tr><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMeCab_1_1Model.html#ad89d4de4fa9da5e9ac7045e72f2fbb1e">transition_cost</a> (unsigned short rcAttr, unsigned short lcAttr) const =0</td></tr>
81 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Return transtion cost from rcAttr to lcAttr. <a href="#ad89d4de4fa9da5e9ac7045e72f2fbb1e"></a><br/></td></tr>
82 <tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceMeCab.html#a3679371b5a373ad35e86a545b5f0d127">Node</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMeCab_1_1Model.html#aceb584e540634045adf0172e5fbc59a7">lookup</a> (const char *begin, const char *end, <a class="el" href="classMeCab_1_1Lattice.html">Lattice</a> *lattice) const =0</td></tr>
83 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">perform common prefix search from the range [begin, end). <a href="#aceb584e540634045adf0172e5fbc59a7"></a><br/></td></tr>
84 <tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classMeCab_1_1Tagger.html">Tagger</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMeCab_1_1Model.html#a9d9135a4431adb3a985153cb4ab8f3a1">createTagger</a> () const =0</td></tr>
85 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new <a class="el" href="classMeCab_1_1Tagger.html" title="Tagger class.">Tagger</a> object. <a href="#a9d9135a4431adb3a985153cb4ab8f3a1"></a><br/></td></tr>
86 <tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classMeCab_1_1Lattice.html">Lattice</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMeCab_1_1Model.html#aa70febf1573213287214a1fa626e186d">createLattice</a> () const =0</td></tr>
87 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new <a class="el" href="classMeCab_1_1Lattice.html" title="Lattice class.">Lattice</a> object. <a href="#aa70febf1573213287214a1fa626e186d"></a><br/></td></tr>
88 <tr><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMeCab_1_1Model.html#a0423e56cbbec00e974b75bd1dfed3642">swap</a> (<a class="el" href="classMeCab_1_1Model.html">Model</a> *model)=0</td></tr>
89 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Swap the instance with |model|. <a href="#a0423e56cbbec00e974b75bd1dfed3642"></a><br/></td></tr>
90 <tr><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMeCab_1_1Model.html#abccfe166fbb9db7ab5fe8479657dd63c">~Model</a> ()</td></tr>
91 <tr><td colspan="2"><h2><a name="pub-static-methods"></a>
92 Static Public Member Functions</h2></td></tr>
93 <tr><td class="memItemLeft" align="right" valign="top">static const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMeCab_1_1Model.html#af6d63f8eb887b8b147bdb87a34b06bee">version</a> ()</td></tr>
94 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a version string. <a href="#af6d63f8eb887b8b147bdb87a34b06bee"></a><br/></td></tr>
95 <tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classMeCab_1_1Model.html">Model</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMeCab_1_1Model.html#a90cf2948b06f72de9e07383363fe5d90">create</a> (int argc, char **argv)</td></tr>
96 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Factory method to create a new <a class="el" href="classMeCab_1_1Model.html" title="Model class.">Model</a> with a specified main's argc/argv-style parameters. <a href="#a90cf2948b06f72de9e07383363fe5d90"></a><br/></td></tr>
97 <tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classMeCab_1_1Model.html">Model</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMeCab_1_1Model.html#ac17ea89f12a392ca5d1d1bfcf7a89584">create</a> (const char *arg)</td></tr>
98 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Factory method to create a new <a class="el" href="classMeCab_1_1Model.html" title="Model class.">Model</a> with a string parameter representation, i.e., "-d /user/local/mecab/dic/ipadic -Ochasen". <a href="#ac17ea89f12a392ca5d1d1bfcf7a89584"></a><br/></td></tr>
99 </table>
100 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
101 <div class="textblock"><p><a class="el" href="classMeCab_1_1Model.html" title="Model class.">Model</a> class. </p>
102 </div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
103 <a class="anchor" id="abccfe166fbb9db7ab5fe8479657dd63c"></a><!-- doxytag: member="MeCab::Model::~Model" ref="abccfe166fbb9db7ab5fe8479657dd63c" args="()" -->
104 <div class="memitem">
105 <div class="memproto">
106 <table class="memname">
107 <tr>
108 <td class="memname">virtual <a class="el" href="classMeCab_1_1Model.html#abccfe166fbb9db7ab5fe8479657dd63c">MeCab::Model::~Model</a> </td>
109 <td>(</td>
110 <td class="paramname"></td><td>)</td>
111 <td><code> [inline, virtual]</code></td>
112 </tr>
113 </table>
114 </div>
115 <div class="memdoc">
116
117 </div>
118 </div>
119 <hr/><h2>Member Function Documentation</h2>
120 <a class="anchor" id="a90cf2948b06f72de9e07383363fe5d90"></a><!-- doxytag: member="MeCab::Model::create" ref="a90cf2948b06f72de9e07383363fe5d90" args="(int argc, char **argv)" -->
121 <div class="memitem">
122 <div class="memproto">
123 <table class="memname">
124 <tr>
125 <td class="memname">static <a class="el" href="classMeCab_1_1Model.html">Model</a>* <a class="el" href="classMeCab_1_1Model.html#a90cf2948b06f72de9e07383363fe5d90">MeCab::Model::create</a> </td>
126 <td>(</td>
127 <td class="paramtype">int&#160;</td>
128 <td class="paramname"><em>argc</em>, </td>
129 </tr>
130 <tr>
131 <td class="paramkey"></td>
132 <td></td>
133 <td class="paramtype">char **&#160;</td>
134 <td class="paramname"><em>argv</em>&#160;</td>
135 </tr>
136 <tr>
137 <td></td>
138 <td>)</td>
139 <td></td><td><code> [static]</code></td>
140 </tr>
141 </table>
142 </div>
143 <div class="memdoc">
144
145 <p>Factory method to create a new <a class="el" href="classMeCab_1_1Model.html" title="Model class.">Model</a> with a specified main's argc/argv-style parameters. </p>
146 <p>Return NULL if new model cannot be initialized. Use <a class="el" href="namespaceMeCab.html#af6b513c7789770d47bdf64f9b86f8445" title="Return last error string.">MeCab::getLastError()</a> to obtain the cause of the errors. </p>
147 <dl class="return"><dt><b>Returns:</b></dt><dd>new <a class="el" href="classMeCab_1_1Model.html" title="Model class.">Model</a> object </dd></dl>
148 <dl class="params"><dt><b>Parameters:</b></dt><dd>
149 <table class="params">
150 <tr><td class="paramname">argc</td><td>number of parameters </td></tr>
151 <tr><td class="paramname">argv</td><td>parameter list </td></tr>
152 </table>
153 </dd>
154 </dl>
155
156 </div>
157 </div>
158 <a class="anchor" id="ac17ea89f12a392ca5d1d1bfcf7a89584"></a><!-- doxytag: member="MeCab::Model::create" ref="ac17ea89f12a392ca5d1d1bfcf7a89584" args="(const char *arg)" -->
159 <div class="memitem">
160 <div class="memproto">
161 <table class="memname">
162 <tr>
163 <td class="memname">static <a class="el" href="classMeCab_1_1Model.html">Model</a>* <a class="el" href="classMeCab_1_1Model.html#a90cf2948b06f72de9e07383363fe5d90">MeCab::Model::create</a> </td>
164 <td>(</td>
165 <td class="paramtype">const char *&#160;</td>
166 <td class="paramname"><em>arg</em></td><td>)</td>
167 <td><code> [static]</code></td>
168 </tr>
169 </table>
170 </div>
171 <div class="memdoc">
172
173 <p>Factory method to create a new <a class="el" href="classMeCab_1_1Model.html" title="Model class.">Model</a> with a string parameter representation, i.e., "-d /user/local/mecab/dic/ipadic -Ochasen". </p>
174 <p>Return NULL if new model cannot be initialized. Use <a class="el" href="namespaceMeCab.html#af6b513c7789770d47bdf64f9b86f8445" title="Return last error string.">MeCab::getLastError()</a> to obtain the cause of the errors. </p>
175 <dl class="return"><dt><b>Returns:</b></dt><dd>new <a class="el" href="classMeCab_1_1Model.html" title="Model class.">Model</a> object </dd></dl>
176 <dl class="params"><dt><b>Parameters:</b></dt><dd>
177 <table class="params">
178 <tr><td class="paramname">arg</td><td>single string representation of the argment. </td></tr>
179 </table>
180 </dd>
181 </dl>
182
183 </div>
184 </div>
185 <a class="anchor" id="aa70febf1573213287214a1fa626e186d"></a><!-- doxytag: member="MeCab::Model::createLattice" ref="aa70febf1573213287214a1fa626e186d" args="() const =0" -->
186 <div class="memitem">
187 <div class="memproto">
188 <table class="memname">
189 <tr>
190 <td class="memname">virtual <a class="el" href="classMeCab_1_1Lattice.html">Lattice</a>* <a class="el" href="classMeCab_1_1Model.html#aa70febf1573213287214a1fa626e186d">MeCab::Model::createLattice</a> </td>
191 <td>(</td>
192 <td class="paramname"></td><td>)</td>
193 <td> const<code> [pure virtual]</code></td>
194 </tr>
195 </table>
196 </div>
197 <div class="memdoc">
198
199 <p>Create a new <a class="el" href="classMeCab_1_1Lattice.html" title="Lattice class.">Lattice</a> object. </p>
200 <dl class="return"><dt><b>Returns:</b></dt><dd>new <a class="el" href="classMeCab_1_1Lattice.html" title="Lattice class.">Lattice</a> object </dd></dl>
201
202 </div>
203 </div>
204 <a class="anchor" id="a9d9135a4431adb3a985153cb4ab8f3a1"></a><!-- doxytag: member="MeCab::Model::createTagger" ref="a9d9135a4431adb3a985153cb4ab8f3a1" args="() const =0" -->
205 <div class="memitem">
206 <div class="memproto">
207 <table class="memname">
208 <tr>
209 <td class="memname">virtual <a class="el" href="classMeCab_1_1Tagger.html">Tagger</a>* <a class="el" href="classMeCab_1_1Model.html#a9d9135a4431adb3a985153cb4ab8f3a1">MeCab::Model::createTagger</a> </td>
210 <td>(</td>
211 <td class="paramname"></td><td>)</td>
212 <td> const<code> [pure virtual]</code></td>
213 </tr>
214 </table>
215 </div>
216 <div class="memdoc">
217
218 <p>Create a new <a class="el" href="classMeCab_1_1Tagger.html" title="Tagger class.">Tagger</a> object. </p>
219 <p>All returned tagger object shares this model object as a parsing model. Never delete this model object before deleting tagger object. </p>
220 <dl class="return"><dt><b>Returns:</b></dt><dd>new <a class="el" href="classMeCab_1_1Tagger.html" title="Tagger class.">Tagger</a> object </dd></dl>
221
222 </div>
223 </div>
224 <a class="anchor" id="a04a93b36403d155f4cedfb138a7b2b51"></a><!-- doxytag: member="MeCab::Model::dictionary_info" ref="a04a93b36403d155f4cedfb138a7b2b51" args="() const =0" -->
225 <div class="memitem">
226 <div class="memproto">
227 <table class="memname">
228 <tr>
229 <td class="memname">virtual const <a class="el" href="namespaceMeCab.html#a581b6e7f533add983ea9dabc4a44166b">DictionaryInfo</a>* <a class="el" href="classMeCab_1_1Model.html#a04a93b36403d155f4cedfb138a7b2b51">MeCab::Model::dictionary_info</a> </td>
230 <td>(</td>
231 <td class="paramname"></td><td>)</td>
232 <td> const<code> [pure virtual]</code></td>
233 </tr>
234 </table>
235 </div>
236 <div class="memdoc">
237
238 <p>Return DictionaryInfo linked list. </p>
239 <dl class="return"><dt><b>Returns:</b></dt><dd>DictionaryInfo linked list </dd></dl>
240
241 </div>
242 </div>
243 <a class="anchor" id="aceb584e540634045adf0172e5fbc59a7"></a><!-- doxytag: member="MeCab::Model::lookup" ref="aceb584e540634045adf0172e5fbc59a7" args="(const char *begin, const char *end, Lattice *lattice) const =0" -->
244 <div class="memitem">
245 <div class="memproto">
246 <table class="memname">
247 <tr>
248 <td class="memname">virtual <a class="el" href="namespaceMeCab.html#a3679371b5a373ad35e86a545b5f0d127">Node</a>* <a class="el" href="classMeCab_1_1Model.html#aceb584e540634045adf0172e5fbc59a7">MeCab::Model::lookup</a> </td>
249 <td>(</td>
250 <td class="paramtype">const char *&#160;</td>
251 <td class="paramname"><em>begin</em>, </td>
252 </tr>
253 <tr>
254 <td class="paramkey"></td>
255 <td></td>
256 <td class="paramtype">const char *&#160;</td>
257 <td class="paramname"><em>end</em>, </td>
258 </tr>
259 <tr>
260 <td class="paramkey"></td>
261 <td></td>
262 <td class="paramtype"><a class="el" href="classMeCab_1_1Lattice.html">Lattice</a> *&#160;</td>
263 <td class="paramname"><em>lattice</em>&#160;</td>
264 </tr>
265 <tr>
266 <td></td>
267 <td>)</td>
268 <td></td><td> const<code> [pure virtual]</code></td>
269 </tr>
270 </table>
271 </div>
272 <div class="memdoc">
273
274 <p>perform common prefix search from the range [begin, end). </p>
275 <p>|lattice| takes the ownership of return value. </p>
276 <dl class="return"><dt><b>Returns:</b></dt><dd>node linked list. </dd></dl>
277
278 </div>
279 </div>
280 <a class="anchor" id="a0423e56cbbec00e974b75bd1dfed3642"></a><!-- doxytag: member="MeCab::Model::swap" ref="a0423e56cbbec00e974b75bd1dfed3642" args="(Model *model)=0" -->
281 <div class="memitem">
282 <div class="memproto">
283 <table class="memname">
284 <tr>
285 <td class="memname">virtual bool <a class="el" href="classMeCab_1_1Model.html#a0423e56cbbec00e974b75bd1dfed3642">MeCab::Model::swap</a> </td>
286 <td>(</td>
287 <td class="paramtype"><a class="el" href="classMeCab_1_1Model.html">Model</a> *&#160;</td>
288 <td class="paramname"><em>model</em></td><td>)</td>
289 <td><code> [pure virtual]</code></td>
290 </tr>
291 </table>
292 </div>
293 <div class="memdoc">
294
295 <p>Swap the instance with |model|. </p>
296 <p>The ownership of |model| always moves to this instance, meaning that passed |model| will no longer be accessible after calling this method. return true if new model is swapped successfully. This method is thread safe. All taggers created by <a class="el" href="classMeCab_1_1Model.html#a9d9135a4431adb3a985153cb4ab8f3a1" title="Create a new Tagger object.">Model::createTagger()</a> method will also be updated asynchronously. No need to stop the parsing thread excplicitly before swapping model object. </p>
297 <dl class="return"><dt><b>Returns:</b></dt><dd>boolean </dd></dl>
298 <dl class="params"><dt><b>Parameters:</b></dt><dd>
299 <table class="params">
300 <tr><td class="paramname">model</td><td>new model which is going to be swapped with the current model. </td></tr>
301 </table>
302 </dd>
303 </dl>
304
305 </div>
306 </div>
307 <a class="anchor" id="ad89d4de4fa9da5e9ac7045e72f2fbb1e"></a><!-- doxytag: member="MeCab::Model::transition_cost" ref="ad89d4de4fa9da5e9ac7045e72f2fbb1e" args="(unsigned short rcAttr, unsigned short lcAttr) const =0" -->
308 <div class="memitem">
309 <div class="memproto">
310 <table class="memname">
311 <tr>
312 <td class="memname">virtual int <a class="el" href="classMeCab_1_1Model.html#ad89d4de4fa9da5e9ac7045e72f2fbb1e">MeCab::Model::transition_cost</a> </td>
313 <td>(</td>
314 <td class="paramtype">unsigned short&#160;</td>
315 <td class="paramname"><em>rcAttr</em>, </td>
316 </tr>
317 <tr>
318 <td class="paramkey"></td>
319 <td></td>
320 <td class="paramtype">unsigned short&#160;</td>
321 <td class="paramname"><em>lcAttr</em>&#160;</td>
322 </tr>
323 <tr>
324 <td></td>
325 <td>)</td>
326 <td></td><td> const<code> [pure virtual]</code></td>
327 </tr>
328 </table>
329 </div>
330 <div class="memdoc">
331
332 <p>Return transtion cost from rcAttr to lcAttr. </p>
333 <dl class="return"><dt><b>Returns:</b></dt><dd>transtion cost </dd></dl>
334
335 </div>
336 </div>
337 <a class="anchor" id="af6d63f8eb887b8b147bdb87a34b06bee"></a><!-- doxytag: member="MeCab::Model::version" ref="af6d63f8eb887b8b147bdb87a34b06bee" args="()" -->
338 <div class="memitem">
339 <div class="memproto">
340 <table class="memname">
341 <tr>
342 <td class="memname">static const char* <a class="el" href="classMeCab_1_1Model.html#af6d63f8eb887b8b147bdb87a34b06bee">MeCab::Model::version</a> </td>
343 <td>(</td>
344 <td class="paramname"></td><td>)</td>
345 <td><code> [static]</code></td>
346 </tr>
347 </table>
348 </div>
349 <div class="memdoc">
350
351 <p>Return a version string. </p>
352 <dl class="return"><dt><b>Returns:</b></dt><dd>version string </dd></dl>
353
354 </div>
355 </div>
356 <hr/>The documentation for this class was generated from the following file:<ul>
357 <li>/home/taku/proj/mecab/mecab/src/<a class="el" href="mecab_8h_source.html">mecab.h</a></li>
358 </ul>
359 </div><!-- contents -->
360
361
362 <hr class="footer"/><address class="footer"><small>
363 Generated on Mon Feb 18 2013 02:23:58 for MeCab by &#160;<a href="http://www.doxygen.org/index.html">
364 <img class="footer" src="doxygen.png" alt="doxygen"/>
365 </a> 1.7.6.1
366 </small></address>
367
368 </body>
369 </html>