latest update to documentation (a477512d) · Commits · Abdulrahman elgendy / tet

html/TT_ug_editing.m

+60 −8

Original line number	Diff line number	Diff line
		@@ -23,8 +23,33 @@
		% is changed the corresponding output boxes will update as well.
		%% Inputs
		% The input box labeled "Inputs" allows for the specification of inputs to
		% the table. There is no limit in the number of inputs supported.
		% the table. There is no limit in the number of inputs supported. Inputs
		% are specified in a comma delimited list. names of inputs must conform to
		% the matlab syntax conventions.
		%
		% Typing
		%
		% typing information can be specified for each input declared. this allows
		% for users to input dependant types. The format for typing follows that of
		% PVS, some examples:
		%
		% * \|x, y, z\| - 3 inputs with the default type
		% * \|x, y:bool\| - 2 inputs, y with specified type, x has the default
		% type.
		% * \|x:real, y:real, z:bool\| - 2 inputs of type real and one of type bool
		% * \|x:real, y:{t:real\|t>x}\| - 2 inputs of type real, y is dependant on x,
		% and is restricited to those value strictly greater than x
		%
		%% Expression Name
		% the expression name will be the name indentifying the block, it will also
		% be the function name for an generated matlab codes.
		%
		% Typing
		%
		% For single output tables, typing information for the output type of the
		% function can be specified in this textbox. formatting for the typing is
		% the same as that for inputs.
		%
		%% Conditions
		% Text input for a condition box must be valid embedded matlab code.
		% Expressions in condition boxes will be evaulated with the assumed type of
		@@ -33,13 +58,40 @@
		% condition box will be checked that it is of type boolean.
		%
		% For a table with multiple outputs, the horizontal condition boxes
		% represent different outputs. In the example below, the table has 2
		% different outputs labeled, out1 and out2. The syntax of the output specification
		% is the same as for the inputs; this allows for outputs to have
		% different types.
		%
		% <<ug_layout_3.png>>
		% represent different outputs, more detail about this in the output
		% section.
		%
		%% Outputs
		% jrweklr
		% The outputs of the function are specified in the Outputs grid. Outputs must be an expression that
		% will evaluate to a definite value. Each output specified should be the same type, however since
		% matlab is not strongly typed, almost every possible value will be interpreted as a compatible type.
		% The tool supports 2 output modes: single output and multiple output.
		%
		% The output mode can be specifed from the edit menu as seen in the
		% following figure:
		%
		% <<ug_layout_4.png>>
		%
		% Single Output
		%
		% For a single output table, the vertical grid can be used for another
		% dimension of conditons. Each output cell shall be a single expression
		% which will evaulate to the output under the interpreted conditions.
		%
		% Multiple Output
		%
		% For a table with multiple outputs, the horizontal condition grid is used
		% to specify the outputs of the table. The same rules for typing apply as noted in the
		% inputs and expression section of this documnet
		%
		% Each cell in the condition grid
		% specifies the name (and type) of an output. See the following figure for
		% an example. Each cell in the output grid specifies an output that
		% cooresponds to the output specified in the horizontal grid above it.
		%
		% In the example bellow
		% the table has 2
		% different outputs labeled, output1 and output2. the outputs have
		% different types, which allows for powerful function specification.
		%
		% <<ug_layout_5.png>>
		No newline at end of file

html/html/TT_ug_editing.html

+61 −10

