summaryrefslogtreecommitdiff
path: root/modules/api_scilab/includes/api_boolean.h
blob: 488859fb8a89cd7d432f7759a39179dca29378cc (plain)
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
/*
 * 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 __BOOLEAN_API__
#define __BOOLEAN_API__

#if !defined(__INTERNAL_API_SCILAB__)
#error Do not include api_boolean.h. Include api_scilab.h instead.
#endif
#ifdef __cplusplus
extern "C" {
#endif

    /**
     * Get boolean variable
     * @param[in] _piAddress variable address
     * @param[out] _piRows return number of rows
     * @param[out] _piCols return number of columns
     * @param[out] _piBool return pointer to data
     * @return if the operation succeeded (0) or not ( !0 )
     */
    SciErr getMatrixOfBoolean(void* _pvCtx, int* _piAddress, int* _piRows, int* _piCols, int** _piBool);

    /**
     * Allocate boolean variable
     * @param[in] _iVar variable number
     * @param[in] _iRows number of rows
     * @param[in] _iCols number of columns
     * @param[out] _piBool return pointer to data
     * @return if the operation succeeded (0) or not ( !0 )
     */
    SciErr allocMatrixOfBoolean(void* _pvCtx, int _iVar, int _iRows, int _iCols, int** _piBool);

    /**
     * Create boolean variable
     * @param[in] _iVar variable number
     * @param[in] _iRows number of rows
     * @param[in] _iCols number of columns
     * @param[in] _piBool pointer to data
     * @return if the operation succeeded (0) or not ( !0 )
     */
    SciErr createMatrixOfBoolean(void* _pvCtx, int _iVar, int _iRows, int _iCols, const int* _piBool);

    /**
     * Create boolean named variable
     * @param[in] _pstName variable name
     * @param[in] _iRows number of rows
     * @param[in] _iCols number of columns
     * @param[in] _piBool pointer to data
     * @return if the operation succeeded (0) or not ( !0 )
     */
    SciErr createNamedMatrixOfBoolean(void* _pvCtx, const char* _pstName, int _iRows, int _iCols, const int* _piBool);

    /**
     * Read boolean named variable
     * @param[in] _pstName variable name
     * @param[out] _piRows return number of rows
     * @param[out] _piCols return number of columns
     * @param[out] _piBool return pointer to data
     * @return if the operation succeeded (0) or not ( !0 )
     */
    SciErr readNamedMatrixOfBoolean(void* _pvCtx, const char* _pstName, int* _piRows, int* _piCols, int* _piBool);

    /*shortcut functions*/

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

    /**
     * Check if the variable type is boolean
     * @param[in] _pstName variable name
     * @return 1 for true and 0 for false
     */
    int isNamedBooleanType(void* _pvCtx, const char* _pstName);

    /**
     * Get scalar boolean variable data
     * @param[in] _piAddress variable address
     * @param[out] _piBool return boolean value
     * @return if the operation succeeded (0) or not ( !0 )
     */
    int getScalarBoolean(void* _pvCtx, int* _piAddress, int* _piBool);

    /**
     * Get scalar boolean variable data
     * @param[in] _pstName variable name
     * @param[out] _piBool return boolean value
     * @return if the operation succeeded (0) or not ( !0 )
     */
    int getNamedScalarBoolean(void* _pvCtx, const char* _pstName, int* _piBool);

    /**
     * Create scalar boolean
     * @param[in] _iVar variable number
     * @param[in] _iBool value
     * @return if the operation succeeded (0) or not ( !0 )
     */
    int createScalarBoolean(void* _pvCtx, int _iVar, int _iBool);

    /**
     * Create named scalar double
     * @param[in] _pstName variable name
     * @param[in] _iBool value
     * @return if the operation succeeded (0) or not ( !0 )
     */
    int createNamedScalarBoolean(void* _pvCtx, const char* _pstName, int _iBool);


#ifdef __cplusplus
}
#endif
#endif /* __BOOLEAN_API__ */