Mercurial > hg > ltpda

comparison m-toolbox/html_help/help/ug/class_desc_minfo_content.html @ 0:f0afece42f48

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Import.
author Daniele Nicolodi <nicolodi@science.unitn.it>
date Wed, 23 Nov 2011 19:22:13 +0100
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:f0afece42f48
1 <!-- $Id: class_desc_minfo_content.html,v 1.6 2009/03/17 16:52:04 ingo Exp $ -->
2
3 <!-- ================================================== -->
4 <!-- BEGIN CONTENT FILE -->
5 <!-- ================================================== -->
6 <!-- ===== link box: Begin ===== -->
7 <p>
8 <table border="1" width="80%">
9 <tr>
10 <td>
11 <table border="0" cellpadding="5" class="categorylist" width="100%">
12 <colgroup>
13 <col width="37%"/>
14 <col width="63%"/>
15 </colgroup>
16 <tbody>
17 <tr valign="top">
18 <td>
19 <a href="class_desc_minfo.html#top_properties">Properties</a>
20 </td>
21 <td>Properties of the class</td>
22 </tr>
23 <tr valign="top">
24 <td>
25 <a href="class_desc_minfo.html#top_methods">Methods</a>
26 </td>
27 <td>All Methods of the class ordered by category.</td>
28 </tr>
29 <tr valign="top">
30 <td>
31 <a href="constructor_examples_main.html">Examples</a>
32 </td>
33 <td>Some constructor examples</td>
34 </tr>
35 </tbody>
36 </table>
37 </td>
38 </tr>
39 </table>
40 </p>
41 <!-- ===== link box: End ====== -->
42
43 <!-- ===== Back to Class descriptions ===== -->
44 <a href="class_desc_main.html">
45 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Class descriptions"/>
46 Back to Class descriptions
47 </a>
48
49 <h2 class="title"><a name="top_properties"/>Properties</h2>
50 <p>
51 The LTPDA toolbox restrict access of the properties.<br></br>
52 The get access is 'public' and thus it is possible to get the values with the dot-command (similar to structures).<br></br>
53 <pre class="programlisting">For example:<br></br>val = obj.prop(2).prop;</pre>
54 The set access is 'protected' and thus it is only possible to assign a value to a property with a set-method.
55 <pre class="programlisting">
56 For example:
57 obj2 = obj1.setName(<span class="string">'my name'</span>) <span class="comment">% This command creates a copy of obj1 (obj1 ~= obj2)</span>
58 obj.setName(<span class="string">'my name'</span>); <span class="comment">% This command applies to obj</span> </pre>
59 </p>
60 <!-- ===== Properties ===== -->
61 <p>
62 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
63 <colgroup>
64 <col width="15%"/>
65 <col width="73%"/>
66 <col width="12%"/>
67 </colgroup>
68 <thead>
69 <tr valign="top">
70 <th class="categorylist">Properties</th>
71 <th class="categorylist">Description</th>
72 <th class="categorylist">Defined in class</th>
73 </tr>
74 </thead>
75 <tbody>
76 <!-- Property: 'mname' -->
77 <tr valign="top">
78 <td bgcolor="#f3f4f5">
79 <p><tt>mname</tt></p>
80 </td>
81 <td bgcolor="#f3f4f5">
82 <p>Method name where the minfo object is defined</p>
83 </td>
84 <td bgcolor="#f3f4f5">
85 <p>minfo</p>
86 </td>
87 </tr>
88 <!-- Property: 'mclass' -->
89 <tr valign="top">
90 <td>
91 <p><tt>mclass</tt></p>
92 </td>
93 <td>
94 <p>Class name where the minfo object is defined</p>
95 </td>
96 <td>
97 <p>minfo</p>
98 </td>
99 </tr>
100 <!-- Property: 'mpackage' -->
101 <tr valign="top">
102 <td bgcolor="#f3f4f5">
103 <p><tt>mpackage</tt></p>
104 </td>
105 <td bgcolor="#f3f4f5">
106 <p>Package name where the minfo object is defined</p>
107 </td>
108 <td bgcolor="#f3f4f5">
109 <p>minfo</p>
110 </td>
111 </tr>
112 <!-- Property: 'mcategory' -->
113 <tr valign="top">
114 <td>
115 <p><tt>mcategory</tt></p>
116 </td>
117 <td>
118 <p>Category of the of the method where the minfo object is defined</p>
119 </td>
120 <td>
121 <p>minfo</p>
122 </td>
123 </tr>
124 <!-- Property: 'mversion' -->
125 <tr valign="top">
126 <td bgcolor="#f3f4f5">
127 <p><tt>mversion</tt></p>
128 </td>
129 <td bgcolor="#f3f4f5">
130 <p>Version string of the method where the minfo object is defined</p>
131 </td>
132 <td bgcolor="#f3f4f5">
133 <p>minfo</p>
134 </td>
135 </tr>
136 <!-- Property: 'sets' -->
137 <tr valign="top">
138 <td>
139 <p><tt>sets</tt></p>
140 </td>
141 <td>
142 <p>Possible set name for the different Default parameter lists</p>
143 </td>
144 <td>
145 <p>minfo</p>
146 </td>
147 </tr>
148 <!-- Property: 'plists' -->
149 <tr valign="top">
150 <td bgcolor="#f3f4f5">
151 <p><tt>plists</tt></p>
152 </td>
153 <td bgcolor="#f3f4f5">
154 <p>All different default parameter lists</p>
155 </td>
156 <td bgcolor="#f3f4f5">
157 <p>minfo</p>
158 </td>
159 </tr>
160 <!-- Property: 'argsmin' -->
161 <tr valign="top">
162 <td>
163 <p><tt>argsmin</tt></p>
164 </td>
165 <td>
166 <p>Minimal input objects of the method</p>
167 </td>
168 <td>
169 <p>minfo</p>
170 </td>
171 </tr>
172 <!-- Property: 'argsmax' -->
173 <tr valign="top">
174 <td bgcolor="#f3f4f5">
175 <p><tt>argsmax</tt></p>
176 </td>
177 <td bgcolor="#f3f4f5">
178 <p>Maximal input objects of the method</p>
179 </td>
180 <td bgcolor="#f3f4f5">
181 <p>minfo</p>
182 </td>
183 </tr>
184 <!-- Property: 'outmin' -->
185 <tr valign="top">
186 <td>
187 <p><tt>outmin</tt></p>
188 </td>
189 <td>
190 <p>Minimal output objects of the method</p>
191 </td>
192 <td>
193 <p>minfo</p>
194 </td>
195 </tr>
196 <!-- Property: 'outmax' -->
197 <tr valign="top">
198 <td bgcolor="#f3f4f5">
199 <p><tt>outmax</tt></p>
200 </td>
201 <td bgcolor="#f3f4f5">
202 <p>Maximal input objects of the method</p>
203 </td>
204 <td bgcolor="#f3f4f5">
205 <p>minfo</p>
206 </td>
207 </tr>
208 <!-- Property: 'modifier' -->
209 <tr valign="top">
210 <td>
211 <p><tt>modifier</tt></p>
212 </td>
213 <td>
214 <p>Defines if the method can be used as a modifier</p>
215 </td>
216 <td>
217 <p>minfo</p>
218 </td>
219 </tr>
220 <!-- Property: 'version' -->
221 <tr valign="top">
222 <td bgcolor="#f3f4f5">
223 <p><tt>version</tt></p>
224 </td>
225 <td bgcolor="#f3f4f5">
226 <p>CVS version string of the constructor</p>
227 </td>
228 <td bgcolor="#f3f4f5">
229 <p>minfo</p>
230 </td>
231 </tr>
232 </tbody>
233 </table>
234 </p>
235
236 <!-- ===== Top of page ===== -->
237 <a href="#top_of_page">
238 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top"/>
239 Back to Top
240 </a>
241
242 <h2 class="title"><a name="top_methods"/>Methods</h2>
243 <!-- ===== link box: Begin ===== -->
244 <p>
245 <table border="1" width="80%">
246 <tr>
247 <td>
248 <table border="0" cellpadding="5" class="subcategorylist" width="100%">
249 <colgroup>
250 <col width="37%"/>
251 <col width="63%"/>
252 </colgroup>
253 <tbody>
254 <tr valign="top">
255 <td>
256 <a href="class_desc_minfo.html#constructor">Constructor</a>
257 </td>
258 <td>Constructor of this class</td>
259 </tr>
260 <tr valign="top">
261 <td>
262 <a href="class_desc_minfo.html#helper">Helper</a>
263 </td>
264 <td>Helper methods only for internal usage</td>
265 </tr>
266 <tr valign="top">
267 <td>
268 <a href="class_desc_minfo.html#internal">Internal</a>
269 </td>
270 <td>Internal methods only for internal usage</td>
271 </tr>
272 <tr valign="top">
273 <td>
274 <a href="class_desc_minfo.html#output">Output</a>
275 </td>
276 <td>Output methods</td>
277 </tr>
278 <tr valign="top">
279 <td>
280 <a href="class_desc_minfo.html#relational_operator">Relational Operator</a>
281 </td>
282 <td>Relational operator methods</td>
283 </tr>
284 </tbody>
285 </table>
286 </td>
287 </tr>
288 </table>
289 </p>
290 <!-- ===== link box: End ====== -->
291
292 <!-- ===== Top of page ===== -->
293 <a href="#top_of_page">
294 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top"/>
295 Back to Top
296 </a>
297
298 <!-- ===== Methods Category: Constructor ===== -->
299 <h3 class="title"><a name="constructor"/>Constructor</h3>
300 <p>
301 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
302 <colgroup>
303 <col width="15%"/>
304 <col width="73%"/>
305 <col width="12%"/>
306 </colgroup>
307 <thead>
308 <tr valign="top">
309 <th class="categorylist">Methods</th>
310 <th class="categorylist">Description</th>
311 <th class="categorylist">Defined in class</th>
312 </tr>
313 </thead>
314 <tbody>
315 <!-- minfo/minfo -->
316 <tr valign="top">
317 <td bgcolor="#f3f4f5">
318 <p><a href="matlab:doc('minfo')">minfo</a></p>
319 </td>
320 <td bgcolor="#f3f4f5">
321 <p>MINFO a helper class for LTPDA methods.</p>
322 </td>
323 <td bgcolor="#f3f4f5">
324 <p>minfo</p>
325 </td>
326 </tr>
327 </tbody>
328 </table>
329 <!-- ===== Back to Top of Methods ===== -->
330 <a href="#top_methods">
331 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
332 Back to Top of Section
333 </a>
334
335 </p>
336
337 <!-- ===== Methods Category: Helper ===== -->
338 <h3 class="title"><a name="helper"/>Helper</h3>
339 <p>
340 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
341 <colgroup>
342 <col width="15%"/>
343 <col width="73%"/>
344 <col width="12%"/>
345 </colgroup>
346 <thead>
347 <tr valign="top">
348 <th class="categorylist">Methods</th>
349 <th class="categorylist">Description</th>
350 <th class="categorylist">Defined in class</th>
351 </tr>
352 </thead>
353 <tbody>
354 <!-- ltpda_obj/get -->
355 <tr valign="top">
356 <td bgcolor="#f3f4f5">
357 <p><a href="matlab:doc('ltpda_obj/get')">get</a></p>
358 </td>
359 <td bgcolor="#f3f4f5">
360 <p>GET get a property of a object.</p>
361 </td>
362 <td bgcolor="#f3f4f5">
363 <p>ltpda_obj</p>
364 </td>
365 </tr>
366 <!-- ltpda_obj/isprop -->
367 <tr valign="top">
368 <td>
369 <p><a href="matlab:doc('ltpda_obj/isprop')">isprop</a></p>
370 </td>
371 <td>
372 <p>ISPROP tests if the given field is one of the object properties.</p>
373 </td>
374 <td>
375 <p>ltpda_obj</p>
376 </td>
377 </tr>
378 </tbody>
379 </table>
380 <!-- ===== Back to Top of Methods ===== -->
381 <a href="#top_methods">
382 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
383 Back to Top of Section
384 </a>
385
386 </p>
387
388 <!-- ===== Methods Category: Internal ===== -->
389 <h3 class="title"><a name="internal"/>Internal</h3>
390 <p>
391 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
392 <colgroup>
393 <col width="15%"/>
394 <col width="73%"/>
395 <col width="12%"/>
396 </colgroup>
397 <thead>
398 <tr valign="top">
399 <th class="categorylist">Methods</th>
400 <th class="categorylist">Description</th>
401 <th class="categorylist">Defined in class</th>
402 </tr>
403 </thead>
404 <tbody>
405 <!-- minfo/setArgsmax -->
406 <tr valign="top">
407 <td bgcolor="#f3f4f5">
408 <p><a href="matlab:doc('minfo/setArgsmax')">setArgsmax</a></p>
409 </td>
410 <td bgcolor="#f3f4f5">
411 <p>SETARGSMAX Set the property 'argsmax'.</p>
412 </td>
413 <td bgcolor="#f3f4f5">
414 <p>minfo</p>
415 </td>
416 </tr>
417 <!-- minfo/setArgsmin -->
418 <tr valign="top">
419 <td>
420 <p><a href="matlab:doc('minfo/setArgsmin')">setArgsmin</a></p>
421 </td>
422 <td>
423 <p>SETARGSMIN Set the property 'argsmin'.</p>
424 </td>
425 <td>
426 <p>minfo</p>
427 </td>
428 </tr>
429 <!-- minfo/setModifier -->
430 <tr valign="top">
431 <td bgcolor="#f3f4f5">
432 <p><a href="matlab:doc('minfo/setModifier')">setModifier</a></p>
433 </td>
434 <td bgcolor="#f3f4f5">
435 <p>SETMODIFIER Set the property 'modifier'.</p>
436 </td>
437 <td bgcolor="#f3f4f5">
438 <p>minfo</p>
439 </td>
440 </tr>
441 <!-- minfo/setMversion -->
442 <tr valign="top">
443 <td>
444 <p><a href="matlab:doc('minfo/setMversion')">setMversion</a></p>
445 </td>
446 <td>
447 <p>SETMVERSION Set the property 'mversion'.</p>
448 </td>
449 <td>
450 <p>minfo</p>
451 </td>
452 </tr>
453 <!-- minfo/setOutmax -->
454 <tr valign="top">
455 <td bgcolor="#f3f4f5">
456 <p><a href="matlab:doc('minfo/setOutmax')">setOutmax</a></p>
457 </td>
458 <td bgcolor="#f3f4f5">
459 <p>SETOUTMAX Set the property 'outmax'.</p>
460 </td>
461 <td bgcolor="#f3f4f5">
462 <p>minfo</p>
463 </td>
464 </tr>
465 <!-- minfo/setOutmin -->
466 <tr valign="top">
467 <td>
468 <p><a href="matlab:doc('minfo/setOutmin')">setOutmin</a></p>
469 </td>
470 <td>
471 <p>SETOUTMIN Set the property 'outmin'.</p>
472 </td>
473 <td>
474 <p>minfo</p>
475 </td>
476 </tr>
477 </tbody>
478 </table>
479 <!-- ===== Back to Top of Methods ===== -->
480 <a href="#top_methods">
481 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
482 Back to Top of Section
483 </a>
484
485 </p>
486
487 <!-- ===== Methods Category: Output ===== -->
488 <h3 class="title"><a name="output"/>Output</h3>
489 <p>
490 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
491 <colgroup>
492 <col width="15%"/>
493 <col width="73%"/>
494 <col width="12%"/>
495 </colgroup>
496 <thead>
497 <tr valign="top">
498 <th class="categorylist">Methods</th>
499 <th class="categorylist">Description</th>
500 <th class="categorylist">Defined in class</th>
501 </tr>
502 </thead>
503 <tbody>
504 <!-- minfo/char -->
505 <tr valign="top">
506 <td bgcolor="#f3f4f5">
507 <p><a href="matlab:doc('minfo/char')">char</a></p>
508 </td>
509 <td bgcolor="#f3f4f5">
510 <p>CHAR convert an minfo object into a string.</p>
511 </td>
512 <td bgcolor="#f3f4f5">
513 <p>minfo</p>
514 </td>
515 </tr>
516 <!-- minfo/display -->
517 <tr valign="top">
518 <td>
519 <p><a href="matlab:doc('minfo/display')">display</a></p>
520 </td>
521 <td>
522 <p>DISPLAY display an minfo object.</p>
523 </td>
524 <td>
525 <p>minfo</p>
526 </td>
527 </tr>
528 </tbody>
529 </table>
530 <!-- ===== Back to Top of Methods ===== -->
531 <a href="#top_methods">
532 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
533 Back to Top of Section
534 </a>
535
536 </p>
537
538 <!-- ===== Methods Category: Relational_Operator ===== -->
539 <h3 class="title"><a name="relational_operator"/>Relational Operator</h3>
540 <p>
541 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
542 <colgroup>
543 <col width="15%"/>
544 <col width="73%"/>
545 <col width="12%"/>
546 </colgroup>
547 <thead>
548 <tr valign="top">
549 <th class="categorylist">Methods</th>
550 <th class="categorylist">Description</th>
551 <th class="categorylist">Defined in class</th>
552 </tr>
553 </thead>
554 <tbody>
555 <!-- ltpda_obj/eq -->
556 <tr valign="top">
557 <td bgcolor="#f3f4f5">
558 <p><a href="matlab:doc('ltpda_obj/eq')">eq</a></p>
559 </td>
560 <td bgcolor="#f3f4f5">
561 <p>EQ overloads the == operator for ltpda objects.</p>
562 </td>
563 <td bgcolor="#f3f4f5">
564 <p>ltpda_obj</p>
565 </td>
566 </tr>
567 <!-- ltpda_obj/ne -->
568 <tr valign="top">
569 <td>
570 <p><a href="matlab:doc('ltpda_obj/ne')">ne</a></p>
571 </td>
572 <td>
573 <p>NE overloads the ~= operator for ltpda objects.</p>
574 </td>
575 <td>
576 <p>ltpda_obj</p>
577 </td>
578 </tr>
579 </tbody>
580 </table>
581 <!-- ===== Back to Top of Methods ===== -->
582 <a href="#top_methods">
583 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
584 Back to Top of Section
585 </a>
586
587 </p>
588
589 <!-- ================================================== -->
590 <!-- END CONTENT FILE -->
591 <!-- ================================================== -->