descriptors.hpp File Reference

Defines all ALP/GraphBLAS descriptors. More...

Go to the source code of this file.

Namespaces
namespace	grb
	The ALP/GraphBLAS namespace.
namespace	grb::descriptors
	Collection of standard descriptors.

Typedefs
typedef unsigned int	Descriptor
	Descriptors indicate pre- or post-processing for some or all of the arguments to an ALP/GraphBLAS call.

Functions
std::string	toString (const Descriptor descr)
	Translates a descriptor into a string.

Variables
static constexpr Descriptor	add_identity = 32
	For any call to a matrix computation, the input matrix A is instead interpreted as \( A+I \), with I the identity matrix of dimension matching A.
static constexpr Descriptor	dense = 16
	Indicates that all input and output vectors to an ALP/GraphBLAS primitive are structurally dense.
static constexpr Descriptor	explicit_zero = 512
	Computation shall proceed with zeros (according to the current semiring) propagating throughout the requested computation.
static constexpr Descriptor	invert_mask = 1
	Inverts the mask prior to applying it.
static constexpr Descriptor	no_casting = 256
	Disallows the standard casting of input parameters to a compatible domain in case they did not match exactly.
static constexpr Descriptor	no_duplicates = 4
	For data ingestion methods, such as grb::buildVector or grb::buildMatrix, this descriptor indicates that the input shall not contain any duplicate entries.
static constexpr Descriptor	no_operation = 0
	Indicates no additional pre- or post-processing on any of the GraphBLAS function arguments.
static constexpr Descriptor	safe_overlap = 1024
	Indicates overlapping input and output vectors is intentional and safe, due to, for example, the use of masks.
static constexpr Descriptor	structural = 8
	Uses the structure of a mask vector only.
static constexpr Descriptor	structural_complement = structural | invert_mask
	Uses the structural complement of a mask vector.
static constexpr Descriptor	transpose_left = 2048
	For operations involving two matrices, transposes the left-hand side input matrix prior to applying it.
static constexpr Descriptor	transpose_matrix = 2
	Transposes the input matrix prior to applying it.
static constexpr Descriptor	transpose_right = 4096
	For operations involving two matrices, transposes the right-hand side input matrix prior to applying it.
static constexpr Descriptor	use_index = 64
	Instead of using input vector elements, use the index of those elements.

Detailed Description

Defines all ALP/GraphBLAS descriptors.

Author

A. N. Yzelman

Date

15 March, 2016