index.rst

Welcome to RGRI's documentation!

.. toctree::
   :maxdepth: 2
   :caption: Contents:

:ref:`genindex`

GraphBLAS Objects

.. doxygenclass:: grb::matrix
   :members:

.. doxygenclass:: grb::vector
   :members:

Example

#include <iostream>
#include <grb/grb.hpp>
int main(int argc, char** argv) {
  // Create a new matrix, reading in from a file.
  grb::matrix<float, int> a("data/chesapeake.mtx");

  size_t m = a.shape()[0];
  size_t k = a.shape()[1];

  std::cout << "chesapeake.mtx is a " << m << " by " << k << " matrix." << std::endl;

  // Set element 12,9 (row 12, column 9) to 12.
  a[{12, 9}] = 12;

  grb::matrix<float, int> b("data/chesapeake.mtx");

  auto c = grb::multiply(a, b);

  std::cout << "Sum of elements is " << grb::sum(c) << std::endl;

  return 0;
}

Binary Operators

Binary operators are function objects that implement binary operators, that is operators that accept two inputs and produce a single output. A collection of binary operators are pre-defined by GraphBLAS.

.. doxygenstruct:: grb::plus

.. doxygenstruct:: grb::minus

.. doxygenstruct:: grb::multiplies

.. doxygenstruct:: grb::times

.. doxygenstruct:: grb::max

.. doxygenstruct:: grb::min

.. doxygenstruct:: grb::modulus

Monoid Traits

.. cpp:class:: template <typename Fn, typename T> grb::monoid_traits

.. cpp:function:: static constexpr T identity()

.. cpp:type:: template <typename Fn, typename T> grb::monoid_traits_v = typename grb::monoid_traits::value

Identity of the

Algorithms

.. doxygenfunction:: grb::multiply(A&&, B&&, Reduce&&, Combine&&, M&&)

.. doxygenfunction:: grb::dot(A&&, B&&, Reduce&&, Combine&&, M&&)

.. doxygenfunction:: grb::sum

.. doxygenfunction:: grb::ewise_union

.. doxygenfunction:: grb::ewise_intersection

Utility Functions

.. doxygenfunction:: grb::print(M&&, std::string)

.. doxygenfunction:: grb::print(V&&, std::string)