Mercurial > hg > ltpda
diff m-toolbox/html_help/help/ug/class_desc_smodel.html @ 0:f0afece42f48
Import.
| author | Daniele Nicolodi <nicolodi@science.unitn.it> |
|---|---|
| date | Wed, 23 Nov 2011 19:22:13 +0100 |
| parents | |
| children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/m-toolbox/html_help/help/ug/class_desc_smodel.html Wed Nov 23 19:22:13 2011 +0100 @@ -0,0 +1,1442 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" + "http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd"> + +<html lang="en"> +<head> + <meta name="generator" content= + "HTML Tidy for Mac OS X (vers 1st December 2004), see www.w3.org"> + <meta http-equiv="Content-Type" content= + "text/html; charset=us-ascii"> + + <title>smodel Class (LTPDA Toolbox)</title> + <link rel="stylesheet" href="docstyle.css" type="text/css"> + <meta name="generator" content="DocBook XSL Stylesheets V1.52.2"> + <meta name="description" content= + "Presents an overview of the features, system requirements, and starting the toolbox."> + </head> + +<body> + <a name="top_of_page" id="top_of_page"></a> + + <p style="font-size:1px;"> </p> + + <table class="nav" summary="Navigation aid" border="0" width= + "100%" cellpadding="0" cellspacing="0"> + <tr> + <td valign="baseline"><b>LTPDA Toolbox</b></td><td><a href="../helptoc.html">contents</a></td> + + <td valign="baseline" align="right"><a href= + "class_desc_rational.html"><img src="b_prev.gif" border="0" align= + "bottom" alt="rational Class"></a> <a href= + "class_desc_ssm.html"><img src="b_next.gif" border="0" align= + "bottom" alt="ssm Class"></a></td> + </tr> + </table> + + <h1 class="title"><a name="f3-12899" id="f3-12899"></a>smodel Class</h1> + <hr> + + <p> + + <!-- ================================================== --> + <!-- BEGIN CONTENT FILE --> + <!-- ================================================== --> + <!-- ===== link box: Begin ===== --> + <p> + <table border="1" width="80%"> + <tr> + <td> + <table border="0" cellpadding="5" class="categorylist" width="100%"> + <colgroup> + <col width="37%"/> + <col width="63%"/> + </colgroup> + <tbody> + <tr valign="top"> + <td> + <a href="class_desc_smodel.html#top_properties">Properties</a> + </td> + <td>Properties of the class</td> + </tr> + <tr valign="top"> + <td> + <a href="class_desc_smodel.html#top_methods">Methods</a> + </td> + <td>All Methods of the class ordered by category.</td> + </tr> + <tr valign="top"> + <td> + <a href="constructor_examples_smodel.html">Examples</a> + </td> + <td>Some constructor examples</td> + </tr> + </tbody> + </table> + </td> + </tr> + </table> + </p> + <!-- ===== link box: End ====== --> + + <!-- ===== Back to Class descriptions ===== --> + <a href="class_desc_main.html"> + <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Class descriptions"/> + Back to Class descriptions + </a> + + <h2 class="title"><a name="top_properties"/>Properties</h2> + <p> + The LTPDA toolbox restrict access of the properties.<br></br> + The get access is 'public' and thus it is possible to get the values with the dot-command (similar to structures).<br></br> + <pre class="programlisting">For example:<br></br>val = obj.prop(2).prop;</pre> + The set access is 'protected' and thus it is only possible to assign a value to a property with a set-method. + <pre class="programlisting"> +For example: +obj2 = obj1.setName(<span class="string">'my name'</span>) <span class="comment">% This command creates a copy of obj1 (obj1 ~= obj2)</span> +obj.setName(<span class="string">'my name'</span>); <span class="comment">% This command applies to obj</span> </pre> + </p> + <!-- ===== Properties ===== --> + <p> + <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%"> + <colgroup> + <col width="15%"/> + <col width="73%"/> + <col width="12%"/> + </colgroup> + <thead> + <tr valign="top"> + <th class="categorylist">Properties</th> + <th class="categorylist">Description</th> + <th class="categorylist">Defined in class</th> + </tr> + </thead> + <tbody> + <!-- Property: 'expr' --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('smodel.expr')">expr</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>Expression of the model</p> + </td> + <td bgcolor="#f3f4f5"> + <p>smodel</p> + </td> + </tr> + <!-- Property: 'params' --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('smodel.params')">params</a></p> + </td> + <td> + <p>Parameters which are used in the model</p> + </td> + <td> + <p>smodel</p> + </td> + </tr> + <!-- Property: 'values' --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('smodel.values')">values</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>Default values for the parameters</p> + </td> + <td bgcolor="#f3f4f5"> + <p>smodel</p> + </td> + </tr> + <!-- Property: 'trans' --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('smodel.trans')">trans</a></p> + </td> + <td> + <p>Transformation strings mapping xvals in terms of xvar to X in the model</p> + </td> + <td> + <p>smodel</p> + </td> + </tr> + <!-- Property: 'aliasNames' --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('smodel.aliasNames')">aliasNames</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>{'v', 'H'};</p> + </td> + <td bgcolor="#f3f4f5"> + <p>smodel</p> + </td> + </tr> + <!-- Property: 'aliasValues' --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('smodel.aliasValues')">aliasValues</a></p> + </td> + <td> + <p>{'a*b', [1:20]};</p> + </td> + <td> + <p>smodel</p> + </td> + </tr> + <!-- Property: 'xvar' --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('smodel.xvar')">xvar</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>Cell-array with x-variable(s)</p> + </td> + <td bgcolor="#f3f4f5"> + <p>smodel</p> + </td> + </tr> + <!-- Property: 'xvals' --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('smodel.xvals')">xvals</a></p> + </td> + <td> + <p>Cell-array of double-values for the different x-variable(s)</p> + </td> + <td> + <p>smodel</p> + </td> + </tr> + <!-- Property: 'xunits' --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('smodel.xunits')">xunits</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>vector of units of the different x-axis</p> + </td> + <td bgcolor="#f3f4f5"> + <p>smodel</p> + </td> + </tr> + <!-- Property: 'yunits' --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('smodel.yunits')">yunits</a></p> + </td> + <td> + <p>units of the y-axis</p> + </td> + <td> + <p>smodel</p> + </td> + </tr> + <!-- Property: 'hist' --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('smodel.hist')">hist</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>history of the object (history object)</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- Property: 'procinfo' --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('smodel.procinfo')">procinfo</a></p> + </td> + <td> + <p>plist with additional information for an object.</p> + </td> + <td> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- Property: 'plotinfo' --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('smodel.plotinfo')">plotinfo</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>plist with the plot information</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- Property: 'name' --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('smodel.name')">name</a></p> + </td> + <td> + <p>name of the object</p> + </td> + <td> + <p>ltpda_uo</p> + </td> + </tr> + <!-- Property: 'description' --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('smodel.description')">description</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>description of the object</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ltpda_uo</p> + </td> + </tr> + <!-- Property: 'mdlfile' --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('smodel.mdlfile')">mdlfile</a></p> + </td> + <td> + <p>model xml file of the LTPDAworkbench</p> + </td> + <td> + <p>ltpda_uo</p> + </td> + </tr> + <!-- Property: 'UUID' --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('smodel.UUID')">UUID</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>Universally Unique Identifier of 128-bit</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ltpda_uo</p> + </td> + </tr> + </tbody> + </table> + </p> + + <!-- ===== Top of page ===== --> + <a href="#top_of_page"> + <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top"/> + Back to Top + </a> + + <h2 class="title"><a name="top_methods"/>Methods</h2> + <!-- ===== link box: Begin ===== --> + <p> + <table border="1" width="80%"> + <tr> + <td> + <table border="0" cellpadding="5" class="subcategorylist" width="100%"> + <colgroup> + <col width="37%"/> + <col width="63%"/> + </colgroup> + <tbody> + <tr valign="top"> + <td> + <a href="class_desc_smodel.html#arithmetic_operator">Arithmetic Operator</a> + </td> + <td>Arithmetic Operator</td> + </tr> + <tr valign="top"> + <td> + <a href="class_desc_smodel.html#constructor">Constructor</a> + </td> + <td>Constructor of this class</td> + </tr> + <tr valign="top"> + <td> + <a href="class_desc_smodel.html#helper">Helper</a> + </td> + <td>Helper methods only for internal usage</td> + </tr> + <tr valign="top"> + <td> + <a href="class_desc_smodel.html#internal">Internal</a> + </td> + <td>Internal methods only for internal usage</td> + </tr> + <tr valign="top"> + <td> + <a href="class_desc_smodel.html#operator">Operator</a> + </td> + <td>Operator methods</td> + </tr> + <tr valign="top"> + <td> + <a href="class_desc_smodel.html#output">Output</a> + </td> + <td>Output methods</td> + </tr> + <tr valign="top"> + <td> + <a href="class_desc_smodel.html#relational_operator">Relational Operator</a> + </td> + <td>Relational operator methods</td> + </tr> + </tbody> + </table> + </td> + </tr> + </table> + </p> + <!-- ===== link box: End ====== --> + + <!-- ===== Top of page ===== --> + <a href="#top_of_page"> + <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top"/> + Back to Top + </a> + + <!-- ===== Methods Category: Arithmetic_Operator ===== --> + <h3 class="title"><a name="arithmetic_operator"/>Arithmetic Operator</h3> + <p> + <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%"> + <colgroup> + <col width="15%"/> + <col width="73%"/> + <col width="12%"/> + </colgroup> + <thead> + <tr valign="top"> + <th class="categorylist">Methods</th> + <th class="categorylist">Description</th> + <th class="categorylist">Defined in class</th> + </tr> + </thead> + <tbody> + <!-- smodel/conj --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('smodel/conj')">conj</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>CONJ gives the complex conjugate of the input smodels</p> + </td> + <td bgcolor="#f3f4f5"> + <p>smodel</p> + </td> + </tr> + <!-- smodel/minus --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('smodel/minus')">minus</a></p> + </td> + <td> + <p>MINUS implements subtraction operator for smodel objects.</p> + </td> + <td> + <p>smodel</p> + </td> + </tr> + <!-- smodel/mrdivide --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('smodel/mrdivide')">mrdivide</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>MRDIVIDE implements mrdivide operator for smodel objects.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>smodel</p> + </td> + </tr> + <!-- smodel/mtimes --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('smodel/mtimes')">mtimes</a></p> + </td> + <td> + <p>MTIMES implements mtimes operator for smodel objects.</p> + </td> + <td> + <p>smodel</p> + </td> + </tr> + <!-- smodel/plus --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('smodel/plus')">plus</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>PLUS implements addition operator for smodel objects.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>smodel</p> + </td> + </tr> + <!-- smodel/rdivide --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('smodel/rdivide')">rdivide</a></p> + </td> + <td> + <p>RDIVIDE implements division operator for smodel objects.</p> + </td> + <td> + <p>smodel</p> + </td> + </tr> + <!-- smodel/times --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('smodel/times')">times</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>TIMES implements multiplication operator for smodel objects.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>smodel</p> + </td> + </tr> + </tbody> + </table> + <!-- ===== Back to Top of Methods ===== --> + <a href="#top_methods"> + <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/> + Back to Top of Section + </a> + + </p> + + <!-- ===== Methods Category: Constructor ===== --> + <h3 class="title"><a name="constructor"/>Constructor</h3> + <p> + <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%"> + <colgroup> + <col width="15%"/> + <col width="73%"/> + <col width="12%"/> + </colgroup> + <thead> + <tr valign="top"> + <th class="categorylist">Methods</th> + <th class="categorylist">Description</th> + <th class="categorylist">Defined in class</th> + </tr> + </thead> + <tbody> + <!-- ltpda_uoh/rebuild --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('smodel/rebuild')">rebuild</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>REBUILD rebuilds the input objects using the history.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- smodel/smodel --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('smodel')">smodel</a></p> + </td> + <td> + <p>SMODEL constructor for smodel class.</p> + </td> + <td> + <p>smodel</p> + </td> + </tr> + </tbody> + </table> + <!-- ===== Back to Top of Methods ===== --> + <a href="#top_methods"> + <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/> + Back to Top of Section + </a> + + </p> + + <!-- ===== Methods Category: Helper ===== --> + <h3 class="title"><a name="helper"/>Helper</h3> + <p> + <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%"> + <colgroup> + <col width="15%"/> + <col width="73%"/> + <col width="12%"/> + </colgroup> + <thead> + <tr valign="top"> + <th class="categorylist">Methods</th> + <th class="categorylist">Description</th> + <th class="categorylist">Defined in class</th> + </tr> + </thead> + <tbody> + <!-- ltpda_obj/get --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('smodel/get')">get</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>GET get a property of a object.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ltpda_obj</p> + </td> + </tr> + <!-- ltpda_uoh/created --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('smodel/created')">created</a></p> + </td> + <td> + <p>CREATED Returns a time object of the last modification.</p> + </td> + <td> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- ltpda_uoh/creator --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('smodel/creator')">creator</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>CREATOR Extract the creator(s) from the history.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- ltpda_uoh/csvexport --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('smodel/csvexport')">csvexport</a></p> + </td> + <td> + <p>CSVEXPORT Exports the data of an object to a csv file.</p> + </td> + <td> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- ltpda_uoh/index --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('smodel/index')">index</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>INDEX index into a 'ltpda_uoh' object array or matrix. This properly captures the history.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- ltpda_uoh/requirements --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('smodel/requirements')">requirements</a></p> + </td> + <td> + <p>REQUIREMENTS Returns a list of LTPDA extension requirements for a given object.</p> + </td> + <td> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- ltpda_uoh/setDescription --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('smodel/setDescription')">setDescription</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>SETDESCRIPTION sets the 'description' property of a ltpda_uoh object.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- ltpda_uoh/setMdlfile --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('smodel/setMdlfile')">setMdlfile</a></p> + </td> + <td> + <p>SETMDLFILE sets the 'mdlfile' property of a ltpda_uoh object.</p> + </td> + <td> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- ltpda_uoh/setName --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('smodel/setName')">setName</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>SETNAME Sets the property 'name' of an ltpda_uoh object.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- ltpda_uoh/setPlotinfo --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('smodel/setPlotinfo')">setPlotinfo</a></p> + </td> + <td> + <p>SETPLOTINFO sets the 'plotinfo' property of a ltpda_uoh object.</p> + </td> + <td> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- ltpda_uoh/setProcinfo --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('smodel/setProcinfo')">setProcinfo</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>SETPROCINFO sets the 'procinfo' property of a ltpda_uoh object.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- smodel/addAliases --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('smodel/addAliases')">addAliases</a></p> + </td> + <td> + <p>ADDALIASES Add the key-value pairs to the alias-names and alias-values</p> + </td> + <td> + <p>smodel</p> + </td> + </tr> + <!-- smodel/addParameters --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('smodel/addParameters')">addParameters</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>ADDPARAMETERS Add some parameters to the symbolic model (smodel) object</p> + </td> + <td bgcolor="#f3f4f5"> + <p>smodel</p> + </td> + </tr> + <!-- smodel/assignalias --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('smodel/assignalias')">assignalias</a></p> + </td> + <td> + <p>ASSIGNALIAS assign values to smodel alias</p> + </td> + <td> + <p>smodel</p> + </td> + </tr> + <!-- smodel/clearAliases --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('smodel/clearAliases')">clearAliases</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>CLEARALIASES Clear the aliases.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>smodel</p> + </td> + </tr> + <!-- smodel/double --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('smodel/double')">double</a></p> + </td> + <td> + <p>DOUBLE Returns the numeric result of the model.</p> + </td> + <td> + <p>smodel</p> + </td> + </tr> + <!-- smodel/eval --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('smodel/eval')">eval</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>EVAL evaluates the symbolic model and returns an AO containing the numeric data.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>smodel</p> + </td> + </tr> + <!-- smodel/fitfunc --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('smodel/fitfunc')">fitfunc</a></p> + </td> + <td> + <p>FITFUNC Returns a function handle which sets the 'values' and 'xvals' to a ltpda model.</p> + </td> + <td> + <p>smodel</p> + </td> + </tr> + <!-- smodel/hessian --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('smodel/hessian')">hessian</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>hessian compute the hessian matrix for a symbolic model.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>smodel</p> + </td> + </tr> + <!-- smodel/op --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('smodel/op')">op</a></p> + </td> + <td> + <p>OP Add a operation around the model expression</p> + </td> + <td> + <p>smodel</p> + </td> + </tr> + <!-- smodel/setAliasNames --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('smodel/setAliasNames')">setAliasNames</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>SETALIASNAMES Set the property 'aliasNames'</p> + </td> + <td bgcolor="#f3f4f5"> + <p>smodel</p> + </td> + </tr> + <!-- smodel/setAliasValues --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('smodel/setAliasValues')">setAliasValues</a></p> + </td> + <td> + <p>SETALIASVALUES Set the property 'aliasValues'</p> + </td> + <td> + <p>smodel</p> + </td> + </tr> + <!-- smodel/setAliases --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('smodel/setAliases')">setAliases</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>SETALIASES Set the key-value pairs to the alias-names and alias-values</p> + </td> + <td bgcolor="#f3f4f5"> + <p>smodel</p> + </td> + </tr> + <!-- smodel/setParameters --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('smodel/setParameters')">setParameters</a></p> + </td> + <td> + <p>SETPARAMETERS Set some parameters to the symbolic model (smodel) object</p> + </td> + <td> + <p>smodel</p> + </td> + </tr> + <!-- smodel/setParams --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('smodel/setParams')">setParams</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>SETPARAMS Set the property 'params' AND 'values'</p> + </td> + <td bgcolor="#f3f4f5"> + <p>smodel</p> + </td> + </tr> + <!-- smodel/setTrans --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('smodel/setTrans')">setTrans</a></p> + </td> + <td> + <p>SETTRANS sets the 'trans' property of the smodel object.</p> + </td> + <td> + <p>smodel</p> + </td> + </tr> + <!-- smodel/setValues --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('smodel/setValues')">setValues</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>SETVALUES Set the property 'values'</p> + </td> + <td bgcolor="#f3f4f5"> + <p>smodel</p> + </td> + </tr> + <!-- smodel/setXunits --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('smodel/setXunits')">setXunits</a></p> + </td> + <td> + <p>SETXUNITS sets the 'xunits' property of the smodel object.</p> + </td> + <td> + <p>smodel</p> + </td> + </tr> + <!-- smodel/setXvals --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('smodel/setXvals')">setXvals</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>SETXVALS sets the 'xvals' property of the smodel object.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>smodel</p> + </td> + </tr> + <!-- smodel/setXvar --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('smodel/setXvar')">setXvar</a></p> + </td> + <td> + <p>SETXVAR sets the 'xvar' property of the smodel object.</p> + </td> + <td> + <p>smodel</p> + </td> + </tr> + <!-- smodel/setYunits --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('smodel/setYunits')">setYunits</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>SETYUNITS sets the 'yunits' property of the smodel object.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>smodel</p> + </td> + </tr> + <!-- smodel/simplifyUnits --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('smodel/simplifyUnits')">simplifyUnits</a></p> + </td> + <td> + <p>SIMPLIFYUNITS simplify the x and/or y units of the model.</p> + </td> + <td> + <p>smodel</p> + </td> + </tr> + <!-- smodel/subs --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('smodel/subs')">subs</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>SUBS substitutes symbolic parameters with the given values.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>smodel</p> + </td> + </tr> + </tbody> + </table> + <!-- ===== Back to Top of Methods ===== --> + <a href="#top_methods"> + <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/> + Back to Top of Section + </a> + + </p> + + <!-- ===== Methods Category: Internal ===== --> + <h3 class="title"><a name="internal"/>Internal</h3> + <p> + <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%"> + <colgroup> + <col width="15%"/> + <col width="73%"/> + <col width="12%"/> + </colgroup> + <thead> + <tr valign="top"> + <th class="categorylist">Methods</th> + <th class="categorylist">Description</th> + <th class="categorylist">Defined in class</th> + </tr> + </thead> + <tbody> + <!-- ltpda_obj/isprop --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('smodel/isprop')">isprop</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>ISPROP tests if the given field is one of the object properties.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ltpda_obj</p> + </td> + </tr> + <!-- ltpda_uo/bsubmit --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('smodel/bsubmit')">bsubmit</a></p> + </td> + <td> + <p>BSUBMIT Submits the given collection of objects in binary form to an LTPDA repository</p> + </td> + <td> + <p>ltpda_uo</p> + </td> + </tr> + <!-- ltpda_uo/submit --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('smodel/submit')">submit</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>SUBMIT Submits the given objects to an LTPDA repository</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ltpda_uo</p> + </td> + </tr> + <!-- ltpda_uo/update --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('smodel/update')">update</a></p> + </td> + <td> + <p>UPDATE Updates the given object in an LTPDA repository</p> + </td> + <td> + <p>ltpda_uo</p> + </td> + </tr> + <!-- ltpda_uoh/string --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('smodel/string')">string</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>STRING writes a command string that can be used to recreate the input object(s).</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- ltpda_uoh/type --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('smodel/type')">type</a></p> + </td> + <td> + <p>TYPE converts the input objects to MATLAB functions.</p> + </td> + <td> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- smodel/generateConstructorPlist --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('smodel/generateConstructorPlist')">generateConstructorPlist</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>GENERATECONSTRUCTORPLIST generates a PLIST from the properties which can rebuild the object.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>smodel</p> + </td> + </tr> + </tbody> + </table> + <!-- ===== Back to Top of Methods ===== --> + <a href="#top_methods"> + <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/> + Back to Top of Section + </a> + + </p> + + <!-- ===== Methods Category: Operator ===== --> + <h3 class="title"><a name="operator"/>Operator</h3> + <p> + <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%"> + <colgroup> + <col width="15%"/> + <col width="73%"/> + <col width="12%"/> + </colgroup> + <thead> + <tr valign="top"> + <th class="categorylist">Methods</th> + <th class="categorylist">Description</th> + <th class="categorylist">Defined in class</th> + </tr> + </thead> + <tbody> + <!-- smodel/convol_integral --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('smodel/convol_integral')">convol_integral</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>CONVOL_INTEGRAL implements the convolution integral for smodel objects.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>smodel</p> + </td> + </tr> + <!-- smodel/det --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('smodel/det')">det</a></p> + </td> + <td> + <p>DET evaluates the determinant of smodel objects.</p> + </td> + <td> + <p>smodel</p> + </td> + </tr> + <!-- smodel/diff --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('smodel/diff')">diff</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>DIFF implements differentiation operator for smodel objects.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>smodel</p> + </td> + </tr> + <!-- smodel/fourier --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('smodel/fourier')">fourier</a></p> + </td> + <td> + <p>FOURIER implements continuous f-domain Fourier transform for smodel objects.</p> + </td> + <td> + <p>smodel</p> + </td> + </tr> + <!-- smodel/ifourier --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('smodel/ifourier')">ifourier</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>IFOURIER implements continuous f-domain inverse Fourier transform for smodel objects.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>smodel</p> + </td> + </tr> + <!-- smodel/ilaplace --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('smodel/ilaplace')">ilaplace</a></p> + </td> + <td> + <p>ILAPLACE implements continuous s-domain inverse Laplace transform for smodel objects.</p> + </td> + <td> + <p>smodel</p> + </td> + </tr> + <!-- smodel/inv --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('smodel/inv')">inv</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>INV evaluates the inverse of smodel objects.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>smodel</p> + </td> + </tr> + <!-- smodel/iztrans --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('smodel/iztrans')">iztrans</a></p> + </td> + <td> + <p>IZTRANS implements continuous z-domain inverse Z-transform for smodel objects.</p> + </td> + <td> + <p>smodel</p> + </td> + </tr> + <!-- smodel/laplace --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('smodel/laplace')">laplace</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>LAPLACE implements continuous s-domain Laplace transform for smodel objects.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>smodel</p> + </td> + </tr> + <!-- smodel/linearize --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('smodel/linearize')">linearize</a></p> + </td> + <td> + <p>LINEARIZE output the derivatives of the model relative to the parameters.</p> + </td> + <td> + <p>smodel</p> + </td> + </tr> + <!-- smodel/simplify --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('smodel/simplify')">simplify</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>SIMPLIFY implements simplify operator for smodel objects.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>smodel</p> + </td> + </tr> + <!-- smodel/sum --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('smodel/sum')">sum</a></p> + </td> + <td> + <p>SUM adds all the elements of smodel objects arrays.</p> + </td> + <td> + <p>smodel</p> + </td> + </tr> + <!-- smodel/ztrans --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('smodel/ztrans')">ztrans</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>ZTRANS implements continuous z-domain Z-transform for smodel objects.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>smodel</p> + </td> + </tr> + </tbody> + </table> + <!-- ===== Back to Top of Methods ===== --> + <a href="#top_methods"> + <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/> + Back to Top of Section + </a> + + </p> + + <!-- ===== Methods Category: Output ===== --> + <h3 class="title"><a name="output"/>Output</h3> + <p> + <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%"> + <colgroup> + <col width="15%"/> + <col width="73%"/> + <col width="12%"/> + </colgroup> + <thead> + <tr valign="top"> + <th class="categorylist">Methods</th> + <th class="categorylist">Description</th> + <th class="categorylist">Defined in class</th> + </tr> + </thead> + <tbody> + <!-- ltpda_uo/save --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('smodel/save')">save</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>SAVE overloads save operator for ltpda objects.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ltpda_uo</p> + </td> + </tr> + <!-- ltpda_uoh/report --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('smodel/report')">report</a></p> + </td> + <td> + <p>REPORT generates an HTML report about the input objects.</p> + </td> + <td> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- ltpda_uoh/viewHistory --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('smodel/viewHistory')">viewHistory</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>VIEWHISTORY Displays the history of an object as a dot-view or a MATLAB figure.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- smodel/char --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('smodel/char')">char</a></p> + </td> + <td> + <p>CHAR convert a smodel object into a string.</p> + </td> + <td> + <p>smodel</p> + </td> + </tr> + <!-- smodel/display --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('smodel/display')">display</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>DISPLAY overloads display functionality for smodel objects.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>smodel</p> + </td> + </tr> + </tbody> + </table> + <!-- ===== Back to Top of Methods ===== --> + <a href="#top_methods"> + <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/> + Back to Top of Section + </a> + + </p> + + <!-- ===== Methods Category: Relational_Operator ===== --> + <h3 class="title"><a name="relational_operator"/>Relational Operator</h3> + <p> + <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%"> + <colgroup> + <col width="15%"/> + <col width="73%"/> + <col width="12%"/> + </colgroup> + <thead> + <tr valign="top"> + <th class="categorylist">Methods</th> + <th class="categorylist">Description</th> + <th class="categorylist">Defined in class</th> + </tr> + </thead> + <tbody> + <!-- ltpda_obj/eq --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('smodel/eq')">eq</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>EQ overloads the == operator for ltpda objects.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ltpda_obj</p> + </td> + </tr> + <!-- ltpda_obj/ne --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('smodel/ne')">ne</a></p> + </td> + <td> + <p>NE overloads the ~= operator for ltpda objects.</p> + </td> + <td> + <p>ltpda_obj</p> + </td> + </tr> + </tbody> + </table> + <!-- ===== Back to Top of Methods ===== --> + <a href="#top_methods"> + <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/> + Back to Top of Section + </a> + + </p> + + <!-- ================================================== --> + <!-- END CONTENT FILE --> + <!-- ================================================== --> + + </p> + + <br> + <br> + <table class="nav" summary="Navigation aid" border="0" width= + "100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td align="left" width="20"><a href="class_desc_rational.html"><img src= + "b_prev.gif" border="0" align="bottom" alt= + "rational Class"></a> </td> + + <td align="left">rational Class</td> + + <td> </td> + + <td align="right">ssm Class</td> + + <td align="right" width="20"><a href= + "class_desc_ssm.html"><img src="b_next.gif" border="0" align= + "bottom" alt="ssm Class"></a></td> + </tr> + </table><br> + + <p class="copy">©LTP Team</p> +</body> +</html>