File: GrB_Descriptor_set.c

package info (click to toggle)
suitesparse 1%3A7.10.1%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 254,920 kB
  • sloc: ansic: 1,134,743; cpp: 46,133; makefile: 4,875; fortran: 2,087; java: 1,826; sh: 996; ruby: 725; python: 495; asm: 371; sed: 166; awk: 44
file content (319 lines) | stat: -rw-r--r-- 11,122 bytes parent folder | download | duplicates (2)
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
//------------------------------------------------------------------------------
// GrB_Descriptor_set*: set a field in a descriptor
//------------------------------------------------------------------------------

// SuiteSparse:GraphBLAS, Timothy A. Davis, (c) 2017-2025, All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0

//------------------------------------------------------------------------------

#include "get_set/GB_get_set.h"

//------------------------------------------------------------------------------
// GB_desc_set
//------------------------------------------------------------------------------

static GrB_Info GB_desc_set
(
    GrB_Descriptor desc,        // descriptor to modify
    int32_t value,              // value to change it to
    int field,
    GB_Werk Werk
)
{

    //--------------------------------------------------------------------------
    // set the parameter
    //--------------------------------------------------------------------------

    int mask = (int) desc->mask ;

    switch (field)
    {

        case GrB_OUTP :             // same as GrB_OUTP_FIELD

            if (! (value == GrB_DEFAULT || value == GrB_REPLACE))
            { 
                GB_ERROR (GrB_INVALID_VALUE,
                        "invalid descriptor value [%d] for GrB_OUTP field;\n"
                        "must be GrB_DEFAULT [%d] or GrB_REPLACE [%d]",
                        value, (int) GrB_DEFAULT, (int) GrB_REPLACE) ;
            }
            desc->out = (GrB_Desc_Value) value ;
            break ;

        case GrB_MASK :             // same as GrB_MASK_FIELD

            if (! (value == GrB_DEFAULT ||
                   value == GrB_COMP ||
                   value == GrB_STRUCTURE ||
                   value == (GrB_COMP + GrB_STRUCTURE)))
            { 
                GB_ERROR (GrB_INVALID_VALUE,
                        "invalid descriptor value [%d] for GrB_MASK field;\n"
                        "must be GrB_DEFAULT [%d], GrB_COMP [%d],\n"
                        "GrB_STRUCTURE [%d], or GrB_COMP+GrB_STRUCTURE [%d]",
                        value, (int) GrB_DEFAULT, (int) GrB_COMP,
                        (int) GrB_STRUCTURE,
                        (int) (GrB_COMP + GrB_STRUCTURE)) ;
            }
            switch (value)
            {
                case GrB_COMP      : mask |= GrB_COMP ;      break ;
                case GrB_STRUCTURE : mask |= GrB_STRUCTURE ; break ;
                default            : mask = value ;          break ;
            }
            desc->mask = (GrB_Desc_Value) mask ;
            break ;

        case GrB_INP0 :             // same as GrB_INP0_FIELD

            if (! (value == GrB_DEFAULT || value == GrB_TRAN))
            { 
                GB_ERROR (GrB_INVALID_VALUE,
                        "invalid descriptor value [%d] for GrB_INP0 field;\n"
                        "must be GrB_DEFAULT [%d] or GrB_TRAN [%d]",
                        value, (int) GrB_DEFAULT, (int) GrB_TRAN) ;
            }
            desc->in0 = (GrB_Desc_Value) value ;
            break ;

        case GrB_INP1 :             // same as GrB_INP1_FIELD

            if (! (value == GrB_DEFAULT || value == GrB_TRAN))
            { 
                GB_ERROR (GrB_INVALID_VALUE,
                        "invalid descriptor value [%d] for GrB_INP1 field;\n"
                        "must be GrB_DEFAULT [%d] or GrB_TRAN [%d]",
                        value, (int) GrB_DEFAULT, (int) GrB_TRAN) ;
            }
            desc->in1 = (GrB_Desc_Value) value ;
            break ;

        case GxB_AxB_METHOD : 

            if (! (value == GrB_DEFAULT  || value == GxB_AxB_GUSTAVSON
                || value == GxB_AxB_DOT
                || value == GxB_AxB_HASH || value == GxB_AxB_SAXPY))
            { 
                GB_ERROR (GrB_INVALID_VALUE,
                        "invalid descriptor value [%d] for GrB_AxB_METHOD"
                        " field;\nmust be GrB_DEFAULT [%d], GxB_AxB_GUSTAVSON"
                        " [%d]\nGxB_AxB_DOT [%d]"
                        " GxB_AxB_HASH [%d] or GxB_AxB_SAXPY [%d]",
                        value, (int) GrB_DEFAULT, (int) GxB_AxB_GUSTAVSON,
                        (int) GxB_AxB_DOT,
                        (int) GxB_AxB_HASH, (int) GxB_AxB_SAXPY) ;
            }
            desc->axb = (GrB_Desc_Value) value ;
            break ;

        case GxB_SORT : 

            desc->do_sort = value ;
            break ;

        case GxB_COMPRESSION : 

            desc->compression = value ;
            break ;

        case GxB_IMPORT : 

            // In case the user application does not check the return value
            // of this method, an error condition is never returned.
            desc->import =
                (value == GrB_DEFAULT) ? GxB_FAST_IMPORT : GxB_SECURE_IMPORT ;
            break ;

        case GxB_ROWINDEX_LIST : 

            if (! (value == GrB_DEFAULT  || value == GxB_USE_VALUES
                || value == GxB_USE_INDICES || value == GxB_IS_STRIDE))
            { 
                GB_ERROR (GrB_INVALID_VALUE,
                    "invalid descriptor value [%d] for GxB_ROWINDEX_LIST "
                    "field;\nmust be GrB_DEFAULT [%d], GxB_USE_VALUES [%d]\n"
                    "GxB_USE_INDICES [%d], or GxB_IS_STRIDE [%d]",
                    (int) value, (int) GrB_DEFAULT, (int) GxB_USE_VALUES,
                    (int) GxB_USE_INDICES, (int) GxB_IS_STRIDE) ;
            }
            desc->row_list = (int) value ;
            break ;

        case GxB_COLINDEX_LIST : 

            if (! (value == GrB_DEFAULT  || value == GxB_USE_VALUES
                || value == GxB_USE_INDICES || value == GxB_IS_STRIDE))
            { 
                GB_ERROR (GrB_INVALID_VALUE,
                    "invalid descriptor value [%d] for GxB_COLINDEX_LIST "
                    "field;\nmust be GrB_DEFAULT [%d], GxB_USE_VALUES [%d]\n"
                    "GxB_USE_INDICES [%d], or GxB_IS_STRIDE [%d]",
                    (int) value, (int) GrB_DEFAULT, (int) GxB_USE_VALUES,
                    (int) GxB_USE_INDICES, (int) GxB_IS_STRIDE) ;
            }
            desc->col_list = (int) value ;
            break ;

        case GxB_VALUE_LIST : 

            if (! (value == GrB_DEFAULT  || value == GxB_USE_VALUES
                || value == GxB_USE_INDICES))
            { 
                GB_ERROR (GrB_INVALID_VALUE,
                    "invalid descriptor value [%d] for GxB_VALUE_LIST "
                    "field;\nmust be GrB_DEFAULT [%d], GxB_USE_VALUES [%d]\n"
                    "or GxB_USE_INDICES [%d]",
                    (int) value, (int) GrB_DEFAULT, (int) GxB_USE_VALUES,
                    (int) GxB_USE_INDICES) ;
            }
            desc->val_list = (int) value ;
            break ;

        default : 
            return (GrB_INVALID_VALUE) ;
    }

    #pragma omp flush
    return (GrB_SUCCESS) ;
}

