License Header change: Removed the LICENSE_END before beta
[scilab.git] / scilab / modules / api_scilab / help / en_US / legacy / sparse / C_getAllocatedComplexSparseMatrix.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) 2009  - DIGITEO - Antoine ELIAS
5  * 
6  * Copyright (C) 2012 - 2016 - Scilab Enterprises
7  *
8  * This file is hereby licensed under the terms of the GNU GPL v2.0,
9  * pursuant to article 5.3.4 of the CeCILL v.2.1.
10  * This file was originally licensed under the terms of the CeCILL v2.1,
11  * and continues to be available under such terms.
12  * For more information, see the COPYING file which you should have received
13  * along with this program.
14  *
15  -->
16 <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" xmlns:scilab="http://www.scilab.org" xml:id="getAllocatedComplexSparseMatrix" xml:lang="en">
17     <refnamediv>
18         <refname>getAllocatedComplexSparseMatrix</refname>
19         <refpurpose>
20             Get complex sparse matrix variable.
21         </refpurpose>
22     </refnamediv>
23     <refsynopsisdiv>
24         <title>Calling Sequence</title>
25         <synopsis>int getAllocatedComplexSparseMatrix(void* _pvCtx, int* _piAddress, int* _piRows, int* _piCols, int* _piNbItem, int** _piNbItemRow, int** _piColPos, double** _pdblReal, double** _pdblImg)</synopsis>
26         <synopsis>int getNamedAllocatedComplexSparseMatrix(void* _pvCtx, const char* _pstName, int* _piRows, int* _piCols, int* _piNbItem, int** _piNbItemRow, int** _piColPos, double** _pdblReal, double** _pdblImg)</synopsis>
27     </refsynopsisdiv>
28     <refsection>
29         <title>Arguments</title>
30         <variablelist>
31             <varlistentry>
32                 <term>_pvCtx</term>
33                 <listitem>
34                     <para>
35                         Scilab environment pointer, pass in "pvApiCtx" provided by api_scilab.h.
36                     </para>
37                 </listitem>
38             </varlistentry>
39             <varlistentry>
40                 <term>_piAddress</term>
41                 <listitem>
42                     <para>
43                         Address of the Scilab variable.
44                     </para>
45                 </listitem>
46             </varlistentry>
47             <varlistentry>
48                 <term>_pstName</term>
49                 <listitem>
50                     <para>
51                         Name of the variable for "named" functions.
52                     </para>
53                 </listitem>
54             </varlistentry>
55             <varlistentry>
56                 <term>_piRows</term>
57                 <listitem>
58                     <para>
59                         Return number of rows.
60                     </para>
61                 </listitem>
62             </varlistentry>
63             <varlistentry>
64                 <term>_piCols</term>
65                 <listitem>
66                     <para>
67                         Return number of columns.
68                     </para>
69                 </listitem>
70             </varlistentry>
71             <varlistentry>
72                 <term>_piNbItem</term>
73                 <listitem>
74                     <para>
75                         Return number of non zero value.
76                     </para>
77                 </listitem>
78             </varlistentry>
79             <varlistentry>
80                 <term>_piNbItemRow</term>
81                 <listitem>
82                     <para>
83                         Return number of item in each rows.
84                     </para>
85                 </listitem>
86             </varlistentry>
87             <varlistentry>
88                 <term>_piColPos</term>
89                 <listitem>
90                     <para>
91                         Return column position for each item.
92                     </para>
93                 </listitem>
94             </varlistentry>
95             <varlistentry>
96                 <term>_pdblReal</term>
97                 <listitem>
98                     <para>
99                         Return address of real data array.
100                     </para>
101                 </listitem>
102             </varlistentry>
103             <varlistentry>
104                 <term>_pdblImg</term>
105                 <listitem>
106                     <para>
107                         Return address of imaginary data array (size: _iCols * _iRows)
108                     </para>
109                 </listitem>
110             </varlistentry>
111         </variablelist>
112     </refsection>
113     <refsection>
114         <title>Return value</title>
115         <para>if successful 0, otherwise print error(s) message(s) in the Scilab console and returns first error number.</para>
116     </refsection>
117 </refentry>