File: boolean.xml

package info (click to toggle)
scilab 5.2.2-9
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 334,832 kB
  • ctags: 52,586
  • sloc: xml: 526,945; ansic: 223,590; fortran: 163,080; java: 56,934; cpp: 33,840; tcl: 27,936; sh: 20,397; makefile: 9,908; ml: 9,451; perl: 1,323; cs: 614; lisp: 30
file content (73 lines) | stat: -rw-r--r-- 2,787 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
<?xml version="1.0" encoding="UTF-8"?>
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:lang="en" xml:id="boolean">
  <info>
    <pubdate>$LastChangedDate$</pubdate>
  </info>
  <refnamediv>
    <refname>boolean</refname>
    <refpurpose> Scilab Objects, boolean variables and operators &amp; | ~  </refpurpose>
  </refnamediv>
  <refsection>
    <title>Description</title>
    <para>
    A boolean variable is <literal>%T</literal> (for "true") or <literal>%F</literal> (for "false").
    These variables can be used to define matrices of booleans,
    with the usual syntax. Boolean matrices can be manipulated as ordinary
    matrices for elements extraction/insertion and concatenation. Note
    that  other usual operations  (<literal>+, *, -, ^,</literal> etc) are undefined
    for booleans matrices, three special operators are defined for boolean
    matrices:
  </para>
    <variablelist>
      <varlistentry>
        <term>~b</term>
        <listitem>
          <para>is the element wise negation of boolean <literal>b</literal> (matrix).</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>b1&amp;b2</term>
        <listitem>
          <para>is the element wise logical <literal>and</literal> of <literal>b1</literal> and <literal>b2</literal> (matrices).</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>b1|b2</term>
        <listitem>
          <para>is the  element wise logical <literal>or</literal> of <literal>b1</literal> and <literal>b2</literal> (matrices).</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>Boolean variables can be used for indexing matrices or vectors.</term>
        <listitem>
          <para>For instance <literal>a([%T,%F,%T],:)</literal> returns the submatrix  made of rows <literal>1</literal> and <literal>3</literal> of <literal>a</literal>. Boolean sparse matrices are supported.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsection>
  <refsection>
    <title>Examples</title>
    <programlisting role="example"><![CDATA[ 
[1,2]==[1,3]
[1,2]==1
a=1:5; a(a>2)
 ]]></programlisting>
  </refsection>
  <refsection>
    <title>See Also</title>
    <simplelist type="inline">
      <member>
        <link linkend="matrices">matrices</link>
      </member>
      <member>
        <link linkend="or">or</link>
      </member>
      <member>
        <link linkend="and">and</link>
      </member>
      <member>
        <link linkend="not">not</link>
      </member>
    </simplelist>
  </refsection>
</refentry>