//------------------------------------------------------------------------------
// GrB_Descriptor_set_Scalar
//------------------------------------------------------------------------------

GrB_Info GrB_Descriptor_set_Scalar
(
    GrB_Descriptor desc,
    GrB_Scalar scalar,
    int field
)
{

    //--------------------------------------------------------------------------
    // check inputs
    //--------------------------------------------------------------------------

    if (desc == NULL || desc->header_size == 0)
    { 
        // built-in descriptors may not be modified
        return (GrB_INVALID_VALUE) ;
    }

    GrB_Info info ;
    GB_RETURN_IF_NULL_OR_INVALID (scalar) ;
    GB_WHERE_DESC (desc, "GrB_Descriptor_set_Scalar (desc, scalar, field)") ;

    ASSERT_DESCRIPTOR_OK (desc, "desc to set", GB0) ;

    //--------------------------------------------------------------------------
    // set the field
    //--------------------------------------------------------------------------

    int32_t i ;
    info = GrB_Scalar_extractElement_INT32 (&i, scalar) ;
    if (info != GrB_SUCCESS)
    { 
        return ((info == GrB_NO_VALUE) ? GrB_EMPTY_OBJECT : info) ;
    } 
    return (GB_desc_set (desc, i, field, Werk)) ;
}

//------------------------------------------------------------------------------
// GrB_Descriptor_set_String
//------------------------------------------------------------------------------

