1 //------------------------------------------------------------------------------
2 // GxB_Matrix_Option_get: get an option in a matrix
3 //------------------------------------------------------------------------------
4
5 // SuiteSparse:GraphBLAS, Timothy A. Davis, (c) 2017-2021, All Rights Reserved.
6 // SPDX-License-Identifier: Apache-2.0
7
8 //------------------------------------------------------------------------------
9
10 #include "GB.h"
11
GxB_Matrix_Option_get(GrB_Matrix A,GxB_Option_Field field,...)12 GrB_Info GxB_Matrix_Option_get // gets the current option of a matrix
13 (
14 GrB_Matrix A, // matrix to query
15 GxB_Option_Field field, // option to query
16 ... // return value of the matrix option
17 )
18 {
19
20 //--------------------------------------------------------------------------
21 // check inputs
22 //--------------------------------------------------------------------------
23
24 GB_WHERE1 ("GxB_Matrix_Option_get (A, field, &value)") ;
25 GB_RETURN_IF_NULL_OR_FAULTY (A) ;
26 ASSERT_MATRIX_OK (A, "A to get option", GB0) ;
27
28 //--------------------------------------------------------------------------
29 // get the option
30 //--------------------------------------------------------------------------
31
32 va_list ap ;
33
34 switch (field)
35 {
36
37 case GxB_HYPER_SWITCH :
38
39 {
40 va_start (ap, field) ;
41 double *hyper_switch = va_arg (ap, double *) ;
42 va_end (ap) ;
43 GB_RETURN_IF_NULL (hyper_switch) ;
44 (*hyper_switch) = (double) A->hyper_switch ;
45 }
46 break ;
47
48 case GxB_BITMAP_SWITCH :
49
50 {
51 va_start (ap, field) ;
52 double *bitmap_switch = va_arg (ap, double *) ;
53 va_end (ap) ;
54 GB_RETURN_IF_NULL (bitmap_switch) ;
55 (*bitmap_switch) = (double) A->bitmap_switch ;
56 }
57 break ;
58
59 case GxB_SPARSITY_CONTROL :
60
61 {
62 va_start (ap, field) ;
63 int *sparsity = va_arg (ap, int *) ;
64 va_end (ap) ;
65 GB_RETURN_IF_NULL (sparsity) ;
66 (*sparsity) = A->sparsity ;
67 }
68 break ;
69
70 case GxB_SPARSITY_STATUS :
71
72 {
73 va_start (ap, field) ;
74 int *sparsity = va_arg (ap, int *) ;
75 va_end (ap) ;
76 GB_RETURN_IF_NULL (sparsity) ;
77 (*sparsity) = GB_sparsity (A) ;
78 }
79 break ;
80
81 case GxB_FORMAT :
82
83 {
84 va_start (ap, field) ;
85 GxB_Format_Value *format = va_arg (ap, GxB_Format_Value *) ;
86 va_end (ap) ;
87 GB_RETURN_IF_NULL (format) ;
88 (*format) = (A->is_csc) ? GxB_BY_COL : GxB_BY_ROW ;
89 }
90 break ;
91
92 case GxB_IS_HYPER : // historical; use GxB_SPARSITY_STATUS instead
93
94 {
95 va_start (ap, field) ;
96 bool *A_is_hyper = va_arg (ap, bool *) ;
97 va_end (ap) ;
98 GB_RETURN_IF_NULL (A_is_hyper) ;
99 (*A_is_hyper) = (GB_sparsity (A) == GxB_HYPERSPARSE) ;
100 }
101 break ;
102
103 default :
104
105 return (GrB_INVALID_VALUE) ;
106 }
107 return (GrB_SUCCESS) ;
108 }
109
110