← Back to branch summary

~ubuntu-branches/ubuntu/trusty/scilab/trusty

« back to all changes in this revision

Viewing changes to modules/api_scilab/help/en_US/low_level_functions/CallOverloadFunction.xml

  • Committer: Package Import Robot
  • Author(s): Sylvestre Ledru
  • Date: 2012-08-02 11:02:49 UTC
  • mfrom: (1.4.6)
  • Revision ID: package-import@ubuntu.com-20120802110249-0v5953emkp25geuz
Tags: 5.4.0-beta-2-1~exp1
* New upstream release
* Remove libscilab-java (remove upstream). Use libscilab2-java instead.

Show diffs side-by-side

added added

removed removed

Lines of Context:
modules/api_scilab/help/en_US/low_level_functions/CallOverloadFunction.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
2
2
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:html="http://www.w3.org/1999/xhtml" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:id="CallOverloadFunction">
3
 
    <refnamediv>
4
 
        <refname>CallOverloadFunction</refname>
5
 
        <refpurpose>
6
 
            a C gateway function uses to call overload function or macro
7
 
        </refpurpose>
8
 
    </refnamediv>
9
 
    <refsynopsisdiv>
10
 
        <title>Calling Sequence</title>
11
 
        <synopsis>CallOverloadFunction(_iVar)</synopsis>
12
 
    </refsynopsisdiv>
13
 
    <refsection>
14
 
        <title>Arguments</title>
15
 
        <variablelist>
16
 
            <varlistentry>
17
 
                <term>iVar</term>
18
 
                <listitem>
19
 
                    <para>
20
 
                        Specifies which input argument will be used to create
21
 
                        the name of overload function/macro
22
 
                    </para>
23
 
                </listitem>
24
 
            </varlistentry>
25
 
        </variablelist>
26
 
    </refsection>
27
 
    <refsection>
28
 
        <title>Description</title>
29
 
        <para>
30
 
            a C gateway function uses to call overload function or macro
31
 
        </para>
32
 
    </refsection>
33
 
    <refsection>
34
 
        <title>Examples</title>
35
 
        <para>This example returns the size:</para>
36
 
        <itemizedlist>
37
 
            <listitem>
38
 
                <para>returns the size of input argument</para>
39
 
            </listitem>
40
 
            <listitem>
41
 
                <para>if input argument is a string returns the length</para>
42
 
            </listitem>
43
 
        </itemizedlist>
44
 
    </refsection>
45
 
    <refsection>
46
 
        <!--File_gateway: SCI/modules/api_scilab/tests/unit_tests/calloverloadfunction_api.c-->
47
 
        <!--File_scilab: SCI/modules/api_scilab/tests/unit_tests/calloverloadfunction_api.tst-->
48
 
        <!--Lib_name: calloverloadfunction-->
49
 
        <!--Func_list: callOverload-->
50
 
        <title>Gateway Source</title>
51
 
        <programlisting role="code_gateway">
52
 
            <![CDATA[ 
 
3
  <refnamediv>
 
4
    <refname>CallOverloadFunction</refname>
 
5
    <refpurpose>
 
6
      a C gateway function uses to call overload function or macro
 
7
    </refpurpose>
 
8
  </refnamediv>
 
9
  <refsynopsisdiv>
 
10
    <title>Calling Sequence</title>
 
11
    <synopsis>CallOverloadFunction(_iVar)</synopsis>
 
12
  </refsynopsisdiv>
 
13
  <refsection>
 
14
    <title>Arguments</title>
 
15
    <variablelist>
 
16
      <varlistentry>
 
17
        <term>iVar</term>
 
18
        <listitem>
 
19
          <para>
 
20
            Specifies which input argument will be used to create
 
21
            the name of overload function/macro
 
22
          </para>
 
23
        </listitem>
 
24
      </varlistentry>
 
25
    </variablelist>
 
26
  </refsection>
 
27
  <refsection>
 
28
    <title>Description</title>
 
29
    <para>
 
30
      a C gateway function uses to call overload function or macro
 
31
    </para>
 
32
  </refsection>
 
33
  <refsection>
 
34
    <title>Examples</title>
 
35
    <para>This example returns the size:</para>
 
36
    <itemizedlist>
 
37
      <listitem>
 
38
        <para>returns the size of input argument</para>
 
39
      </listitem>
 
40
      <listitem>
 
41
        <para>if input argument is a string returns the length</para>
 
42
      </listitem>
 
43
    </itemizedlist>
 
44
  </refsection>
 
45
  <refsection>
 
46
    <!--File_gateway: SCI/modules/api_scilab/tests/unit_tests/calloverloadfunction_api.c-->
 
47
    <!--File_scilab: SCI/modules/api_scilab/tests/unit_tests/calloverloadfunction_api.tst-->
 
48
    <!--Lib_name: calloverloadfunction-->
 
49
    <!--Func_list: callOverload-->
 
50
    <title>Gateway Source</title>
 
51
    <programlisting role="code_gateway"><![CDATA[ 
53
52
int callOverload(char *fname,unsigned long fname_len)
54
53
{
55
54
    CheckRhs(1, 1);
58
57
    CallOverloadFunction(1);
59
58
    return 0;
60
59
}
61
 
 ]]>
62
 
        </programlisting>
63
 
    </refsection>
64
 
    <refsection>
65
 
        <title>Scilab test script</title>
66
 
        <programlisting role="code_scilab">
67
 
            <![CDATA[ 
 
60
 ]]></programlisting>
 
61
  </refsection>
 
62
  <refsection>
 
63
    <title>Scilab test script</title>
 
64
    <programlisting role="code_scilab"><![CDATA[ 
68
65
function x = %c_getSize(a)
69
66
    x = lenght(a);
70
67
endfunction
82
79
b_ref = [3,3,6;2,4,3];
83
80
assert_checkequal(getSize(b) == b_ref);
84
81
 
85
 
 ]]>
86
 
        </programlisting>
87
 
    </refsection>
 
82
 ]]></programlisting>
 
83
  </refsection>
88
84
</refentry>