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

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_smodel_content.html,v 1.3 2011/05/12 19:47:56 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_smodel.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_smodel.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_smodel.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: 'expr' -->
77 <tr valign="top">
78 <td bgcolor="#f3f4f5">
79 <p><a href="matlab:doc('smodel.expr')">expr</a></p>
80 </td>
81 <td bgcolor="#f3f4f5">
82 <p>Expression of the model</p>
83 </td>
84 <td bgcolor="#f3f4f5">
85 <p>smodel</p>
86 </td>
87 </tr>
88 <!-- Property: 'params' -->
89 <tr valign="top">
90 <td>
91 <p><a href="matlab:doc('smodel.params')">params</a></p>
92 </td>
93 <td>
94 <p>Parameters which are used in the model</p>
95 </td>
96 <td>
97 <p>smodel</p>
98 </td>
99 </tr>
100 <!-- Property: 'values' -->
101 <tr valign="top">
102 <td bgcolor="#f3f4f5">
103 <p><a href="matlab:doc('smodel.values')">values</a></p>
104 </td>
105 <td bgcolor="#f3f4f5">
106 <p>Default values for the parameters</p>
107 </td>
108 <td bgcolor="#f3f4f5">
109 <p>smodel</p>
110 </td>
111 </tr>
112 <!-- Property: 'trans' -->
113 <tr valign="top">
114 <td>
115 <p><a href="matlab:doc('smodel.trans')">trans</a></p>
116 </td>
117 <td>
118 <p>Transformation strings mapping xvals in terms of xvar to X in the model</p>
119 </td>
120 <td>
121 <p>smodel</p>
122 </td>
123 </tr>
124 <!-- Property: 'aliasNames' -->
125 <tr valign="top">
126 <td bgcolor="#f3f4f5">
127 <p><a href="matlab:doc('smodel.aliasNames')">aliasNames</a></p>
128 </td>
129 <td bgcolor="#f3f4f5">
130 <p>{'v', 'H'};</p>
131 </td>
132 <td bgcolor="#f3f4f5">
133 <p>smodel</p>
134 </td>
135 </tr>
136 <!-- Property: 'aliasValues' -->
137 <tr valign="top">
138 <td>
139 <p><a href="matlab:doc('smodel.aliasValues')">aliasValues</a></p>
140 </td>
141 <td>
142 <p>{'a*b', [1:20]};</p>
143 </td>
144 <td>
145 <p>smodel</p>
146 </td>
147 </tr>
148 <!-- Property: 'xvar' -->
149 <tr valign="top">
150 <td bgcolor="#f3f4f5">
151 <p><a href="matlab:doc('smodel.xvar')">xvar</a></p>
152 </td>
153 <td bgcolor="#f3f4f5">
154 <p>Cell-array with x-variable(s)</p>
155 </td>
156 <td bgcolor="#f3f4f5">
157 <p>smodel</p>
158 </td>
159 </tr>
160 <!-- Property: 'xvals' -->
161 <tr valign="top">
162 <td>
163 <p><a href="matlab:doc('smodel.xvals')">xvals</a></p>
164 </td>
165 <td>
166 <p>Cell-array of double-values for the different x-variable(s)</p>
167 </td>
168 <td>
169 <p>smodel</p>
170 </td>
171 </tr>
172 <!-- Property: 'xunits' -->
173 <tr valign="top">
174 <td bgcolor="#f3f4f5">
175 <p><a href="matlab:doc('smodel.xunits')">xunits</a></p>
176 </td>
177 <td bgcolor="#f3f4f5">
178 <p>vector of units of the different x-axis</p>
179 </td>
180 <td bgcolor="#f3f4f5">
181 <p>smodel</p>
182 </td>
183 </tr>
184 <!-- Property: 'yunits' -->
185 <tr valign="top">
186 <td>
187 <p><a href="matlab:doc('smodel.yunits')">yunits</a></p>
188 </td>
189 <td>
190 <p>units of the y-axis</p>
191 </td>
192 <td>
193 <p>smodel</p>
194 </td>
195 </tr>
196 <!-- Property: 'hist' -->
197 <tr valign="top">
198 <td bgcolor="#f3f4f5">
199 <p><a href="matlab:doc('smodel.hist')">hist</a></p>
200 </td>
201 <td bgcolor="#f3f4f5">
202 <p>history of the object (history object)</p>
203 </td>
204 <td bgcolor="#f3f4f5">
205 <p>ltpda_uoh</p>
206 </td>
207 </tr>
208 <!-- Property: 'procinfo' -->
209 <tr valign="top">
210 <td>
211 <p><a href="matlab:doc('smodel.procinfo')">procinfo</a></p>
212 </td>
213 <td>
214 <p>plist with additional information for an object.</p>
215 </td>
216 <td>
217 <p>ltpda_uoh</p>
218 </td>
219 </tr>
220 <!-- Property: 'plotinfo' -->
221 <tr valign="top">
222 <td bgcolor="#f3f4f5">
223 <p><a href="matlab:doc('smodel.plotinfo')">plotinfo</a></p>
224 </td>
225 <td bgcolor="#f3f4f5">
226 <p>plist with the plot information</p>
227 </td>
228 <td bgcolor="#f3f4f5">
229 <p>ltpda_uoh</p>
230 </td>
231 </tr>
232 <!-- Property: 'name' -->
233 <tr valign="top">
234 <td>
235 <p><a href="matlab:doc('smodel.name')">name</a></p>
236 </td>
237 <td>
238 <p>name of the object</p>
239 </td>
240 <td>
241 <p>ltpda_uo</p>
242 </td>
243 </tr>
244 <!-- Property: 'description' -->
245 <tr valign="top">
246 <td bgcolor="#f3f4f5">
247 <p><a href="matlab:doc('smodel.description')">description</a></p>
248 </td>
249 <td bgcolor="#f3f4f5">
250 <p>description of the object</p>
251 </td>
252 <td bgcolor="#f3f4f5">
253 <p>ltpda_uo</p>
254 </td>
255 </tr>
256 <!-- Property: 'mdlfile' -->
257 <tr valign="top">
258 <td>
259 <p><a href="matlab:doc('smodel.mdlfile')">mdlfile</a></p>
260 </td>
261 <td>
262 <p>model xml file of the LTPDAworkbench</p>
263 </td>
264 <td>
265 <p>ltpda_uo</p>
266 </td>
267 </tr>
268 <!-- Property: 'UUID' -->
269 <tr valign="top">
270 <td bgcolor="#f3f4f5">
271 <p><a href="matlab:doc('smodel.UUID')">UUID</a></p>
272 </td>
273 <td bgcolor="#f3f4f5">
274 <p>Universally Unique Identifier of 128-bit</p>
275 </td>
276 <td bgcolor="#f3f4f5">
277 <p>ltpda_uo</p>
278 </td>
279 </tr>
280 </tbody>
281 </table>
282 </p>
283
284 <!-- ===== Top of page ===== -->
285 <a href="#top_of_page">
286 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top"/>
287 Back to Top
288 </a>
289
290 <h2 class="title"><a name="top_methods"/>Methods</h2>
291 <!-- ===== link box: Begin ===== -->
292 <p>
293 <table border="1" width="80%">
294 <tr>
295 <td>
296 <table border="0" cellpadding="5" class="subcategorylist" width="100%">
297 <colgroup>
298 <col width="37%"/>
299 <col width="63%"/>
300 </colgroup>
301 <tbody>
302 <tr valign="top">
303 <td>
304 <a href="class_desc_smodel.html#arithmetic_operator">Arithmetic Operator</a>
305 </td>
306 <td>Arithmetic Operator</td>
307 </tr>
308 <tr valign="top">
309 <td>
310 <a href="class_desc_smodel.html#constructor">Constructor</a>
311 </td>
312 <td>Constructor of this class</td>
313 </tr>
314 <tr valign="top">
315 <td>
316 <a href="class_desc_smodel.html#helper">Helper</a>
317 </td>
318 <td>Helper methods only for internal usage</td>
319 </tr>
320 <tr valign="top">
321 <td>
322 <a href="class_desc_smodel.html#internal">Internal</a>
323 </td>
324 <td>Internal methods only for internal usage</td>
325 </tr>
326 <tr valign="top">
327 <td>
328 <a href="class_desc_smodel.html#operator">Operator</a>
329 </td>
330 <td>Operator methods</td>
331 </tr>
332 <tr valign="top">
333 <td>
334 <a href="class_desc_smodel.html#output">Output</a>
335 </td>
336 <td>Output methods</td>
337 </tr>
338 <tr valign="top">
339 <td>
340 <a href="class_desc_smodel.html#relational_operator">Relational Operator</a>
341 </td>
342 <td>Relational operator methods</td>
343 </tr>
344 </tbody>
345 </table>
346 </td>
347 </tr>
348 </table>
349 </p>
350 <!-- ===== link box: End ====== -->
351
352 <!-- ===== Top of page ===== -->
353 <a href="#top_of_page">
354 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top"/>
355 Back to Top
356 </a>
357
358 <!-- ===== Methods Category: Arithmetic_Operator ===== -->
359 <h3 class="title"><a name="arithmetic_operator"/>Arithmetic Operator</h3>
360 <p>
361 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
362 <colgroup>
363 <col width="15%"/>
364 <col width="73%"/>
365 <col width="12%"/>
366 </colgroup>
367 <thead>
368 <tr valign="top">
369 <th class="categorylist">Methods</th>
370 <th class="categorylist">Description</th>
371 <th class="categorylist">Defined in class</th>
372 </tr>
373 </thead>
374 <tbody>
375 <!-- smodel/conj -->
376 <tr valign="top">
377 <td bgcolor="#f3f4f5">
378 <p><a href="matlab:doc('smodel/conj')">conj</a></p>
379 </td>
380 <td bgcolor="#f3f4f5">
381 <p>CONJ gives the complex conjugate of the input smodels</p>
382 </td>
383 <td bgcolor="#f3f4f5">
384 <p>smodel</p>
385 </td>
386 </tr>
387 <!-- smodel/minus -->
388 <tr valign="top">
389 <td>
390 <p><a href="matlab:doc('smodel/minus')">minus</a></p>
391 </td>
392 <td>
393 <p>MINUS implements subtraction operator for smodel objects.</p>
394 </td>
395 <td>
396 <p>smodel</p>
397 </td>
398 </tr>
399 <!-- smodel/mrdivide -->
400 <tr valign="top">
401 <td bgcolor="#f3f4f5">
402 <p><a href="matlab:doc('smodel/mrdivide')">mrdivide</a></p>
403 </td>
404 <td bgcolor="#f3f4f5">
405 <p>MRDIVIDE implements mrdivide operator for smodel objects.</p>
406 </td>
407 <td bgcolor="#f3f4f5">
408 <p>smodel</p>
409 </td>
410 </tr>
411 <!-- smodel/mtimes -->
412 <tr valign="top">
413 <td>
414 <p><a href="matlab:doc('smodel/mtimes')">mtimes</a></p>
415 </td>
416 <td>
417 <p>MTIMES implements mtimes operator for smodel objects.</p>
418 </td>
419 <td>
420 <p>smodel</p>
421 </td>
422 </tr>
423 <!-- smodel/plus -->
424 <tr valign="top">
425 <td bgcolor="#f3f4f5">
426 <p><a href="matlab:doc('smodel/plus')">plus</a></p>
427 </td>
428 <td bgcolor="#f3f4f5">
429 <p>PLUS implements addition operator for smodel objects.</p>
430 </td>
431 <td bgcolor="#f3f4f5">
432 <p>smodel</p>
433 </td>
434 </tr>
435 <!-- smodel/rdivide -->
436 <tr valign="top">
437 <td>
438 <p><a href="matlab:doc('smodel/rdivide')">rdivide</a></p>
439 </td>
440 <td>
441 <p>RDIVIDE implements division operator for smodel objects.</p>
442 </td>
443 <td>
444 <p>smodel</p>
445 </td>
446 </tr>
447 <!-- smodel/times -->
448 <tr valign="top">
449 <td bgcolor="#f3f4f5">
450 <p><a href="matlab:doc('smodel/times')">times</a></p>
451 </td>
452 <td bgcolor="#f3f4f5">
453 <p>TIMES implements multiplication operator for smodel objects.</p>
454 </td>
455 <td bgcolor="#f3f4f5">
456 <p>smodel</p>
457 </td>
458 </tr>
459 </tbody>
460 </table>
461 <!-- ===== Back to Top of Methods ===== -->
462 <a href="#top_methods">
463 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
464 Back to Top of Section
465 </a>
466
467 </p>
468
469 <!-- ===== Methods Category: Constructor ===== -->
470 <h3 class="title"><a name="constructor"/>Constructor</h3>
471 <p>
472 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
473 <colgroup>
474 <col width="15%"/>
475 <col width="73%"/>
476 <col width="12%"/>
477 </colgroup>
478 <thead>
479 <tr valign="top">
480 <th class="categorylist">Methods</th>
481 <th class="categorylist">Description</th>
482 <th class="categorylist">Defined in class</th>
483 </tr>
484 </thead>
485 <tbody>
486 <!-- ltpda_uoh/rebuild -->
487 <tr valign="top">
488 <td bgcolor="#f3f4f5">
489 <p><a href="matlab:doc('smodel/rebuild')">rebuild</a></p>
490 </td>
491 <td bgcolor="#f3f4f5">
492 <p>REBUILD rebuilds the input objects using the history.</p>
493 </td>
494 <td bgcolor="#f3f4f5">
495 <p>ltpda_uoh</p>
496 </td>
497 </tr>
498 <!-- smodel/smodel -->
499 <tr valign="top">
500 <td>
501 <p><a href="matlab:doc('smodel')">smodel</a></p>
502 </td>
503 <td>
504 <p>SMODEL constructor for smodel class.</p>
505 </td>
506 <td>
507 <p>smodel</p>
508 </td>
509 </tr>
510 </tbody>
511 </table>
512 <!-- ===== Back to Top of Methods ===== -->
513 <a href="#top_methods">
514 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
515 Back to Top of Section
516 </a>
517
518 </p>
519
520 <!-- ===== Methods Category: Helper ===== -->
521 <h3 class="title"><a name="helper"/>Helper</h3>
522 <p>
523 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
524 <colgroup>
525 <col width="15%"/>
526 <col width="73%"/>
527 <col width="12%"/>
528 </colgroup>
529 <thead>
530 <tr valign="top">
531 <th class="categorylist">Methods</th>
532 <th class="categorylist">Description</th>
533 <th class="categorylist">Defined in class</th>
534 </tr>
535 </thead>
536 <tbody>
537 <!-- ltpda_obj/get -->
538 <tr valign="top">
539 <td bgcolor="#f3f4f5">
540 <p><a href="matlab:doc('smodel/get')">get</a></p>
541 </td>
542 <td bgcolor="#f3f4f5">
543 <p>GET get a property of a object.</p>
544 </td>
545 <td bgcolor="#f3f4f5">
546 <p>ltpda_obj</p>
547 </td>
548 </tr>
549 <!-- ltpda_uoh/created -->
550 <tr valign="top">
551 <td>
552 <p><a href="matlab:doc('smodel/created')">created</a></p>
553 </td>
554 <td>
555 <p>CREATED Returns a time object of the last modification.</p>
556 </td>
557 <td>
558 <p>ltpda_uoh</p>
559 </td>
560 </tr>
561 <!-- ltpda_uoh/creator -->
562 <tr valign="top">
563 <td bgcolor="#f3f4f5">
564 <p><a href="matlab:doc('smodel/creator')">creator</a></p>
565 </td>
566 <td bgcolor="#f3f4f5">
567 <p>CREATOR Extract the creator(s) from the history.</p>
568 </td>
569 <td bgcolor="#f3f4f5">
570 <p>ltpda_uoh</p>
571 </td>
572 </tr>
573 <!-- ltpda_uoh/csvexport -->
574 <tr valign="top">
575 <td>
576 <p><a href="matlab:doc('smodel/csvexport')">csvexport</a></p>
577 </td>
578 <td>
579 <p>CSVEXPORT Exports the data of an object to a csv file.</p>
580 </td>
581 <td>
582 <p>ltpda_uoh</p>
583 </td>
584 </tr>
585 <!-- ltpda_uoh/index -->
586 <tr valign="top">
587 <td bgcolor="#f3f4f5">
588 <p><a href="matlab:doc('smodel/index')">index</a></p>
589 </td>
590 <td bgcolor="#f3f4f5">
591 <p>INDEX index into a 'ltpda_uoh' object array or matrix. This properly captures the history.</p>
592 </td>
593 <td bgcolor="#f3f4f5">
594 <p>ltpda_uoh</p>
595 </td>
596 </tr>
597 <!-- ltpda_uoh/requirements -->
598 <tr valign="top">
599 <td>
600 <p><a href="matlab:doc('smodel/requirements')">requirements</a></p>
601 </td>
602 <td>
603 <p>REQUIREMENTS Returns a list of LTPDA extension requirements for a given object.</p>
604 </td>
605 <td>
606 <p>ltpda_uoh</p>
607 </td>
608 </tr>
609 <!-- ltpda_uoh/setDescription -->
610 <tr valign="top">
611 <td bgcolor="#f3f4f5">
612 <p><a href="matlab:doc('smodel/setDescription')">setDescription</a></p>
613 </td>
614 <td bgcolor="#f3f4f5">
615 <p>SETDESCRIPTION sets the 'description' property of a ltpda_uoh object.</p>
616 </td>
617 <td bgcolor="#f3f4f5">
618 <p>ltpda_uoh</p>
619 </td>
620 </tr>
621 <!-- ltpda_uoh/setMdlfile -->
622 <tr valign="top">
623 <td>
624 <p><a href="matlab:doc('smodel/setMdlfile')">setMdlfile</a></p>
625 </td>
626 <td>
627 <p>SETMDLFILE sets the 'mdlfile' property of a ltpda_uoh object.</p>
628 </td>
629 <td>
630 <p>ltpda_uoh</p>
631 </td>
632 </tr>
633 <!-- ltpda_uoh/setName -->
634 <tr valign="top">
635 <td bgcolor="#f3f4f5">
636 <p><a href="matlab:doc('smodel/setName')">setName</a></p>
637 </td>
638 <td bgcolor="#f3f4f5">
639 <p>SETNAME Sets the property 'name' of an ltpda_uoh object.</p>
640 </td>
641 <td bgcolor="#f3f4f5">
642 <p>ltpda_uoh</p>
643 </td>
644 </tr>
645 <!-- ltpda_uoh/setPlotinfo -->
646 <tr valign="top">
647 <td>
648 <p><a href="matlab:doc('smodel/setPlotinfo')">setPlotinfo</a></p>
649 </td>
650 <td>
651 <p>SETPLOTINFO sets the 'plotinfo' property of a ltpda_uoh object.</p>
652 </td>
653 <td>
654 <p>ltpda_uoh</p>
655 </td>
656 </tr>
657 <!-- ltpda_uoh/setProcinfo -->
658 <tr valign="top">
659 <td bgcolor="#f3f4f5">
660 <p><a href="matlab:doc('smodel/setProcinfo')">setProcinfo</a></p>
661 </td>
662 <td bgcolor="#f3f4f5">
663 <p>SETPROCINFO sets the 'procinfo' property of a ltpda_uoh object.</p>
664 </td>
665 <td bgcolor="#f3f4f5">
666 <p>ltpda_uoh</p>
667 </td>
668 </tr>
669 <!-- smodel/addAliases -->
670 <tr valign="top">
671 <td>
672 <p><a href="matlab:doc('smodel/addAliases')">addAliases</a></p>
673 </td>
674 <td>
675 <p>ADDALIASES Add the key-value pairs to the alias-names and alias-values</p>
676 </td>
677 <td>
678 <p>smodel</p>
679 </td>
680 </tr>
681 <!-- smodel/addParameters -->
682 <tr valign="top">
683 <td bgcolor="#f3f4f5">
684 <p><a href="matlab:doc('smodel/addParameters')">addParameters</a></p>
685 </td>
686 <td bgcolor="#f3f4f5">
687 <p>ADDPARAMETERS Add some parameters to the symbolic model (smodel) object</p>
688 </td>
689 <td bgcolor="#f3f4f5">
690 <p>smodel</p>
691 </td>
692 </tr>
693 <!-- smodel/assignalias -->
694 <tr valign="top">
695 <td>
696 <p><a href="matlab:doc('smodel/assignalias')">assignalias</a></p>
697 </td>
698 <td>
699 <p>ASSIGNALIAS assign values to smodel alias</p>
700 </td>
701 <td>
702 <p>smodel</p>
703 </td>
704 </tr>
705 <!-- smodel/clearAliases -->
706 <tr valign="top">
707 <td bgcolor="#f3f4f5">
708 <p><a href="matlab:doc('smodel/clearAliases')">clearAliases</a></p>
709 </td>
710 <td bgcolor="#f3f4f5">
711 <p>CLEARALIASES Clear the aliases.</p>
712 </td>
713 <td bgcolor="#f3f4f5">
714 <p>smodel</p>
715 </td>
716 </tr>
717 <!-- smodel/double -->
718 <tr valign="top">
719 <td>
720 <p><a href="matlab:doc('smodel/double')">double</a></p>
721 </td>
722 <td>
723 <p>DOUBLE Returns the numeric result of the model.</p>
724 </td>
725 <td>
726 <p>smodel</p>
727 </td>
728 </tr>
729 <!-- smodel/eval -->
730 <tr valign="top">
731 <td bgcolor="#f3f4f5">
732 <p><a href="matlab:doc('smodel/eval')">eval</a></p>
733 </td>
734 <td bgcolor="#f3f4f5">
735 <p>EVAL evaluates the symbolic model and returns an AO containing the numeric data.</p>
736 </td>
737 <td bgcolor="#f3f4f5">
738 <p>smodel</p>
739 </td>
740 </tr>
741 <!-- smodel/fitfunc -->
742 <tr valign="top">
743 <td>
744 <p><a href="matlab:doc('smodel/fitfunc')">fitfunc</a></p>
745 </td>
746 <td>
747 <p>FITFUNC Returns a function handle which sets the 'values' and 'xvals' to a ltpda model.</p>
748 </td>
749 <td>
750 <p>smodel</p>
751 </td>
752 </tr>
753 <!-- smodel/hessian -->
754 <tr valign="top">
755 <td bgcolor="#f3f4f5">
756 <p><a href="matlab:doc('smodel/hessian')">hessian</a></p>
757 </td>
758 <td bgcolor="#f3f4f5">
759 <p>hessian compute the hessian matrix for a symbolic model.</p>
760 </td>
761 <td bgcolor="#f3f4f5">
762 <p>smodel</p>
763 </td>
764 </tr>
765 <!-- smodel/op -->
766 <tr valign="top">
767 <td>
768 <p><a href="matlab:doc('smodel/op')">op</a></p>
769 </td>
770 <td>
771 <p>OP Add a operation around the model expression</p>
772 </td>
773 <td>
774 <p>smodel</p>
775 </td>
776 </tr>
777 <!-- smodel/setAliasNames -->
778 <tr valign="top">
779 <td bgcolor="#f3f4f5">
780 <p><a href="matlab:doc('smodel/setAliasNames')">setAliasNames</a></p>
781 </td>
782 <td bgcolor="#f3f4f5">
783 <p>SETALIASNAMES Set the property 'aliasNames'</p>
784 </td>
785 <td bgcolor="#f3f4f5">
786 <p>smodel</p>
787 </td>
788 </tr>
789 <!-- smodel/setAliasValues -->
790 <tr valign="top">
791 <td>
792 <p><a href="matlab:doc('smodel/setAliasValues')">setAliasValues</a></p>
793 </td>
794 <td>
795 <p>SETALIASVALUES Set the property 'aliasValues'</p>
796 </td>
797 <td>
798 <p>smodel</p>
799 </td>
800 </tr>
801 <!-- smodel/setAliases -->
802 <tr valign="top">
803 <td bgcolor="#f3f4f5">
804 <p><a href="matlab:doc('smodel/setAliases')">setAliases</a></p>
805 </td>
806 <td bgcolor="#f3f4f5">
807 <p>SETALIASES Set the key-value pairs to the alias-names and alias-values</p>
808 </td>
809 <td bgcolor="#f3f4f5">
810 <p>smodel</p>
811 </td>
812 </tr>
813 <!-- smodel/setParameters -->
814 <tr valign="top">
815 <td>
816 <p><a href="matlab:doc('smodel/setParameters')">setParameters</a></p>
817 </td>
818 <td>
819 <p>SETPARAMETERS Set some parameters to the symbolic model (smodel) object</p>
820 </td>
821 <td>
822 <p>smodel</p>
823 </td>
824 </tr>
825 <!-- smodel/setParams -->
826 <tr valign="top">
827 <td bgcolor="#f3f4f5">
828 <p><a href="matlab:doc('smodel/setParams')">setParams</a></p>
829 </td>
830 <td bgcolor="#f3f4f5">
831 <p>SETPARAMS Set the property 'params' AND 'values'</p>
832 </td>
833 <td bgcolor="#f3f4f5">
834 <p>smodel</p>
835 </td>
836 </tr>
837 <!-- smodel/setTrans -->
838 <tr valign="top">
839 <td>
840 <p><a href="matlab:doc('smodel/setTrans')">setTrans</a></p>
841 </td>
842 <td>
843 <p>SETTRANS sets the 'trans' property of the smodel object.</p>
844 </td>
845 <td>
846 <p>smodel</p>
847 </td>
848 </tr>
849 <!-- smodel/setValues -->
850 <tr valign="top">
851 <td bgcolor="#f3f4f5">
852 <p><a href="matlab:doc('smodel/setValues')">setValues</a></p>
853 </td>
854 <td bgcolor="#f3f4f5">
855 <p>SETVALUES Set the property 'values'</p>
856 </td>
857 <td bgcolor="#f3f4f5">
858 <p>smodel</p>
859 </td>
860 </tr>
861 <!-- smodel/setXunits -->
862 <tr valign="top">
863 <td>
864 <p><a href="matlab:doc('smodel/setXunits')">setXunits</a></p>
865 </td>
866 <td>
867 <p>SETXUNITS sets the 'xunits' property of the smodel object.</p>
868 </td>
869 <td>
870 <p>smodel</p>
871 </td>
872 </tr>
873 <!-- smodel/setXvals -->
874 <tr valign="top">
875 <td bgcolor="#f3f4f5">
876 <p><a href="matlab:doc('smodel/setXvals')">setXvals</a></p>
877 </td>
878 <td bgcolor="#f3f4f5">
879 <p>SETXVALS sets the 'xvals' property of the smodel object.</p>
880 </td>
881 <td bgcolor="#f3f4f5">
882 <p>smodel</p>
883 </td>
884 </tr>
885 <!-- smodel/setXvar -->
886 <tr valign="top">
887 <td>
888 <p><a href="matlab:doc('smodel/setXvar')">setXvar</a></p>
889 </td>
890 <td>
891 <p>SETXVAR sets the 'xvar' property of the smodel object.</p>
892 </td>
893 <td>
894 <p>smodel</p>
895 </td>
896 </tr>
897 <!-- smodel/setYunits -->
898 <tr valign="top">
899 <td bgcolor="#f3f4f5">
900 <p><a href="matlab:doc('smodel/setYunits')">setYunits</a></p>
901 </td>
902 <td bgcolor="#f3f4f5">
903 <p>SETYUNITS sets the 'yunits' property of the smodel object.</p>
904 </td>
905 <td bgcolor="#f3f4f5">
906 <p>smodel</p>
907 </td>
908 </tr>
909 <!-- smodel/simplifyUnits -->
910 <tr valign="top">
911 <td>
912 <p><a href="matlab:doc('smodel/simplifyUnits')">simplifyUnits</a></p>
913 </td>
914 <td>
915 <p>SIMPLIFYUNITS simplify the x and/or y units of the model.</p>
916 </td>
917 <td>
918 <p>smodel</p>
919 </td>
920 </tr>
921 <!-- smodel/subs -->
922 <tr valign="top">
923 <td bgcolor="#f3f4f5">
924 <p><a href="matlab:doc('smodel/subs')">subs</a></p>
925 </td>
926 <td bgcolor="#f3f4f5">
927 <p>SUBS substitutes symbolic parameters with the given values.</p>
928 </td>
929 <td bgcolor="#f3f4f5">
930 <p>smodel</p>
931 </td>
932 </tr>
933 </tbody>
934 </table>
935 <!-- ===== Back to Top of Methods ===== -->
936 <a href="#top_methods">
937 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
938 Back to Top of Section
939 </a>
940
941 </p>
942
943 <!-- ===== Methods Category: Internal ===== -->
944 <h3 class="title"><a name="internal"/>Internal</h3>
945 <p>
946 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
947 <colgroup>
948 <col width="15%"/>
949 <col width="73%"/>
950 <col width="12%"/>
951 </colgroup>
952 <thead>
953 <tr valign="top">
954 <th class="categorylist">Methods</th>
955 <th class="categorylist">Description</th>
956 <th class="categorylist">Defined in class</th>
957 </tr>
958 </thead>
959 <tbody>
960 <!-- ltpda_obj/isprop -->
961 <tr valign="top">
962 <td bgcolor="#f3f4f5">
963 <p><a href="matlab:doc('smodel/isprop')">isprop</a></p>
964 </td>
965 <td bgcolor="#f3f4f5">
966 <p>ISPROP tests if the given field is one of the object properties.</p>
967 </td>
968 <td bgcolor="#f3f4f5">
969 <p>ltpda_obj</p>
970 </td>
971 </tr>
972 <!-- ltpda_uo/bsubmit -->
973 <tr valign="top">
974 <td>
975 <p><a href="matlab:doc('smodel/bsubmit')">bsubmit</a></p>
976 </td>
977 <td>
978 <p>BSUBMIT Submits the given collection of objects in binary form to an LTPDA repository</p>
979 </td>
980 <td>
981 <p>ltpda_uo</p>
982 </td>
983 </tr>
984 <!-- ltpda_uo/submit -->
985 <tr valign="top">
986 <td bgcolor="#f3f4f5">
987 <p><a href="matlab:doc('smodel/submit')">submit</a></p>
988 </td>
989 <td bgcolor="#f3f4f5">
990 <p>SUBMIT Submits the given objects to an LTPDA repository</p>
991 </td>
992 <td bgcolor="#f3f4f5">
993 <p>ltpda_uo</p>
994 </td>
995 </tr>
996 <!-- ltpda_uo/update -->
997 <tr valign="top">
998 <td>
999 <p><a href="matlab:doc('smodel/update')">update</a></p>
1000 </td>
1001 <td>
1002 <p>UPDATE Updates the given object in an LTPDA repository</p>
1003 </td>
1004 <td>
1005 <p>ltpda_uo</p>
1006 </td>
1007 </tr>
1008 <!-- ltpda_uoh/string -->
1009 <tr valign="top">
1010 <td bgcolor="#f3f4f5">
1011 <p><a href="matlab:doc('smodel/string')">string</a></p>
1012 </td>
1013 <td bgcolor="#f3f4f5">
1014 <p>STRING writes a command string that can be used to recreate the input object(s).</p>
1015 </td>
1016 <td bgcolor="#f3f4f5">
1017 <p>ltpda_uoh</p>
1018 </td>
1019 </tr>
1020 <!-- ltpda_uoh/type -->
1021 <tr valign="top">
1022 <td>
1023 <p><a href="matlab:doc('smodel/type')">type</a></p>
1024 </td>
1025 <td>
1026 <p>TYPE converts the input objects to MATLAB functions.</p>
1027 </td>
1028 <td>
1029 <p>ltpda_uoh</p>
1030 </td>
1031 </tr>
1032 <!-- smodel/generateConstructorPlist -->
1033 <tr valign="top">
1034 <td bgcolor="#f3f4f5">
1035 <p><a href="matlab:doc('smodel/generateConstructorPlist')">generateConstructorPlist</a></p>
1036 </td>
1037 <td bgcolor="#f3f4f5">
1038 <p>GENERATECONSTRUCTORPLIST generates a PLIST from the properties which can rebuild the object.</p>
1039 </td>
1040 <td bgcolor="#f3f4f5">
1041 <p>smodel</p>
1042 </td>
1043 </tr>
1044 </tbody>
1045 </table>
1046 <!-- ===== Back to Top of Methods ===== -->
1047 <a href="#top_methods">
1048 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
1049 Back to Top of Section
1050 </a>
1051
1052 </p>
1053
1054 <!-- ===== Methods Category: Operator ===== -->
1055 <h3 class="title"><a name="operator"/>Operator</h3>
1056 <p>
1057 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
1058 <colgroup>
1059 <col width="15%"/>
1060 <col width="73%"/>
1061 <col width="12%"/>
1062 </colgroup>
1063 <thead>
1064 <tr valign="top">
1065 <th class="categorylist">Methods</th>
1066 <th class="categorylist">Description</th>
1067 <th class="categorylist">Defined in class</th>
1068 </tr>
1069 </thead>
1070 <tbody>
1071 <!-- smodel/convol_integral -->
1072 <tr valign="top">
1073 <td bgcolor="#f3f4f5">
1074 <p><a href="matlab:doc('smodel/convol_integral')">convol_integral</a></p>
1075 </td>
1076 <td bgcolor="#f3f4f5">
1077 <p>CONVOL_INTEGRAL implements the convolution integral for smodel objects.</p>
1078 </td>
1079 <td bgcolor="#f3f4f5">
1080 <p>smodel</p>
1081 </td>
1082 </tr>
1083 <!-- smodel/det -->
1084 <tr valign="top">
1085 <td>
1086 <p><a href="matlab:doc('smodel/det')">det</a></p>
1087 </td>
1088 <td>
1089 <p>DET evaluates the determinant of smodel objects.</p>
1090 </td>
1091 <td>
1092 <p>smodel</p>
1093 </td>
1094 </tr>
1095 <!-- smodel/diff -->
1096 <tr valign="top">
1097 <td bgcolor="#f3f4f5">
1098 <p><a href="matlab:doc('smodel/diff')">diff</a></p>
1099 </td>
1100 <td bgcolor="#f3f4f5">
1101 <p>DIFF implements differentiation operator for smodel objects.</p>
1102 </td>
1103 <td bgcolor="#f3f4f5">
1104 <p>smodel</p>
1105 </td>
1106 </tr>
1107 <!-- smodel/fourier -->
1108 <tr valign="top">
1109 <td>
1110 <p><a href="matlab:doc('smodel/fourier')">fourier</a></p>
1111 </td>
1112 <td>
1113 <p>FOURIER implements continuous f-domain Fourier transform for smodel objects.</p>
1114 </td>
1115 <td>
1116 <p>smodel</p>
1117 </td>
1118 </tr>
1119 <!-- smodel/ifourier -->
1120 <tr valign="top">
1121 <td bgcolor="#f3f4f5">
1122 <p><a href="matlab:doc('smodel/ifourier')">ifourier</a></p>
1123 </td>
1124 <td bgcolor="#f3f4f5">
1125 <p>IFOURIER implements continuous f-domain inverse Fourier transform for smodel objects.</p>
1126 </td>
1127 <td bgcolor="#f3f4f5">
1128 <p>smodel</p>
1129 </td>
1130 </tr>
1131 <!-- smodel/ilaplace -->
1132 <tr valign="top">
1133 <td>
1134 <p><a href="matlab:doc('smodel/ilaplace')">ilaplace</a></p>
1135 </td>
1136 <td>
1137 <p>ILAPLACE implements continuous s-domain inverse Laplace transform for smodel objects.</p>
1138 </td>
1139 <td>
1140 <p>smodel</p>
1141 </td>
1142 </tr>
1143 <!-- smodel/inv -->
1144 <tr valign="top">
1145 <td bgcolor="#f3f4f5">
1146 <p><a href="matlab:doc('smodel/inv')">inv</a></p>
1147 </td>
1148 <td bgcolor="#f3f4f5">
1149 <p>INV evaluates the inverse of smodel objects.</p>
1150 </td>
1151 <td bgcolor="#f3f4f5">
1152 <p>smodel</p>
1153 </td>
1154 </tr>
1155 <!-- smodel/iztrans -->
1156 <tr valign="top">
1157 <td>
1158 <p><a href="matlab:doc('smodel/iztrans')">iztrans</a></p>
1159 </td>
1160 <td>
1161 <p>IZTRANS implements continuous z-domain inverse Z-transform for smodel objects.</p>
1162 </td>
1163 <td>
1164 <p>smodel</p>
1165 </td>
1166 </tr>
1167 <!-- smodel/laplace -->
1168 <tr valign="top">
1169 <td bgcolor="#f3f4f5">
1170 <p><a href="matlab:doc('smodel/laplace')">laplace</a></p>
1171 </td>
1172 <td bgcolor="#f3f4f5">
1173 <p>LAPLACE implements continuous s-domain Laplace transform for smodel objects.</p>
1174 </td>
1175 <td bgcolor="#f3f4f5">
1176 <p>smodel</p>
1177 </td>
1178 </tr>
1179 <!-- smodel/linearize -->
1180 <tr valign="top">
1181 <td>
1182 <p><a href="matlab:doc('smodel/linearize')">linearize</a></p>
1183 </td>
1184 <td>
1185 <p>LINEARIZE output the derivatives of the model relative to the parameters.</p>
1186 </td>
1187 <td>
1188 <p>smodel</p>
1189 </td>
1190 </tr>
1191 <!-- smodel/simplify -->
1192 <tr valign="top">
1193 <td bgcolor="#f3f4f5">
1194 <p><a href="matlab:doc('smodel/simplify')">simplify</a></p>
1195 </td>
1196 <td bgcolor="#f3f4f5">
1197 <p>SIMPLIFY implements simplify operator for smodel objects.</p>
1198 </td>
1199 <td bgcolor="#f3f4f5">
1200 <p>smodel</p>
1201 </td>
1202 </tr>
1203 <!-- smodel/sum -->
1204 <tr valign="top">
1205 <td>
1206 <p><a href="matlab:doc('smodel/sum')">sum</a></p>
1207 </td>
1208 <td>
1209 <p>SUM adds all the elements of smodel objects arrays.</p>
1210 </td>
1211 <td>
1212 <p>smodel</p>
1213 </td>
1214 </tr>
1215 <!-- smodel/ztrans -->
1216 <tr valign="top">
1217 <td bgcolor="#f3f4f5">
1218 <p><a href="matlab:doc('smodel/ztrans')">ztrans</a></p>
1219 </td>
1220 <td bgcolor="#f3f4f5">
1221 <p>ZTRANS implements continuous z-domain Z-transform for smodel objects.</p>
1222 </td>
1223 <td bgcolor="#f3f4f5">
1224 <p>smodel</p>
1225 </td>
1226 </tr>
1227 </tbody>
1228 </table>
1229 <!-- ===== Back to Top of Methods ===== -->
1230 <a href="#top_methods">
1231 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
1232 Back to Top of Section
1233 </a>
1234
1235 </p>
1236
1237 <!-- ===== Methods Category: Output ===== -->
1238 <h3 class="title"><a name="output"/>Output</h3>
1239 <p>
1240 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
1241 <colgroup>
1242 <col width="15%"/>
1243 <col width="73%"/>
1244 <col width="12%"/>
1245 </colgroup>
1246 <thead>
1247 <tr valign="top">
1248 <th class="categorylist">Methods</th>
1249 <th class="categorylist">Description</th>
1250 <th class="categorylist">Defined in class</th>
1251 </tr>
1252 </thead>
1253 <tbody>
1254 <!-- ltpda_uo/save -->
1255 <tr valign="top">
1256 <td bgcolor="#f3f4f5">
1257 <p><a href="matlab:doc('smodel/save')">save</a></p>
1258 </td>
1259 <td bgcolor="#f3f4f5">
1260 <p>SAVE overloads save operator for ltpda objects.</p>
1261 </td>
1262 <td bgcolor="#f3f4f5">
1263 <p>ltpda_uo</p>
1264 </td>
1265 </tr>
1266 <!-- ltpda_uoh/report -->
1267 <tr valign="top">
1268 <td>
1269 <p><a href="matlab:doc('smodel/report')">report</a></p>
1270 </td>
1271 <td>
1272 <p>REPORT generates an HTML report about the input objects.</p>
1273 </td>
1274 <td>
1275 <p>ltpda_uoh</p>
1276 </td>
1277 </tr>
1278 <!-- ltpda_uoh/viewHistory -->
1279 <tr valign="top">
1280 <td bgcolor="#f3f4f5">
1281 <p><a href="matlab:doc('smodel/viewHistory')">viewHistory</a></p>
1282 </td>
1283 <td bgcolor="#f3f4f5">
1284 <p>VIEWHISTORY Displays the history of an object as a dot-view or a MATLAB figure.</p>
1285 </td>
1286 <td bgcolor="#f3f4f5">
1287 <p>ltpda_uoh</p>
1288 </td>
1289 </tr>
1290 <!-- smodel/char -->
1291 <tr valign="top">
1292 <td>
1293 <p><a href="matlab:doc('smodel/char')">char</a></p>
1294 </td>
1295 <td>
1296 <p>CHAR convert a smodel object into a string.</p>
1297 </td>
1298 <td>
1299 <p>smodel</p>
1300 </td>
1301 </tr>
1302 <!-- smodel/display -->
1303 <tr valign="top">
1304 <td bgcolor="#f3f4f5">
1305 <p><a href="matlab:doc('smodel/display')">display</a></p>
1306 </td>
1307 <td bgcolor="#f3f4f5">
1308 <p>DISPLAY overloads display functionality for smodel objects.</p>
1309 </td>
1310 <td bgcolor="#f3f4f5">
1311 <p>smodel</p>
1312 </td>
1313 </tr>
1314 </tbody>
1315 </table>
1316 <!-- ===== Back to Top of Methods ===== -->
1317 <a href="#top_methods">
1318 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
1319 Back to Top of Section
1320 </a>
1321
1322 </p>
1323
1324 <!-- ===== Methods Category: Relational_Operator ===== -->
1325 <h3 class="title"><a name="relational_operator"/>Relational Operator</h3>
1326 <p>
1327 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
1328 <colgroup>
1329 <col width="15%"/>
1330 <col width="73%"/>
1331 <col width="12%"/>
1332 </colgroup>
1333 <thead>
1334 <tr valign="top">
1335 <th class="categorylist">Methods</th>
1336 <th class="categorylist">Description</th>
1337 <th class="categorylist">Defined in class</th>
1338 </tr>
1339 </thead>
1340 <tbody>
1341 <!-- ltpda_obj/eq -->
1342 <tr valign="top">
1343 <td bgcolor="#f3f4f5">
1344 <p><a href="matlab:doc('smodel/eq')">eq</a></p>
1345 </td>
1346 <td bgcolor="#f3f4f5">
1347 <p>EQ overloads the == operator for ltpda objects.</p>
1348 </td>
1349 <td bgcolor="#f3f4f5">
1350 <p>ltpda_obj</p>
1351 </td>
1352 </tr>
1353 <!-- ltpda_obj/ne -->
1354 <tr valign="top">
1355 <td>
1356 <p><a href="matlab:doc('smodel/ne')">ne</a></p>
1357 </td>
1358 <td>
1359 <p>NE overloads the ~= operator for ltpda objects.</p>
1360 </td>
1361 <td>
1362 <p>ltpda_obj</p>
1363 </td>
1364 </tr>
1365 </tbody>
1366 </table>
1367 <!-- ===== Back to Top of Methods ===== -->
1368 <a href="#top_methods">
1369 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
1370 Back to Top of Section
1371 </a>
1372
1373 </p>
1374
1375 <!-- ================================================== -->
1376 <!-- END CONTENT FILE -->
1377 <!-- ================================================== -->