Skip to content

Latest commit

 

History

History
25 lines (22 loc) · 1.6 KB

API_doc.md

File metadata and controls

25 lines (22 loc) · 1.6 KB

Ultimate-SpMV interface documentation

Introduction

The interface for USpMV is a single header file, interface.hpp, which contains everything you need. As it currently stands, the functions in the API don't have or need any awareness of MPI. The organization of communication information should be done by the host application, and these routines are used on each MPI process locally.

Structs

  • MtxData is the COO matrix structure, e.g. which is read into from an .mtx file.
  • ScsData is the SELL-C-sigma matrix structure, e.g. which returned after a COO matrix has been processed with the convert_to_scs function.

Functions

  • convert_to_scs
    • Main routine. Converts a COO matrix (in this case, stored in the MtxData struct) into a Sell-C-sigma matrix. Parametarized by C and sigma.
  • partition_precisions
    • Separate an MtxData struct into other, "smaller" MtxData structs to facilitate adaptive precision.
  • apply_permutation
    • Useful function to apply a permutation (e.g. the permutation vector obtained from permuting the rows/columns of your Sell-C-simga matrix) to a vector (e.g. the x vector for computing Ax=y)
  • permute_scs_cols
    • Permute the columns of your Sell-C-sigma matrix, i.e. for symmetric permutations
  • uspmv_scs_(cpu/gpu)
    • The Sell-C-sigma SpMV kernel.
  • uspmv_csr_(cpu/gpu)
    • A CRS format SpMV kernel to use as a reference.
  • execute_spmv
    • Wrapper function to facilitate adaptive precision SpMV.