/usr/include/scilab/api_sparse.h is in scilab-include 5.5.2-4+b1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 | /*
* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
* Copyright (C) 2009 - DIGITEO - Antoine ELIAS
*
* This file must be used under the terms of the CeCILL.
* This source file is licensed as described in the file COPYING, which
* you should have received as part of this distribution. The terms
* are also available at
* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
*/
#ifndef __SPARSE_API__
#define __SPARSE_API__
#if !defined(__INTERNAL_API_SCILAB__)
#error Do not include api_sparse.h. Include api_scilab.h instead.
#endif
#ifdef __cplusplus
extern "C" {
#endif
/*****************************/
/* sparse matrix functions */
/*****************************/
/**
* Get sparse variable data
* @param[in] _piAddress variable address
* @param[out] _piRows return number of rows
* @param[out] _piCols return number of columns
* @param[out] _piNbItem return number of items
* @param[out] _piNbItemRow return array of numbers of items for each row
* @param[out] _piColPos return array of item column positions ( 1 indexed )
* @param[out] _pdblReal return pointer to real data
* @return if the operation succeeded ( 0 ) or not ( !0 )
*/
SciErr getSparseMatrix(void* _pvCtx, int* _piAddress, int* _piRows, int* _piCols, int* _piNbItem, int** _piNbItemRow, int** _piColPos, double** _pdblReal);
/**
* Get complex sparse variable data
* @param[in] _piAddress variable address
* @param[out] _piRows return number of rows
* @param[out] _piCols return number of columns
* @param[out] _piNbItem number of items
* @param[out] _piNbItemRow return array of numbers of items for each row
* @param[out] _piColPos return array of item column positions ( 1 indexed )
* @param[out] _pdblReal return pointer to real parts
* @param[out] _pdblImg return pointer to imaginary parts
* @return if the operation succeeded ( 0 ) or not ( !0 )
*/
SciErr getComplexSparseMatrix(void* _pvCtx, int* _piAddress, int* _piRows, int* _piCols, int* _piNbItem, int** _piNbItemRow, int** _piColPos, double** _pdblReal, double** _pdblImg);
/**
* Allocate a sparse variable
* @param[in] _iVar variable number
* @param[in] _iRows number of rows
* @param[in] _iCols number of columns
* @param[in] _iNbItem number of items
* @param[out] _piNbItemRow return array of numbers of items for each row
* @param[out] _piColPos return array of item column position ( 1 indexed )
* @param[out] _pdblReal return pointer to data
* @return if the operation succeeded ( 0 ) or not ( !0 )
*/
SciErr allocSparseMatrix(void* _pvCtx, int _iVar, int _iRows, int _iCols, int _iNbItem, int** _piNbItemRow, int** _piColPos, double** _pdblReal);
/**
* Allocate a complex sparse variable
* @param[in] _iVar variable number
* @param[in] _iRows number of rows
* @param[in] _iCols number of columns
* @param[in] _iNbItem number of items
* @param[out] _piNbItemRow return array of numbers of items for each row
* @param[out] _piColPos return array of item column positions ( 1 indexed )
* @param[out] _pdblReal return pointer to real parts
* @param[out] _pdblImg return pointer to imaginary parts
* @return if the operation succeeded ( 0 ) or not ( !0 )
*/
SciErr allocComplexSparseMatrix(void* _pvCtx, int _iVar, int _iRows, int _iCols, int _iNbItem, int** _piNbItemRow, int** _piColPos, double** _pdblReal, double** _pdblImg);
/**
* Create a sparse double variable
* @param[in] _iVar variable number
* @param[in] _iRows nmber of rows
* @param[in] _iCols number of columns
* @param[in] _iNbItem number of items
* @param[in] _piNbItemRow array of numbers of items for each row
* @param[in] _piColPos array of item column positions ( 1 indexed )
* @param[in] _pdblReal pointer to real data
* @return if the operation succeeded ( 0 ) or not ( !0 )
*/
SciErr createSparseMatrix(void* _pvCtx, int _iVar, int _iRows, int _iCols, int _iNbItem, const int* _piNbItemRow, const int* _piColPos, const double* _pdblReal);
/**
* Create a complex sparse double variable
* @param[in] _iVar variable number
* @param[in] _iRows number of rows
* @param[in] _iCols number of columns
* @param[in] _iNbItem number of items
* @param[in] _piNbItemRow array of numbers of items for each row
* @param[in] _piColPos array of item column positions ( 1 indexed )
* @param[in] _pdblReal pointer to real parts
* @param[in] _pdblImg pointer to imaginary parts
* @return if the operation succeeded ( 0 ) or not ( !0 )
*/
SciErr createComplexSparseMatrix(void* _pvCtx, int _iVar, int _iRows, int _iCols, int _iNbItem, const int* _piNbItemRow, const int* _piColPos, const double* _pdblReal, const double* _pdblImg);
/**
* Create a named sparse double variable
* @param[in] _pstName variable name
* @param[in] _iRows number of rows
* @param[in] _iCols number of columns
* @param[in] _iNbItem number of items
* @param[in] _piNbItemRow array of numbers of items for each row
* @param[in] _piColPos array of item column positions ( 1 indexed )
* @param[in] _pdblReal pointer to real data
* @return if the operation succeeded ( 0 ) or not ( !0 )
*/
SciErr createNamedSparseMatrix(void* _pvCtx, const char* _pstName, int _iRows, int _iCols, int _iNbItem, const int* _piNbItemRow, const int* _piColPos, const double* _pdblReal);
/**
* Create a named complex sparse double variable
* @param[in] _pstName variable name
* @param[in] _iRows number of rows
* @param[in] _iCols number of columns
* @param[in] _iNbItem number of items
* @param[in] _piNbItemRow array of number of items for each row
* @param[in] _piColPos array of item column positions ( 1 indexed )
* @param[in] _pdblReal pointer to real parts
* @param[int] _pdblImg pointer to imaginary parts
* @return if the operation succeeded ( 0 ) or not ( !0 )
*/
SciErr createNamedComplexSparseMatrix(void* _pvCtx, const char* _pstName, int _iRows, int _iCols, int _iNbItem, const int* _piNbItemRow, const int* _piColPos, const double* _pdblReal, const double* _pdblImg);
/**
* Read named sparse double variable
* @param[in] _pstName variable name
* @param[out] _piRows return number of rows
* @param[out] _piCols return number of columns
* @param[out] _piNbItem return number of items
* @param[out] _piNbItemRow return array of numbers of items for each row
* @param[out] _piColPos return array of item column positions ( 1 indexed )
* @param[out] _pdblReal pointer to real data
* @return if the operation succeeded ( 0 ) or not ( !0 )
*/
SciErr readNamedSparseMatrix(void* _pvCtx, const char* _pstName, int* _piRows, int* _piCols, int* _piNbItem, int* _piNbItemRow, int* _piColPos, double* _pdblReal);
/**
* Read a named complex sparse double variable
* @param[in] _pstName variable name
* @param[out] _piRows return number of rows
* @param[out] _piCols return number of columns
* @param[out] _piNbItem return number of items
* @param[out] _piNbItemRow return array of number of items for each row
* @param[out] _piColPos return array of item column position ( 1 indexed )
* @param[out] _pdblReal pointer to real parts
* @param[out] _pdblImg pointer to imaginary parts
* @return if the operation succeeded ( 0 ) or not ( !0 )
*/
SciErr readNamedComplexSparseMatrix(void* _pvCtx, const char* _pstName, int* _piRows, int* _piCols, int* _piNbItem, int* _piNbItemRow, int* _piColPos, double* _pdblReal, double* _pdblImg);
/* shortcut functions */
/**
* Check if the variable type is sparse double
* @param[in] _piAddress variable address
* @return 1 for true and 0 for false
*/
int isSparseType(void* _pvCtx, int* _piAddress);
/**
* Check if the variable type is sparse double
* @param[in] _pstName variable name
* @return 1 for true and 0 for false
*/
int isNamedSparseType(void* _pvCtx, const char* _pstName);
/**
* Get sparse variable data
* @param[in] _piAddress variable address
* @param[out] _piRows return number of rows
* @param[out] _piCols return number of columns
* @param[out] _piNbItem return number of items
* @param[out] _piNbItemRow return array of numbers of items for each row
* @param[out] _piColPos return array of item column positions ( 1 indexed )
* @param[out] _pdblReal return pointer to real data
* @return if the operation succeeded ( 0 ) or not ( !0 )
*/
int getAllocatedSparseMatrix(void* _pvCtx, int* _piAddress, int* _piRows, int* _piCols, int* _piNbItem, int** _piNbItemRow, int** _piColPos, double** _pdblReal);
/**
* Get complex sparse variable data
* @param[in] _piAddress variable address
* @param[out] _piRows return number of rows
* @param[out] _piCols return number of columns
* @param[out] _piNbItem return number of items
* @param[out] _piNbItemRow return array of numbers of items for each row
* @param[out] _piColPos return array of item column positions ( 1 indexed )
* @param[out] _pdblReal return pointer to real parts
* @param[out] _pdblImg return pointer to imaginary parts
* @return if the operation succeeded ( 0 ) or not ( !0 )
*/
int getAllocatedComplexSparseMatrix(void* _pvCtx, int* _piAddress, int* _piRows, int* _piCols, int* _piNbItem, int** _piNbItemRow, int** _piColPos, double** _pdblReal, double** _pdblImg);
/**
* Get named sparse variable data
* @param[in] _pstName variable name
* @param[out] _piRows return number of rows
* @param[out] _piCols return number of columns
* @param[out] _piNbItem return number of items
* @param[out] _piNbItemRow return array of numbers of items for each row
* @param[out] _piColPos return array of item column positions ( 1 indexed )
* @param[out] _pdblReal return pointer to real data
* @return if the operation succeeded ( 0 ) or not ( !0 )
*/
int getNamedAllocatedSparseMatrix(void* _pvCtx, const char* _pstName, int* _piRows, int* _piCols, int* _piNbItem, int** _piNbItemRow, int** _piColPos, double** _pdblReal);
/**
* Get named complex sparse variable data
* @param[in] _pstName variable name
* @param[out] _piRows return number of rows
* @param[out] _piCols return number of columns
* @param[out] _piNbItem return number of items
* @param[out] _piNbItemRow return array of numbers of items for each row
* @param[out] _piColPos return array of item column position ( 1 indexed )
* @param[out] _pdblReal return pointer to real parts
* @param[out] _pdblImg return pointer to imaginary parts
* @return if the operation succeeded ( 0 ) or not ( !0 )
*/
int getNamedAllocatedComplexSparseMatrix(void* _pvCtx, const char* _pstName, int* _piRows, int* _piCols, int* _piNbItem, int** _piNbItemRow, int** _piColPos, double** _pdblReal, double** _pdblImg);
/**
* Free memory allocated for a sparse matrix (named or not) by shortcut functions
* @param[in] _piNbItemRow array of numbers of items for each row
* @param[in] _piColPos array of item column position ( 1 indexed )
* @param[in] _pdblReal pointer to real data
*/
void freeAllocatedSparseMatrix(int* _piNbItemRows, int* _piColPos, double* _pdblReal);
/**
* Free memory allocated for a complex sparse matrix (named or not) by shortcut functions
* @param[in] _piNbItemRow array of numbers of items for each row
* @param[in] _piColPos array of item column positions ( 1 indexed )
* @param[in] _pdblReal pointer to real parts
* @param[in] _pdblImg pointer to imaginary parts
*/
void freeAllocatedComplexSparseMatrix(int* _piNbItemRows, int* _piColPos, double* _pdblReal, double* _pdblImg);
#ifdef __cplusplus
}
#endif
#endif /* __SPARSE_API__ */
|