oneMKL - Data Parallel C++ Developer Reference

Download PDF
ID 772045
Date 3/22/2024
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents
Document Table of Contents x
Intel® oneAPI Math Kernel Library - Data Parallel C++ Developer Reference
Intel® oneAPI Math Kernel Library - Data Parallel C++ Developer Reference x
What's New oneMKL Initialization on GPU Introduction to the Intel® oneAPI Math Kernel Library (oneMKL) BLAS and LAPACK with DPC++ Overview of Intel® oneMKL BLAS Routines for Data Parallel C++ Overview of Intel® oneAPI Math Kernel Library (oneMKL) Sparse BLAS for DPC++ Overview of Intel® oneMKL LAPACK Routines for Data Parallel C++ Data Types Matrix Storage Scalar Arguments Error Handling BLAS Routines Sparse BLAS Routines LAPACK Routines Vector Mathematical Functions Random Number Generators Summary Statistics Fourier Transform Functions Data Fitting Bibliography Appendix A: oneMKL Functionality Notices and Disclaimers
BLAS Routines x
BLAS Level 1 Routines BLAS Level 2 Routines BLAS Level 3 Routines BLAS-like Extensions Compute Modes Numerical Reproducibility
BLAS Level 1 Routines x
asum axpy copy dot dotc dotu iamax iamin nrm2 rot rotg rotm rotmg scal sdsdot swap
BLAS Level 2 Routines x
gbmv gemv ger gerc geru hbmv hemv her her2 hpmv hpr hpr2 sbmv spmv spr spr2 symv syr syr2 tbmv tbsv tpmv tpsv trmv trsv
BLAS Level 3 Routines x
gemm hemm her2k herk symm syr2k syrk trmm trsm
BLAS-like Extensions x
axpby axpy_batch copy_batch dgmm_batch gemm_batch gemm_bias gemmt gemv_batch syrk_batch trsm_batch omatcopy imatcopy omatadd omatcopy_batch imatcopy_batch omatadd_batch
Sparse BLAS Routines x
Sparse BLAS Matrix Handle Contract between User and Library Sparse BLAS Supported Data and Integer Types Sparse Storage Formats oneapi::mkl::sparse::init_matrix_handle oneapi::mkl::sparse::release_matrix_handle oneapi::mkl::sparse::set_csr_data oneapi::mkl::sparse::set_coo_data oneapi::mkl::sparse::set_matrix_property oneapi::mkl::sparse::optimize_gemv oneapi::mkl::sparse::optimize_trmv oneapi::mkl::sparse::optimize_trsv oneapi::mkl::sparse::optimize_trsm oneapi::mkl::sparse::gemv oneapi::mkl::sparse::gemvdot oneapi::mkl::sparse::symv oneapi::mkl::sparse::trmv oneapi::mkl::sparse::trsv oneapi::mkl::sparse::gemm oneapi::mkl::sparse::trsm oneapi::mkl::sparse::init_matmat_descr oneapi::mkl::sparse::set_matmat_data oneapi::mkl::sparse::get_matmat_data oneapi::mkl::sparse::release_matmat_descr oneapi::mkl::sparse::matmat oneapi::mkl::sparse::omatcopy oneapi::mkl::sparse::sort_matrix oneapi::mkl::sparse::update_diagonal_values
LAPACK Routines x
gebrd gebrd (USM Version) gebrd_scratchpad_size geinv_batch (Group Version) geinv_batch_scratchpad_size (Group Version) gels_batch (Buffer Strided Version) gels_batch (USM Strided Version) gels_batch_scratchpad_size (Strided Version) geqrf geqrf (USM Version) geqrf_batch (Buffer Strided Version) geqrf_batch (Group Version) geqrf_batch (USM Strided Version) geqrf_batch_scratchpad_size (Group Version) geqrf_batch_scratchpad_size (Strided Version) geqrf_scratchpad_size gerqf gerqf (USM Version) gerqf_scratchpad_size gesv (USM Version) gesv_scratchpad_size gesvd gesvd (USM Version) gesvd_scratchpad_size gesvda_batch (Buffer Strided Version) gesvda_batch (USM Strided Version) gesvda_batch_scratchpad_size (Strided Version) getrf getrf (USM Version) getrf_batch (Buffer Strided Version) getrf_batch (Group Version) getrf_batch (USM Strided Version) getrf_batch_scratchpad_size (Group Version) getrf_batch_scratchpad_size (Strided Version) getrf_scratchpad_size getrfnp getrfnp (USM Version) getrfnp_scratchpad_size getrfnp_batch (Buffer Strided Version) getrfnp_batch (Group Version) getrfnp_batch (USM Strided Version) getrfnp_batch_scratchpad_size (Group Version) getrfnp_batch_scratchpad_size (Strided Version) getri getri (USM Version) getri_batch (Buffer Strided Version) getri_batch (Group Version) getri_batch (USM Strided Version) getri_batch_scratchpad_size (Group Version) getri_batch_scratchpad_size (Strided Version) getri_batch (Out-of-place, Buffer Strided Version) getri_batch (Out-of-place, USM Strided Version) getri_batch_scratchpad_size (Strided Version) getri_scratchpad_size getrs getrs (USM Version) getrs_batch (Buffer Strided Version) getrs_batch (Group Version) getrs_batch (USM Strided Version) getrs_batch_scratchpad_size (Group Version) getrs_batch_scratchpad_size (Strided Version) getrs_scratchpad_size Description API getrsnp_batch (Buffer Strided Version) getrsnp_batch (USM Strided Version) getrsnp_batch_scratchpad_size (Strided Version) heevd heevd (USM Version) heevd_scratchpad_size hegvd hegvd (USM Version) hegvd_scratchpad_size hetrd hetrd (USM Version) hetrd_scratchpad_size hetrf hetrf (USM Version) hetrf_scratchpad_size orgbr orgbr (USM Version) orgbr_scratchpad_size orgqr orgqr (USM Version) orgqr_batch (Buffer Strided Version) orgqr_batch (Group Version) orgqr_batch (USM Strided Version) orgqr_batch_scratchpad_size (Group Version) orgqr_batch_scratchpad_size (Strided Version) orgqr_scratchpad_size orgtr orgtr (USM Version) orgtr_scratchpad_size ormqr ormqr (USM Version) ormqr_scratchpad_size ormrq ormrq (USM Version) ormrq_scratchpad_size ormtr ormtr (USM Version) ormtr_scratchpad_size potrf potrf (USM Version) potrf_batch (Buffer Strided Version) potrf_batch (Group Version) potrf_batch (USM Strided Version) potrf_batch_scratchpad_size (Group Version) potrf_batch_scratchpad_size (Strided Version) potrf_scratchpad_size potri potri (USM Version) potri_scratchpad_size potrs potrs (USM Version) potrs_batch (Buffer Strided Version) potrs_batch (Group Version) potrs_batch (USM Strided Version) potrs_batch_scratchpad_size (Group Version) potrs_batch_scratchpad_size (Strided Version) potrs_scratchpad_size syevd syevd (USM Version) syevd_scratchpad_size sygvd sygvd (USM Version) sygvd_scratchpad_size sytrd sytrd (USM Version) sytrd_scratchpad_size sytrf sytrf (USM Version) sytrf_scratchpad_size trtri (USM Version) trtri_scratchpad_size trtrs trtrs (USM Version) trtrs_scratchpad_size ungbr ungbr (USM Version) ungbr_scratchpad_size ungqr ungqr (USM Version) ungqr_batch (Buffer Strided Version) ungqr_batch (Group Version) ungqr_batch (USM Strided Version) ungqr_batch_scratchpad_size (Group Version) ungqr_batch_scratchpad_size (Strided Version) ungqr_scratchpad_size ungtr ungtr (USM Version) ungtr_scratchpad_size unmqr unmqr (USM Version) unmqr_scratchpad_size unmrq unmrq (USM Version) unmrq_scratchpad_size unmtr unmtr (USM Version) unmtr_scratchpad_size
Vector Mathematical Functions x
Special Value Notations VM Mathematical Functions VM Service Functions Miscellaneous VM Functions
VM Mathematical Functions x
Arithmetic Functions Power and Root Functions Exponential and Logarithmic Functions Trigonometric Functions Hyperbolic Functions Special Functions Rounding Functions
Arithmetic Functions x
add sub sqr mul mulbyconj conj abs arg linearfrac fmod remainder
Power and Root Functions x
inv div sqrt invsqrt cbrt invcbrt pow2o3 pow3o2 pow powx powr hypot
Exponential and Logarithmic Functions x
exp exp2 exp10 expm1 ln log2 log10 log1p logb
Trigonometric Functions x
cos sin sincos cis tan acos asin atan atan2 cospi sinpi tanpi acospi asinpi atanpi atan2pi cosd sind tand
Hyperbolic Functions x
cosh sinh tanh acosh asinh atanh
Special Functions x
erf erfc cdfnorm erfinv erfcinv cdfnorminv lgamma tgamma expint1
Rounding Functions x
floor ceil trunc round nearbyint rint modf frac
VM Service Functions x
set_mode get_mode set_status get_status clear_status create_error_handler
Miscellaneous VM Functions x
copysign nextafter fdim fmax fmin maxmag minmag
Random Number Generators x
Random Number Generators Host Routines Random Number Generators Device Routines
Random Number Generators Host Routines x
Random Number Generators Routines oneMKL RNG Usage Model Device Support Generate Routine Engines (Basic Random Number Generators) Service Routines Distributions
Generate Routine x
generate
Engines (Basic Random Number Generators) x
mrg32k3a philox4x32x10 mcg31m1 mcg59 r250 wichmann_hill mt19937 sfmt19937 mt2203 ars5 sobol niederreiter nondeterministic
Service Routines x
leapfrog skip_ahead save_state load_state get_state_size
Distributions x
Distributions Template Parameter Method uniform (Continuous) gaussian exponential laplace weibull cauchy rayleigh lognormal gumbel gamma beta chi_square gaussian_mv uniform (Discrete) uniform_bits bits bernoulli geometric binomial hypergeometric poisson poisson_v negative_binomial multinomial
Random Number Generators Device Routines x
oneMKL RNG Device Usage Model Device Generate Routines Device Engines (Basic Random Number Generators) Host-Side Helpers Device Service Routines Device Distributions
Device Generate Routines x
generate generate_single
Device Engines (Basic Random Number Generators) x
mrg32k3a philox4x32x10 mcg31m1 mcg59
Host-Side Helpers x
engine_descriptor engine_accessor
Device Service Routines x
skip_ahead
Device Distributions x
uniform (Continuous) gaussian lognormal exponential uniform (Discrete) bits uniform_bits poisson bernoulli
Summary Statistics x
oneMKL Summary Statistics Usage Model Summary Statistics Device Support Dataset Service Functions to Create Dataset Summary Statistics Routines
Service Functions to Create Dataset x
oneapi::mkl::stats::make_dataset
Summary Statistics Routines x
oneapi::mkl::stats::raw_sum oneapi::mkl::stats::central_sum oneapi::mkl::stats::central_sum with User-provided Mean oneapi::mkl::stats::raw_moment oneapi::mkl::stats::central_moment oneapi::mkl::stats::central_moment with User-provided Mean oneapi::mkl::stats::mean oneapi::mkl::stats::variation oneapi::mkl::stats::variation with User-provided Mean oneapi::mkl::stats::skewness oneapi::mkl::stats::skewness with User-provided Mean oneapi::mkl::stats::kurtosis oneapi::mkl::stats::kurtosis with User-provided Mean oneapi::mkl::stats::min oneapi::mkl::stats::max oneapi::mkl::stats::min_max
Fourier Transform Functions x
descriptor<precision, domain> descriptor<precision, domain>::set_value Configuring Data Layouts User-Allocated Workspaces descriptor<precision, domain>::get_value descriptor<precision, domain>::commit compute_forward<typename descriptor_type, typename data_type> compute_backward<typename descriptor_type, typename data_type> Configuring and computing a DFT in DPC++
Data Fitting x
Common Terms Splines Interpolate Function Examples
Splines x
Linear Spline Cubic Splines
Appendix A: oneMKL Functionality x
BLAS Functionality LAPACK Functionality DFT Functionality Sparse BLAS SYCL Functionality Sparse Solvers Functionality Random Number Generators Functionality Vector Math Functionality Data Fitting Functionality Summary Statistics Functionality
Intel® oneAPI Math Kernel Library - Data Parallel C++ Developer Reference

getrs_scratchpad_size

Level Two Title