Mercurial > hg > massef

comparison help_html/source/help_MASSEF.m @ 15:bdd77fe783e4

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Updated MASSEF documentation with new properties and methods. Added documentation for doc method.
author Christopher Hummersone <c.hummersone@surrey.ac.uk>
date Tue, 07 Mar 2017 12:20:31 +0000
parents e34a535b9af0
children 8f36d7072f2f
comparison
equal deleted inserted replaced
14:aea77872f608 15:bdd77fe783e4
23 % <tr> 23 % <tr>
24 % <td><tt>blocksize</tt></td> 24 % <td><tt>blocksize</tt></td>
25 % <td>When using the parallel computing toolbox, this parameter determines 25 % <td>When using the parallel computing toolbox, this parameter determines
26 % the maximum number of <tt>parallel.FevalFuture</tt> objects that are 26 % the maximum number of <tt>parallel.FevalFuture</tt> objects that are
27 % considered at any one time. The default is 128.</td> 27 % considered at any one time. The default is 128.</td>
28 % </tr>
29 % <tr>
30 % <td><tt>creationDate</tt></td>
31 % <td>Date the object was created (read-only).</td>
28 % </tr> 32 % </tr>
29 % <tr> 33 % <tr>
30 % <td><tt>dir</tt></td> 34 % <td><tt>dir</tt></td>
31 % <td>The MASSEF installation directory (read-only).</td> 35 % <td>The MASSEF installation directory (read-only).</td>
32 % </tr> 36 % </tr>
57 % <td><tt>results_filename</tt></td> <td>The name of the results file 61 % <td><tt>results_filename</tt></td> <td>The name of the results file
58 % returned when <a 62 % returned when <a
59 % href="help_MASSEF_execute.html">MASSEF.execute</a> finishes. 63 % href="help_MASSEF_execute.html">MASSEF.execute</a> finishes.
60 % The default is <tt>'Results/results.mat'</tt>.</td> 64 % The default is <tt>'Results/results.mat'</tt>.</td>
61 % </tr> 65 % </tr>
66 % <tr>
67 % <td><tt>saveDate</tt></td>
68 % <td>Date the object was last saved (read-only).</td>
69 % </tr>
62 % </table> 70 % </table>
63 % </html> 71 % </html>
64 % 72 %
65 %% Methods 73 %% Methods
66 % 74 %
78 % </tr> 86 % </tr>
79 % <tr> 87 % <tr>
80 % <td><a href="help_MASSEF_execute.html">execute</a></td> 88 % <td><a href="help_MASSEF_execute.html">execute</a></td>
81 % <td>Run the framework using the input mixtures and separators.</td> 89 % <td>Run the framework using the input mixtures and separators.</td>
82 % </tr> 90 % </tr>
91 % <tr>
92 % <td><a href="help_MASSEF_save.html">save</a></td>
93 % <td>Save the framework's data and results.</td>
94 % </tr>
83 % </table> 95 % </table>
84 % </html> 96 % </html>
85 % 97 %
86 % Static methods: 98 % Static methods:
87 % 99 %
88 % <html> 100 % <html>
89 % <table> 101 % <table>
102 % <tr>
103 % <td><a href="help_MASSEF_doc.html">doc</a></td>
104 % <td>Display the framework documentation.</td>
90 % </tr> 105 % </tr>
91 % <tr> 106 % <tr>
92 % <td><a href="help_MASSEF_install.html">install</a></td> 107 % <td><a href="help_MASSEF_install.html">install</a></td>
93 % <td>Download and install MASSEF dependencies.</td> 108 % <td>Download and install MASSEF dependencies.</td>
94 % </tr> 109 % </tr>
95 % <tr> 110 % <tr>
96 % <td><a href="help_MASSEF_start.html">start</a></td> 111 % <td><a href="help_MASSEF_start.html">start</a></td>
97 % <td>Start the framework.</td> 112 % <td>Start the framework.</td>
113 % </tr>
98 % </table> 114 % </table>
99 % </html> 115 % </html>
100 % 116 %
101 %% See also 117 %% See also
102 % <help_MASSEFresults.html MASSEFresults>. 118 % <help_MASSEFresults.html MASSEFresults>.