← Back to branch summary

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

« back to all changes in this revision

Viewing changes to modules/elementary_functions/help/en_US/or.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/elementary_functions/help/en_US/or.xml
11
11
 *
12
12
 -->
13
13
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="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="or" xml:lang="en">
14
 
  <refnamediv>
15
 
    <refname>or</refname>
16
 
    <refpurpose>logical OR of the elements of an array</refpurpose>
17
 
  </refnamediv>
18
 
  <refsynopsisdiv>
19
 
    <title>Calling Sequence</title>
20
 
    <synopsis>or(A), or(A,'*')
21
 
      or(A,'r'), or(A,1)
22
 
      
23
 
      or(A,'c'), or(A,2)
24
 
    </synopsis>
25
 
  </refsynopsisdiv>
26
 
  <refsection>
27
 
    <title>Description</title>
28
 
    <para>
29
 
      <literal>or(A)</literal> gives the <literal>or</literal> of the
30
 
      elements of the boolean matrix <literal>A</literal>.
31
 
      <literal>or(A)</literal> is true (<literal>%t</literal>) if at least one
32
 
      entry of <literal>A</literal> is <literal>%t</literal>.
33
 
    </para>
34
 
    <para>
35
 
      <literal>or([])</literal> returns <literal>%F</literal>.
36
 
    </para>
37
 
    <para>
38
 
      <literal>y=or(A,'r')</literal> (or, equivalently,
39
 
      <literal>y=or(A,1)</literal>) is the row-wise OR. It returns in each entry
40
 
      of the row vector <literal>y</literal> the OR of the rows of
41
 
      <literal>x</literal> (The OR is performed on the row index :
42
 
      <literal>y(j)= or(A(i,j),i=1,m)</literal>).
43
 
    </para>
44
 
    <para>
45
 
      <literal>y=or(A,'c')</literal> (or, equivalently,
46
 
      <literal>y=or(A,2)</literal>) is the column-wise OR. It returns in each
47
 
      entry of the column vector <literal>y</literal> the OR of the columns of
48
 
      <literal>x</literal> (The OR is performed on the column index:
49
 
      <literal>y(i)= or(A(i,j),j=1,n)</literal>)). 
50
 
    </para>
51
 
    <para/>
52
 
  </refsection>
53
 
  <refsection>
54
 
    <title>Examples</title>
55
 
    <programlisting role="example"><![CDATA[ 
 
14
    <refnamediv>
 
15
        <refname>or</refname>
 
16
        <refpurpose>logical OR of the elements of an array</refpurpose>
 
17
    </refnamediv>
 
18
    <refsynopsisdiv>
 
19
        <title>Calling Sequence</title>
 
20
        <synopsis>or(A), or(A,'*')
 
21
            or(A,'r'), or(A,1)
 
22
            
 
23
            or(A,'c'), or(A,2)
 
24
        </synopsis>
 
25
    </refsynopsisdiv>
 
26
    <refsection>
 
27
        <title>Description</title>
 
28
        <para>
 
29
            <literal>or(A)</literal> gives the <literal>or</literal> of the
 
30
            elements of the boolean matrix <literal>A</literal>.
 
31
            <literal>or(A)</literal> is true (<literal>%t</literal>) if at least one
 
32
            entry of <literal>A</literal> is <literal>%t</literal>.
 
33
        </para>
 
34
        <para>
 
35
            <literal>or([])</literal> returns <literal>%F</literal>.
 
36
        </para>
 
37
        <para>
 
38
            <literal>y=or(A,'r')</literal> (or, equivalently,
 
39
            <literal>y=or(A,1)</literal>) is the row-wise OR. It returns in each entry
 
40
            of the row vector <literal>y</literal> the OR of the rows of
 
41
            <literal>x</literal> (The OR is performed on the row index :
 
42
            <literal>y(j)= or(A(i,j),i=1,m)</literal>).
 
43
        </para>
 
44
        <para>
 
45
            <literal>y=or(A,'c')</literal> (or, equivalently,
 
46
            <literal>y=or(A,2)</literal>) is the column-wise OR. It returns in each
 
47
            entry of the column vector <literal>y</literal> the OR of the columns of
 
48
            <literal>x</literal> (The OR is performed on the column index:
 
49
            <literal>y(i)= or(A(i,j),j=1,n)</literal>)). 
 
50
        </para>
 
51
        <para/>
 
52
    </refsection>
 
53
    <refsection>
 
54
        <title>Examples</title>
 
55
        <programlisting role="example"><![CDATA[ 
56
56
or([%t %t %f])
57
57
 ]]></programlisting>
58
 
  </refsection>
59
 
  <refsection role="see also">
60
 
    <title>See Also</title>
61
 
    <simplelist type="inline">
62
 
      <member>
63
 
        <link linkend="or_op">or operator (|)</link>
64
 
      </member>
65
 
      <member>
66
 
        <link linkend="and">and</link>
67
 
      </member>
68
 
      <member>
69
 
        <link linkend="not">not</link>
70
 
      </member>
71
 
      <member>
72
 
        <link linkend="find">find</link>
73
 
      </member>
74
 
    </simplelist>
75
 
  </refsection>
 
58
    </refsection>
 
59
    <refsection role="see also">
 
60
        <title>See Also</title>
 
61
        <simplelist type="inline">
 
62
            <member>
 
63
                <link linkend="or_op">or operator (|)</link>
 
64
            </member>
 
65
            <member>
 
66
                <link linkend="and">and</link>
 
67
            </member>
 
68
            <member>
 
69
                <link linkend="not">not</link>
 
70
            </member>
 
71
            <member>
 
72
                <link linkend="find">find</link>
 
73
            </member>
 
74
        </simplelist>
 
75
    </refsection>
76
76
</refentry>