This file is indexed.

/usr/include/scilab/api_hypermat.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
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
/*
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) 2013 - Scilab Enterprises - Calixte DENIZET
 *
 * 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 __HYPERMAT_API__
#define __HYPERMAT_API__

#if !defined(__INTERNAL_API_SCILAB__)
#error Do not include api_hypermat.h. Include api_scilab.h instead.
#endif

#ifdef __cplusplus
extern "C" {
#endif

#include "doublecomplex.h"

    /**************************************/
    /*   Hypermatrices matrix functions   */
    /**************************************/

    /**
     * Check if the variable type is double
     * @param[in] _piAddress variable address
     * @return 1 for true and 0 for false
     */
    int isHypermatType(void* _pvCtx, int* _piAddress);

    /**
     * Check if the variable is complex
     * @param[in] _piAddress variable address
     * @return 1 for true and 0 for false
     */
    int isHypermatComplex(void* _pvCtx, int* _piAddress);

    /**
     * Get the base type
     * @param[in] _piAddress variable address
     * @param[out] _piType return the base type
     */
    SciErr getHypermatType(void *_pvCtx, int *_piAddress, int *_piType);

    /**
     * Get integer precision ( SCI_xINTx )
     * @param[in] _piAddress variable address
     * @param[out] _piPrecison return integer precision ( SCI_xINTx )
     */
    SciErr getHypermatOfIntegerPrecision(void *_pvCtx, int *_piAddress, int *_piPrecision);

    /**
     * Get the hypermatrix dimensions
     * @param[in] _piAddress variable address
     * @param[out] _dims return the dimensions
     * @param[out] _ndims return the number of dimensions
     */
    SciErr getHypermatDimensions(void *_pvCtx, int *_piAddress, int **_dims, int *_ndims);

    /**
     * Get the hypermatrix entries address
     * @param[in] _piAddress variable address
     * @param[out] return _piEntriesAddress entries address
     */
    SciErr getHypermatEntries(void* _pvCtx, int* _piAddress, int ** _piEntriesAddress);

    /**
     * Get polynomial variable name
     * @param[in] _piAddress variable address
     * @param[out] _pstVarName return variable name of polynomials
     * @param[out] _piVarNameLen return length of _pstVarName
     * @return if the operation succeeded ( 0 ) or not ( !0 )
     */
    SciErr getHypermatPolyVariableName(void* _pvCtx, int* _piAddress, char* _pstVarName, int* _piVarNameLen);

    /**
     * Get the hypermatrix dimensions and data
     * @param[in] _piAddress variable address
     * @param[out] _dims return the dimensions
     * @param[out] _ndims return the number of dimensions
     * @param[out] _piNbCoef return number of polynomial coefficients for each element
     * @param[out] _pdblReal return real coefficients
     */
    SciErr getHypermatOfPoly(void* _pvCtx, int* _piAddress, int **_dims, int *_ndims, int* _piNbCoef, double** _pdblReal);

    /**
     * Get the hypermatrix dimensions and data
     * @param[in] _piAddress variable address
     * @param[out] _dims return the dimensions
     * @param[out] _ndims return the number of dimensions
     * @param[out] _piNbCoef return number of polynomial coefficients for each element
     * @param[out] _pdblReal return real coefficients
     * @param[out] _pdblImg return imaginary coefficients
     */
    SciErr getComplexHypermatOfPoly(void* _pvCtx, int* _piAddress, int **_dims, int *_ndims, int* _piNbCoef, double** _pdblReal, double** _pdblImg);

    /**
     * Get the hypermatrix dimensions and data
     * @param[in] _piAddress variable address
     * @param[out] _dims return the dimensions
     * @param[out] _ndims return the number of dimensions
     * @param[out] _piLength return strings lengths
     * @param[out] _pstStrings return the strings data
     */
    SciErr getHypermatOfString(void* _pvCtx, int* _piAddress, int **_dims, int *_ndims, int* _piLength, char** _pstStrings);

    /**
     * Get the hypermatrix dimensions and data
     * @param[in] _piAddress variable address
     * @param[out] _dims return the dimensions
     * @param[out] _ndims return the number of dimensions
     * @param[out] _piLength return strings lengths
     * @param[out] _pwstStrings return the strings data
     */
    SciErr getHypermatOfWideString(void* _pvCtx, int* _piAddress, int **_dims, int *_ndims, int* _piLength, wchar_t** _pwstStrings);

    /**
     * Get the hypermatrix dimensions and data
     * @param[in] _piAddress variable address
     * @param[out] _dims return the dimensions
     * @param[out] _ndims return the number of dimensions
     * @param[out] _pdblReal return the double data
     */
    SciErr getHypermatOfDouble(void* _pvCtx, int* _piAddress, int **_dims, int *_ndims, double** _pdblReal);

    /**
     * Get the hypermatrix dimensions and data
     * @param[in] _piAddress variable address
     * @param[out] _dims return the dimensions
     * @param[out] _ndims return the number of dimensions
     * @param[out] _pdblReal return the real data
     * @param[out] _pdblImg return the imaginary data
     */
    SciErr getComplexHypermatOfDouble(void* _pvCtx, int* _piAddress, int **_dims, int *_ndims, double** _pdblReal, double** _pdblImg);

    /**
     * Get the hypermatrix dimensions and data
     * @param[in] _piAddress variable address
     * @param[out] _dims return the dimensions
     * @param[out] _ndims return the number of dimensions
     * @param[out] _pucData8 return the unsigned char data
     */
    SciErr getHypermatOfUnsignedInteger8(void* _pvCtx, int* _piAddress, int **_dims, int *_ndims, unsigned char** _pucData8);

    /**
     * Get the hypermatrix dimensions and data
     * @param[in] _piAddress variable address
     * @param[out] _dims return the dimensions
     * @param[out] _ndims return the number of dimensions
     * @param[out] _pcData8 return the char data
     */
    SciErr getHypermatOfInteger8(void* _pvCtx, int* _piAddress, int **_dims, int *_ndims, char** _pcData8);

    /**
     * Get the hypermatrix dimensions and data
     * @param[in] _piAddress variable address
     * @param[out] _dims return the dimensions
     * @param[out] _ndims return the number of dimensions
     * @param[out] _pusData16 return the unsigned short data
     */
    SciErr getHypermatOfUnsignedInteger16(void* _pvCtx, int* _piAddress, int **_dims, int *_ndims, unsigned short** _pusData16);

    /**
     * Get the hypermatrix dimensions and data
     * @param[in] _piAddress variable address
     * @param[out] _dims return the dimensions
     * @param[out] _ndims return the number of dimensions
     * @param[out] _psData16 return the short data
     */
    SciErr getHypermatOfInteger16(void* _pvCtx, int* _piAddress, int **_dims, int *_ndims, short** _psData16);

    /**
     * Get the hypermatrix dimensions and data
     * @param[in] _piAddress variable address
     * @param[out] _dims return the dimensions
     * @param[out] _ndims return the number of dimensions
     * @param[out] _puiData32 return the unsigned int data
     */
    SciErr getHypermatOfUnsignedInteger32(void* _pvCtx, int* _piAddress, int **_dims, int *_ndims, unsigned int** _puiData32);

    /**
     * Get the hypermatrix dimensions and data
     * @param[in] _piAddress variable address
     * @param[out] _dims return the dimensions
     * @param[out] _ndims return the number of dimensions
     * @param[out] _piData32 return the int data
     */
    SciErr getHypermatOfInteger32(void* _pvCtx, int* _piAddress, int **_dims, int *_ndims, int** _piData32);

    /**
     * Get the hypermatrix dimensions and data
     * @param[in] _piAddress variable address
     * @param[out] _dims return the dimensions
     * @param[out] _ndims return the number of dimensions
     * @param[out] _piBool return the boolean data
     */
    SciErr getHypermatOfBoolean(void* _pvCtx, int* _piAddress, int **_dims, int *_ndims, int** _piBool);

    /**
     * Create a polynomial hypermatrix
     * @param[in] _iVar variable number
     * @param[in] _pstVarName polynomial variable name
     * @param[in] _dims the dimensions
     * @param[in] _ndims the number of dimensions
     * @param[in] _piNbCoef number of polynomial coefficients for each element
     * @param[in] _pdblReal pointer to real coefficients
     * @return if the operation succeeded ( 0 ) or not ( !0 )
     */
    SciErr createHypermatOfPoly(void* _pvCtx, int _iVar, char* _pstVarName, int *_dims, int _ndims, const int* _piNbCoef, const double* const* _pdblReal);

    /**
     * Create a complex polynomial hypermatrix
     * @param[in] _iVar variable number
     * @param[in] _pstVarName polynomial variable name
     * @param[in] _dims the dimensions
     * @param[in] _ndims the number of dimensions
     * @param[in] _piNbCoef number of polynomial coefficients for each element
     * @param[in] _pdblReal pointer to real coefficients
     * @param[in] _pdblImg pointer to imaginary coefficients
     * @return if the operation succeeded ( 0 ) or not ( !0 )
     */
    SciErr createComplexHypermatOfPoly(void* _pvCtx, int _iVar, char* _pstVarName, int *_dims, int _ndims, const int* _piNbCoef, const double* const* _pdblReal, const double* const* _pdblImg);

    /**
     * Create a double hypermatrix
     * @param[in] _iVar variable number
     * @param[in] _dims the dimensions
     * @param[in] _ndims the number of dimensions
     * @param[in] _pdblReal pointer to real data
     * @return if the operation succeeded ( 0 ) or not ( !0 )
     */
    SciErr createHypermatOfDouble(void* _pvCtx, int _iVar, int *_dims, int _ndims, const double* _pdblReal);
    SciErr allocHypermatOfDouble(void *_pvCtx, int _iVar, int * _dims, int _ndims, double** _pdblReal);

    /**
     * Create a complex hypermatrix
     * @param[in] _iVar variable number
     * @param[in] _dims the dimensions
     * @param[in] _ndims the number of dimensions
     * @param[in] _pdblReal pointer to real data
     * @return if the operation succeeded ( 0 ) or not ( !0 )
     */
    SciErr createComplexHypermatOfDouble(void* _pvCtx, int _iVar, int *_dims, int _ndims, const double* _pdblReal, const double* _pdblImg);

    /**
     * Create a boolean hypermatrix
     * @param[in] _iVar variable number
     * @param[in] _dims the dimensions
     * @param[in] _ndims the number of dimensions
     * @param[in] _piBool pointer to boolean data
     * @return if the operation succeeded ( 0 ) or not ( !0 )
     */
    SciErr createHypermatOfBoolean(void* _pvCtx, int _iVar, int *_dims, int _ndims, const int* _piBool);

    /**
     * Create a string hypermatrix
     * @param[in] _iVar variable number
     * @param[in] _dims the dimensions
     * @param[in] _ndims the number of dimensions
     * @param[in] _pstStrings pointer to string data
     * @return if the operation succeeded ( 0 ) or not ( !0 )
     */
    SciErr createHypermatOfString(void* _pvCtx, int _iVar, int *_dims, int _ndims, const char* const* _pstStrings);

    /**
     * Create a int8 hypermatrix
     * @param[in] _iVar variable number
     * @param[in] _dims the dimensions
     * @param[in] _ndims the number of dimensions
     * @param[in] _pcData8 pointer to char data
     * @return if the operation succeeded ( 0 ) or not ( !0 )
     */
    SciErr createHypermatOfInteger8(void* _pvCtx, int _iVar, int *_dims, int _ndims, const char* _pcData8);

    /**
     * Create a uint8 hypermatrix
     * @param[in] _iVar variable number
     * @param[in] _dims the dimensions
     * @param[in] _ndims the number of dimensions
     * @param[in] _pucData8 pointer to unsigned char data
     * @return if the operation succeeded ( 0 ) or not ( !0 )
     */
    SciErr createHypermatOfUnsignedInteger8(void* _pvCtx, int _iVar, int *_dims, int _ndims, const unsigned char* _pucData8);

    /**
     * Create a int16 hypermatrix
     * @param[in] _iVar variable number
     * @param[in] _dims the dimensions
     * @param[in] _ndims the number of dimensions
     * @param[in] _psData16 pointer to short data
     * @return if the operation succeeded ( 0 ) or not ( !0 )
     */
    SciErr createHypermatOfInteger16(void* _pvCtx, int _iVar, int *_dims, int _ndims, const short* _psData16);

    /**
     * Create a uint16 hypermatrix
     * @param[in] _iVar variable number
     * @param[in] _dims the dimensions
     * @param[in] _ndims the number of dimensions
     * @param[in] _pusData16 pointer to unsigned short data
     * @return if the operation succeeded ( 0 ) or not ( !0 )
     */
    SciErr createHypermatOfUnsignedInteger16(void* _pvCtx, int _iVar, int *_dims, int _ndims, const unsigned short* _pusData16);

    /**
     * Create a int32 hypermatrix
     * @param[in] _iVar variable number
     * @param[in] _dims the dimensions
     * @param[in] _ndims the number of dimensions
     * @param[in] _piData32 pointer to int data
     * @return if the operation succeeded ( 0 ) or not ( !0 )
     */
    SciErr createHypermatOfInteger32(void* _pvCtx, int _iVar, int *_dims, int _ndims, const int* _piData32);

    /**
     * Create a uint32 hypermatrix
     * @param[in] _iVar variable number
     * @param[in] _dims the dimensions
     * @param[in] _ndims the number of dimensions
     * @param[in] _puiData32 pointer to unsigned int data
     * @return if the operation succeeded ( 0 ) or not ( !0 )
     */
    SciErr createHypermatOfUnsignedInteger32(void* _pvCtx, int _iVar, int *_dims, int _ndims, const unsigned int* _puiData32);

#ifdef __cplusplus
}
#endif
#endif /* __HYPERMAT_API__ */