← 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/bitwise/isequalbitwise.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/bitwise/isequalbitwise.xml
 
1
<?xml version="1.0" encoding="UTF-8"?>
 
2
<!--
 
3
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 
4
 * Copyright (C) 2008 - INRIA
 
5
 * 
 
6
 * This file must be used under the terms of the CeCILL.
 
7
 * This source file is licensed as described in the file COPYING, which
 
8
 * you should have received as part of this distribution.  The terms
 
9
 * are also available at    
 
10
 * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
 
11
 *
 
12
 -->
 
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="isequalbitwise" xml:lang="en">
 
14
    <refnamediv>
 
15
        <refname>isequalbitwise</refname>
 
16
        <refpurpose>bitwise comparison of variables</refpurpose>
 
17
    </refnamediv>
 
18
    <refsynopsisdiv>
 
19
        <title>Calling Sequence</title>
 
20
        <synopsis>t=isequalbitwise(a,b)
 
21
            t=isequalbitwise(a,b,..)
 
22
        </synopsis>
 
23
    </refsynopsisdiv>
 
24
    <refsection>
 
25
        <title>Arguments</title>
 
26
        <variablelist>
 
27
            <varlistentry>
 
28
                <term>a, b , ...</term>
 
29
                <listitem>
 
30
                    <para>variables of any types</para>
 
31
                </listitem>
 
32
            </varlistentry>
 
33
            <varlistentry>
 
34
                <term>t</term>
 
35
                <listitem>
 
36
                    <para>boolean</para>
 
37
                </listitem>
 
38
            </varlistentry>
 
39
        </variablelist>
 
40
    </refsection>
 
41
    <refsection>
 
42
        <title>Description</title>
 
43
        <para>
 
44
            <literal>isequalbitwise</literal> compares its arguments. If all of
 
45
            them are equal, then the function returns <literal>%t</literal> and in the other
 
46
            case it returns <literal>%f</literal>.
 
47
        </para>
 
48
        <para>
 
49
            When comparing list's, structures,... the comparison is made
 
50
            recursively, the order of the fields matters.
 
51
        </para>
 
52
        <para>
 
53
            Floating point data are compared bitwise, i.e. NaN values are not
 
54
            equal, double(1) and int32(1) are not equal. See <link linkend="isequal">isequal</link> for IEEE comparisons.
 
55
        </para>
 
56
    </refsection>
 
57
    <refsection>
 
58
        <title>Examples</title>
 
59
        <programlisting role="example"><![CDATA[ 
 
60
a=list(1:5,%s+1,'ABCDEFG');
 
61
isequalbitwise(a,a)
 
62
 ]]></programlisting>
 
63
    </refsection>
 
64
    <refsection role="see also">
 
65
        <title>See Also</title>
 
66
        <simplelist type="inline">
 
67
            <member>
 
68
                <link linkend="isequal">isequal</link>
 
69
            </member>
 
70
        </simplelist>
 
71
    </refsection>
 
72
</refentry>