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
|
function descriptorinfo (d)
%GRB.DESCRIPTOR list the contents of a SuiteSparse:GraphBLAS descriptor.
%
% GrB.descriptorinfo
% GrB.descriptorinfo (d)
%
% The GraphBLAS descriptor is a struct that modifies the behavior
% of GraphBLAS operations. It contains the following components, each of
% which are a string or a number. Any component of struct that is not
% present is set to the default value. If the descriptor d is empty, or
% not present, in a GraphBLAS function, all default settings are used.
%
% The following descriptor values are strings:
%
% d.out 'default' or 'replace' determines if C is cleared before
% the accum/mask step
%
% d.mask 'default' use M as the mask (if present)
% 'complement' use ~M as the mask
% 'structural' or 'structure' use the pattern of M
% 'structural complement' use the pattern of ~M
%
% d.in0 'default' or 'transpose' determines A or A.' is used
% d.in1 'default' or 'transpose' determines B or B.' is used
%
% d.axb 'default', 'saxpy', 'dot', 'Gustavson', or 'hash'. Determines
% the method used in GrB.mxm. The default is to let GraphBLAS
% determine the method automatically, via a heuristic.
%
% d.kind For most GrB.methods, this is a string equal to 'default',
% 'GrB', 'sparse', 'full', or 'builtin'. The default is 'GrB',
% where the GraphBLAS operation returns an object, which is
% preferred since GraphBLAS sparse matrices are faster and can
% represent many more data types. However, if you want a
% standard sparse matrix on ouput, use d.kind='sparse'. Use
% d.kind='full' to return a full matrix. Use d.kind='builtin'
% for a built-in sparse or full matrix (full if all entries are
% present, sparse otherwise).
%
% d.base A string equal to 'default', 'zero-based', 'one-based', or
% 'one-based int'. The default is 'one-based'. If d.base is
% 'zero-based', then indices are zero-based, in the range 0 to
% n-1, for a matrix of dimension n.
%
% d.format a string that describes the sparsity format of the output
% matrix C. The following rules are used to determine the
% format of the result, in order:
%
% (1) If d.format appears in the descriptor for a method, then
% that determines the format of C.
% (2) If C is a column vector then C is stored by column.
% (3) If C is a row vector then C is stored by row.
% (4) If the method has a first matrix input (usually called A),
% and it is not a row or column vector, then its format is
% used for C.
% (5) If the method has a second matrix input (usually called
% B), and it is not a row or column vector, then its format
% is used for C.
% (6) Otherwise, the global default format is used for C.
% See GrB.format for details.
%
% The d.format string optionally includes one or more strings
% 'sparse', 'hypersparse' (or 'hyper' for short), 'bitmap', and
% 'full', separated by '/', and then optionally followed by the
% string 'by row' or 'by col'. For example, to allow C to be
% sparse or bitmap, use d.format = 'sparse/bitmap'. To return
% C as hypersparse in row-oriented format, use 'hyper by row'.
%
% These descriptor values are scalars:
%
% d.nthreads max # of threads to use; default is omp_get_max_threads.
% d.chunk controls # of threads to use for small problems.
%
% GrB.descriptorinfo (d) lists the contents of a GraphBLAS descriptor and
% checks if its contents are valid. Also refer to the
% SuiteSparse:GraphBLAS User Guide for more details.
%
% See also GrB.binopinfo, GrB.monoidinfo, GrB.selectopinfo,
% GrB.semiringinfo, GrB.unopinfo.
% SuiteSparse:GraphBLAS, Timothy A. Davis, (c) 2017-2022, All Rights Reserved.
% SPDX-License-Identifier: Apache-2.0
% FUTURE: add desc.in* = 'conjugate transpose'
if (nargin == 0)
help GrB.descriptorinfo
gbdescriptorinfo ;
else
gbdescriptorinfo (d) ;
end
|
