Welcome to hipBLAS’s documentation!

Contents:

• User Guide
  • Disclaimer
  • Introduction
  • Building and Installing
    • Prerequisites
    • Installing pre-built packages
    • hipBLAS build
      • Build library dependencies + library
      • Build library dependencies + client dependencies + library + client
    • Dependencies
    • Manual build (all supported platforms)
      • Dependencies For Building Library
      • Build Library Using Individual Commands
      • Build Library + Tests + Benchmarks + Samples Using Individual Commands
  • Library Source Code Organization
    • The library directory
      • library/include
      • library/src/hcc_detail
      • library/src/nvcc_detail
      • library/src/include
    • The clients directory
      • clients/gtest
      • clients/benchmarks
      • clients/include
      • clients/common
      • clients/samples
    • Infrastructure
  • API
    • hipBLAS interface examples
    • GEMV API
    • Batched and strided GEMM API
  • Guidelines
    • Naming conventions
    • Notations
  • hipBLAS Types
    • Definitions
      • hipblasHandle_t
      • hipblasHalf
      • hipblasInt8
      • hipblasStride
      • hipblasBfloat16
      • hipblasComplex
      • hipblasDoubleComplex
    • Enums
      • hipblasStatus_t
      • hipblasOperation_t
      • hipblasPointerMode_t
      • hipblasFillMode_t
      • hipblasDiagType_t
      • hipblasSideMode_t
      • hipblasDatatype_t
      • hipblasGemmAlgo_t
      • hipblasAtomicsMode_t
  • hipBLAS Functions
    • Level 1 BLAS
      • hipblasIXamax + Batched, StridedBatched
      • hipblasIXamin + Batched, StridedBatched
      • hipblasXasum + Batched, StridedBatched
      • hipblasXaxpy + Batched, StridedBatched
      • hipblasXcopy + Batched, StridedBatched
      • hipblasXdot + Batched, StridedBatched
      • hipblasXnrm2 + Batched, StridedBatched
      • hipblasXrot + Batched, StridedBatched
      • hipblasXrotg + Batched, StridedBatched
      • hipblasXrotm + Batched, StridedBatched
      • hipblasXrotmg + Batched, StridedBatched
      • hipblasXscal + Batched, StridedBatched
      • hipblasXswap + Batched, StridedBatched
    • Level 2 BLAS
      • hipblasXgbmv + Batched, StridedBatched
      • hipblasXgemv + Batched, StridedBatched
      • hipblasXger + Batched, StridedBatched
      • hipblasXhbmv + Batched, StridedBatched
      • hipblasXhemv + Batched, StridedBatched
      • hipblasXher + Batched, StridedBatched
      • hipblasXher2 + Batched, StridedBatched
      • hipblasXhpmv + Batched, StridedBatched
      • hipblasXhpr + Batched, StridedBatched
      • hipblasXhpr2 + Batched, StridedBatched
      • hipblasXsbmv + Batched, StridedBatched
      • hipblasXspmv + Batched, StridedBatched
      • hipblasXspr + Batched, StridedBatched
      • hipblasXspr2 + Batched, StridedBatched
      • hipblasXsymv + Batched, StridedBatched
      • hipblasXsyr + Batched, StridedBatched
      • hipblasXsyr2 + Batched, StridedBatched
      • hipblasXtbmv + Batched, StridedBatched
      • hipblasXtbsv + Batched, StridedBatched
      • hipblasXtpmv + Batched, StridedBatched
      • hipblasXtpsv + Batched, StridedBatched
      • hipblasXtrmv + Batched, StridedBatched
      • hipblasXtrsv + Batched, StridedBatched
    • Level 3 BLAS
      • hipblasXgemm + Batched, StridedBatched
      • hipblasXherk + Batched, StridedBatched
      • hipblasXherkx + Batched, StridedBatched
      • hipblasXher2k + Batched, StridedBatched
      • hipblasXsymm + Batched, StridedBatched
      • hipblasXsyrk + Batched, StridedBatched
      • hipblasXsyr2k + Batched, StridedBatched
      • hipblasXsyrkx + Batched, StridedBatched
      • hipblasXgeam + Batched, StridedBatched
      • hipblasXhemm + Batched, StridedBatched
      • hipblasXtrmm + Batched, StridedBatched
      • hipblasXtrsm + Batched, StridedBatched
      • hipblasXtrtri + Batched, StridedBatched
      • hipblasXdgmm + Batched, StridedBatched
    • SOLVER API
      • hipblasXgetrf + Batched, stridedBatched
      • hipblasXgetrs + Batched, stridedBatched
      • hipblasXgetri + Batched, stridedBatched
      • hipblasXgeqrf + Batched, stridedBatched
    • BLAS Extensions
      • hipblasGemmEx + Batched, StridedBatched
      • hipblasTrsmEx + Batched, StridedBatched
      • hipblasAxpyEx + Batched, StridedBatched
      • hipblasDotEx + Batched, StridedBatched
      • hipblasDotcEx + Batched, StridedBatched
      • hipblasNrm2Ex + Batched, StridedBatched
      • hipblasRotEx + Batched, StridedBatched
      • hipblasScalEx + Batched, StridedBatched
    • Auxiliary
      • hipblasCreate
      • hipblasDestroy
      • hipblasSetStream
      • hipblasGetStream
      • hipblasSetPointerMode
      • hipblasGetPointerMode
      • hipblasSetVector
      • hipblasGetVector
      • hipblasSetMatrix
      • hipblasGetMatrix
      • hipblasSetVectorAsync
      • hipblasGetVectorAsync
      • hipblasSetMatrixAsync
      • hipblasGetMatrixAsync
      • hipblasSetAtomicsMode
      • hipblasGetAtomicsMode
      • hipblasStatusToString
  • Contributing
    • License Agreement
    • Pull-request guidelines
    • StyleGuide
      • Interface
      • Philosophy
      • Implementation
      • Format
      • Guidelines:
    • Static Code Analysis
• Design Documentation
  • Disclaimer
  • Clients
    • hipblas-bench
    • hipblas-test