← Back to branch summary

~ubuntu-branches/ubuntu/raring/scilab/raring-proposed

« back to all changes in this revision

Viewing changes to modules/development_tools/help/en_US/assert/assert_checkfalse.xml

  • Committer: Package Import Robot
  • Author(s): Sylvestre Ledru
  • Date: 2012-08-30 14:42:38 UTC
  • mfrom: (1.4.7)
  • Revision ID: package-import@ubuntu.com-20120830144238-c1y2og7dbm7m9nig
Tags: 5.4.0-beta-3-1~exp1
* New upstream release
* Update the scirenderer dep
* Get ride of libjhdf5-java dependency

Show diffs side-by-side

added added

removed removed

Lines of Context:
modules/development_tools/help/en_US/assert/assert_checkfalse.xml
12
12
 *
13
13
 -->
14
14
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:id="assert_checkfalse" xml:lang="en">
15
 
  <refnamediv>
16
 
    <refname>assert_checkfalse</refname>
17
 
    <refpurpose>Check that condition is false.</refpurpose>
18
 
  </refnamediv>
19
 
  <refsynopsisdiv>
20
 
    <title>Calling Sequence</title>
21
 
    <synopsis>
22
 
      flag = assert_checkfalse ( condition )
23
 
      flag = assert_checkfalse ( condition )
24
 
      [flag,errmsg] = assert_checkfalse ( condition )
25
 
      
26
 
    </synopsis>
27
 
  </refsynopsisdiv>
28
 
  <refsection>
29
 
    <title>Parameters</title>
30
 
    <variablelist>
31
 
      <varlistentry>
32
 
        <term>condition:</term>
33
 
        <listitem>
34
 
          <para> a matrix of booleans</para>
35
 
        </listitem>
36
 
      </varlistentry>
37
 
      <varlistentry>
38
 
        <term>flag :</term>
39
 
        <listitem>
40
 
          <para> a 1-by-1 matrix of boolean, %t if condition is false, %f if not</para>
41
 
        </listitem>
42
 
      </varlistentry>
43
 
      <varlistentry>
44
 
        <term>errmsg :</term>
45
 
        <listitem>
46
 
          <para> a 1-by-1 matrix of strings, the error message. If flag==%t, then errormsg=="". If flag==%f, then errmsg contains the error message.</para>
47
 
        </listitem>
48
 
      </varlistentry>
49
 
    </variablelist>
50
 
  </refsection>
51
 
  <refsection>
52
 
    <title>Description</title>
53
 
    <para>
54
 
      Performs silently if all entries in <literal>condition</literal> are false.
55
 
    </para>
56
 
    <para>
57
 
      Generates an error if any entry in <literal>condition</literal>
58
 
      is true.
59
 
      Generates an error if <literal>condition</literal> is not a boolean.
60
 
    </para>
61
 
    <para>
62
 
      If any entry in condition is true,
63
 
      <itemizedlist>
64
 
        <listitem>
65
 
          <para>if the errmsg output variable is not used, an error is generated,</para>
66
 
        </listitem>
67
 
        <listitem>
68
 
          <para>if the errmsg output variable is used, no error is generated.</para>
69
 
        </listitem>
70
 
      </itemizedlist>
71
 
    </para>
72
 
    <para>
73
 
    </para>
74
 
  </refsection>
75
 
  <refsection>
76
 
    <title>Examples</title>
77
 
    <programlisting role="example"><![CDATA[
 
15
    <refnamediv>
 
16
        <refname>assert_checkfalse</refname>
 
17
        <refpurpose>Check that condition is false.</refpurpose>
 
18
    </refnamediv>
 
19
    <refsynopsisdiv>
 
20
        <title>Calling Sequence</title>
 
21
        <synopsis>
 
22
            flag = assert_checkfalse ( condition )
 
23
            flag = assert_checkfalse ( condition )
 
24
            [flag,errmsg] = assert_checkfalse ( condition )
 
25
            
 
26
        </synopsis>
 
27
    </refsynopsisdiv>
 
28
    <refsection>
 
29
        <title>Parameters</title>
 
30
        <variablelist>
 
31
            <varlistentry>
 
32
                <term>condition:</term>
 
33
                <listitem>
 
34
                    <para> a matrix of booleans</para>
 
35
                </listitem>
 
36
            </varlistentry>
 
37
            <varlistentry>
 
38
                <term>flag :</term>
 
39
                <listitem>
 
40
                    <para> a 1-by-1 matrix of boolean, %t if condition is false, %f if not</para>
 
41
                </listitem>
 
42
            </varlistentry>
 
43
            <varlistentry>
 
44
                <term>errmsg :</term>
 
45
                <listitem>
 
46
                    <para> a 1-by-1 matrix of strings, the error message. If flag==%t, then errormsg=="". If flag==%f, then errmsg contains the error message.</para>
 
47
                </listitem>
 
48
            </varlistentry>
 
49
        </variablelist>
 
50
    </refsection>
 
51
    <refsection>
 
52
        <title>Description</title>
 
53
        <para>
 
54
            Performs silently if all entries in <literal>condition</literal> are false.
 
55
        </para>
 
56
        <para>
 
57
            Generates an error if any entry in <literal>condition</literal>
 
58
            is true.
 
59
            Generates an error if <literal>condition</literal> is not a boolean.
 
60
        </para>
 
61
        <para>
 
62
            If any entry in condition is true,
 
63
            <itemizedlist>
 
64
                <listitem>
 
65
                    <para>if the errmsg output variable is not used, an error is generated,</para>
 
66
                </listitem>
 
67
                <listitem>
 
68
                    <para>if the errmsg output variable is used, no error is generated.</para>
 
69
                </listitem>
 
70
            </itemizedlist>
 
71
        </para>
 
72
        <para>
 
73
        </para>
 
74
    </refsection>
 
75
    <refsection>
 
76
        <title>Examples</title>
 
77
        <programlisting role="example"><![CDATA[
78
78
// Tests which pass
79
79
assert_checkfalse ( %f );
80
80
flag = assert_checkfalse ( %f )
91
91
assert_checkfalse ( "a" )
92
92
 
93
93
   ]]></programlisting>
94
 
  </refsection>
95
 
  <refsection>
96
 
    <title>History</title>
97
 
    <revhistory>
98
 
      <revision>
99
 
        <revnumber>5.4.0</revnumber>
100
 
        <revdescription>Function introduced
101
 
        </revdescription>
102
 
      </revision>
103
 
    </revhistory>
104
 
  </refsection>
 
94
    </refsection>
 
95
    <refsection>
 
96
        <title>History</title>
 
97
        <revhistory>
 
98
            <revision>
 
99
                <revnumber>5.4.0</revnumber>
 
100
                <revdescription>Function introduced
 
101
                </revdescription>
 
102
            </revision>
 
103
        </revhistory>
 
104
    </refsection>
105
105
</refentry>