Original line number	Diff line number	Diff line
		@@ -62,7 +62,7 @@ p.footer {
		color: gray;
		}

		</style></head><body><div class="content"><h1>Editing a Tabular Expression</h1><!--introduction--><p>The Tabular Expression Dialog allows users to graphically layout a tabular expression, for which conditions and outputs can be filled in using the embedded matlab subset of the Matlab languauge.</p><!--/introduction--><h2>Contents</h2><div><ul><li><a href="#1">Layout</a></li><li><a href="#2">Inputs</a></li><li><a href="#3">Expression Name</a></li><li><a href="#4">Conditions</a></li><li><a href="#5">Outputs</a></li><li><a href="#6">Output Mode</a></li></ul></div><h2>Layout<a name="1"></a></h2><p>The Dialog interface allows for the creation of 1-Dimensional vertical and horizontal tables, as well as 2-Dimensional tables. The tool supports multiple outputs for 1-Dimensional vertical tables.</p><p>The figure below shows an example 2-Dimensional Table with the Vertical Conditions, Horizontal Conditions, and Outputs notated.</p><p><img vspace="5" hspace="5" src="ug_layout_2.png" alt=""> </p><p>The "new" button will create an additional condition box for a particular grid. The "delete" button will remove the last condition box in a grid. For each condition in the vertical conditions, a subgrid can be created. To create a subgrid for a condition click on the "+" button next to the intended box.</p><p>Whenever the configuration of the vertical and horizontal conditions is changed the corresponding output boxes will update as well.</p><h2>Inputs<a name="2"></a></h2><p>The input box labeled "Inputs" allows for the specification of inputs to the table. There is no limit in the number of inputs supported.</p><h2>Expression Name<a name="3"></a></h2><h2>Conditions<a name="4"></a></h2><p>Text input for a condition box must be valid embedded matlab code. Expressions in condition boxes will be evaulated with the assumed type of boolean. Since embedded matlab is not typechecked this is a pottential cause of errors. By running pvs on a table, each expression in a condition box will be checked that it is of type boolean.</p><p>For a table with multiple outputs, the horizontal condition boxes represent different outputs. In the example below, the table has 2 different outputs labeled, out1 and out2. The syntax of the output specification is the same as for the inputs; this allows for outputs to have different types.</p><p><img vspace="5" hspace="5" src="ug_layout_3.png" alt=""> </p><h2>Outputs<a name="5"></a></h2><p>jrweklr</p><h2>Output Mode<a name="6"></a></h2><p class="footer"><br>
		</style></head><body><div class="content"><h1>Editing a Tabular Expression</h1><!--introduction--><p>The Tabular Expression Dialog allows users to graphically layout a tabular expression, for which conditions and outputs can be filled in using the embedded matlab subset of the Matlab languauge.</p><!--/introduction--><h2>Contents</h2><div><ul><li><a href="#1">Layout</a></li><li><a href="#2">Inputs</a></li><li><a href="#3">Expression Name</a></li><li><a href="#4">Conditions</a></li><li><a href="#5">Outputs</a></li></ul></div><h2>Layout<a name="1"></a></h2><p>The Dialog interface allows for the creation of 1-Dimensional vertical and horizontal tables, as well as 2-Dimensional tables. The tool supports multiple outputs for 1-Dimensional vertical tables.</p><p>The figure below shows an example 2-Dimensional Table with the Vertical Conditions, Horizontal Conditions, and Outputs notated.</p><p><img vspace="5" hspace="5" src="ug_layout_2.png" alt=""> </p><p>The "new" button will create an additional condition box for a particular grid. The "delete" button will remove the last condition box in a grid. For each condition in the vertical conditions, a subgrid can be created. To create a subgrid for a condition click on the "+" button next to the intended box.</p><p>Whenever the configuration of the vertical and horizontal conditions is changed the corresponding output boxes will update as well.</p><h2>Inputs<a name="2"></a></h2><p>The input box labeled "Inputs" allows for the specification of inputs to the table. There is no limit in the number of inputs supported. Inputs are specified in a comma delimited list. names of inputs must conform to the matlab syntax conventions.</p><p><b>Typing</b></p><p>typing information can be specified for each input declared. this allows for users to input dependant types. The format for typing follows that of PVS, some examples:</p><div><ul><li><tt>x, y, z</tt> - 3 inputs with the default type</li><li><tt>x, y:bool</tt> - 2 inputs, y with specified type, x has the default type.</li><li><tt>x:real, y:real, z:bool</tt> - 2 inputs of type real and one of type bool</li><li><tt>x:real, y:{t:real\|t>x}</tt> - 2 inputs of type real, y is dependant on x, and is restricited to those value strictly greater than x</li></ul></div><h2>Expression Name<a name="3"></a></h2><p>the expression name will be the name indentifying the block, it will also be the function name for an generated matlab codes.</p><p><b>Typing</b></p><p>For single output tables, typing information for the output type of the function can be specified in this textbox. formatting for the typing is the same as that for inputs.</p><h2>Conditions<a name="4"></a></h2><p>Text input for a condition box must be valid embedded matlab code. Expressions in condition boxes will be evaulated with the assumed type of boolean. Since embedded matlab is not typechecked this is a pottential cause of errors. By running pvs on a table, each expression in a condition box will be checked that it is of type boolean.</p><p>For a table with multiple outputs, the horizontal condition boxes represent different outputs, more detail about this in the output section.</p><h2>Outputs<a name="5"></a></h2><p>The outputs of the function are specified in the Outputs grid. Outputs must be an expression that will evaluate to a definite value. Each output specified should be the same type, however since matlab is not strongly typed, almost every possible value will be interpreted as a compatible type. The tool supports 2 output modes: single output and multiple output.</p><p>The output mode can be specifed from the edit menu as seen in the following figure:</p><p><img vspace="5" hspace="5" src="ug_layout_4.png" alt=""> </p><p><b>Single Output</b></p><p>For a single output table, the vertical grid can be used for another dimension of conditons. Each output cell shall be a single expression which will evaulate to the output under the interpreted conditions.</p><p><b>Multiple Output</b></p><p>For a table with multiple outputs, the horizontal condition grid is used to specify the outputs of the table. The same rules for typing apply as noted in the inputs and expression section of this documnet</p><p>Each cell in the condition grid specifies the name (and type) of an output. See the following figure for an example. Each cell in the output grid specifies an output that cooresponds to the output specified in the horizontal grid above it.</p><p>In the example bellow the table has 2 different outputs labeled, output1 and output2. the outputs have different types, which allows for powerful function specification.</p><p><img vspace="5" hspace="5" src="ug_layout_5.png" alt=""> </p><p class="footer"><br>
		Published with MATLAB® 7.10<br></p></div><!--
		##### SOURCE BEGIN #####
		%% Editing a Tabular Expression
		@@ -90,8 +90,33 @@ p.footer {
		% is changed the corresponding output boxes will update as well.
		%% Inputs
		% The input box labeled "Inputs" allows for the specification of inputs to
		% the table. There is no limit in the number of inputs supported.
		% the table. There is no limit in the number of inputs supported. Inputs
		% are specified in a comma delimited list. names of inputs must conform to
		% the matlab syntax conventions.
		%
		% Typing
		%
		% typing information can be specified for each input declared. this allows
		% for users to input dependant types. The format for typing follows that of
		% PVS, some examples:
		%
		% * \|x, y, z\| - 3 inputs with the default type
		% * \|x, y:bool\| - 2 inputs, y with specified type, x has the default
		% type.
		% * \|x:real, y:real, z:bool\| - 2 inputs of type real and one of type bool
		% * \|x:real, y:{t:real\|t>x}\| - 2 inputs of type real, y is dependant on x,
		% and is restricited to those value strictly greater than x
		%
		%% Expression Name
		% the expression name will be the name indentifying the block, it will also
		% be the function name for an generated matlab codes.
		%
		% Typing
		%
		% For single output tables, typing information for the output type of the
		% function can be specified in this textbox. formatting for the typing is
		% the same as that for inputs.
		%
		%% Conditions
		% Text input for a condition box must be valid embedded matlab code.
		% Expressions in condition boxes will be evaulated with the assumed type of
		@@ -100,16 +125,42 @@ p.footer {
		% condition box will be checked that it is of type boolean.
		%
		% For a table with multiple outputs, the horizontal condition boxes
		% represent different outputs. In the example below, the table has 2
		% different outputs labeled, out1 and out2. The syntax of the output specification
		% is the same as for the inputs; this allows for outputs to have
		% different types.
		%
		% <<ug_layout_3.png>>
		% represent different outputs, more detail about this in the output
		% section.
		%
		%% Outputs
		% jrweklr
		% The outputs of the function are specified in the Outputs grid. Outputs must be an expression that
		% will evaluate to a definite value. Each output specified should be the same type, however since
		% matlab is not strongly typed, almost every possible value will be interpreted as a compatible type.
		% The tool supports 2 output modes: single output and multiple output.
		%
		% The output mode can be specifed from the edit menu as seen in the
		% following figure:
		%
		% <<ug_layout_4.png>>
		%
		% Single Output
		%
		% For a single output table, the vertical grid can be used for another
		% dimension of conditons. Each output cell shall be a single expression
		% which will evaulate to the output under the interpreted conditions.
		%
		% Multiple Output
		%
		% For a table with multiple outputs, the horizontal condition grid is used
		% to specify the outputs of the table. The same rules for typing apply as noted in the
		% inputs and expression section of this documnet
		%
		% Each cell in the condition grid
		% specifies the name (and type) of an output. See the following figure for
		% an example. Each cell in the output grid specifies an output that
		% cooresponds to the output specified in the horizontal grid above it.
		%
		% In the example bellow
		% the table has 2
		% different outputs labeled, output1 and output2. the outputs have
		% different types, which allows for powerful function specification.
		%
		%%% Output Mode
		% <<ug_layout_5.png>>
		##### SOURCE END #####
		--></body></html>
		No newline at end of file

html/html/ug_layout_2.png

+201 B (72.5 KiB)

Loading image diff...

html/html/ug_layout_4.png

0 → 100644

+46.9 KiB

Loading image diff...

html/html/ug_layout_5.png

0 → 100644

+66.7 KiB

Loading image diff...