GrB_Info GrB_Descriptor_set_String
(
    GrB_Descriptor desc,
    char * value,
    int field
)
{ 

    //--------------------------------------------------------------------------
    // check inputs
    //--------------------------------------------------------------------------

    if (desc == NULL || desc->header_size == 0 || field != GrB_NAME)
    { 
        // built-in descriptors may not be modified
        return (GrB_INVALID_VALUE) ;
    }

    GB_RETURN_IF_NULL (value) ;
    GB_WHERE_DESC (desc, "GrB_Descriptor_set_String (desc, value, field)") ;

    ASSERT_DESCRIPTOR_OK (desc, "desc to set", GB0) ;

    //--------------------------------------------------------------------------
    // set the field
    //--------------------------------------------------------------------------

    return (GB_user_name_set (&(desc->user_name), &(desc->user_name_size),
        value, false)) ;
}

//------------------------------------------------------------------------------
// GrB_Descriptor_set_INT32
//------------------------------------------------------------------------------

GrB_Info GrB_Descriptor_set_INT32
(
    GrB_Descriptor desc,
    int32_t value,
    int field
)
{ 

    //--------------------------------------------------------------------------
    // check inputs
    //--------------------------------------------------------------------------

    if (desc == NULL || desc->header_size == 0)
    { 
        // built-in descriptors may not be modified
        return (GrB_INVALID_VALUE) ;
    }

    GB_WHERE_DESC (desc, "GrB_Descriptor_set_INT32 (desc, value, field)") ;
    ASSERT_DESCRIPTOR_OK (desc, "desc to set", GB0) ;

    //--------------------------------------------------------------------------
    // set the field
    //--------------------------------------------------------------------------

    return (GB_desc_set (desc, value, field, Werk)) ;
}

//------------------------------------------------------------------------------
// GrB_Descriptor_set_VOID
//------------------------------------------------------------------------------

GrB_Info GrB_Descriptor_set_VOID
(
    GrB_Descriptor desc,
    void * value,
    int field,
    size_t size
)
{ 
    return (GrB_INVALID_VALUE) ;
}

//------------------------------------------------------------------------------
// GrB_Descriptor_set: historical method
//------------------------------------------------------------------------------

GrB_Info GrB_Descriptor_set     // set a parameter in a descriptor
(
    GrB_Descriptor desc,        // descriptor to modify
    int field,                  // parameter to change
    int value                   // value to change it to
)
{ 
    return (GrB_Descriptor_set_INT32 (desc, value, field)) ;
}