Intel® oneAPI Programming Guide

Download PDF
ID 771723
Date 3/31/2025
Public
Document Table of Contents
Document Table of Contents x
Intel® oneAPI Programming Guide
Intel® oneAPI Programming Guide x
Introduction to oneAPI Programming oneAPI Programming Model oneAPI Development Environment Setup Compile and Run oneAPI Programs API-Based Programming Software Development Process Glossary Notices and Disclaimers
Introduction to oneAPI Programming x
Intel oneAPI Programming Overview Intel® oneAPI Toolkit Distribution Related Documentation
oneAPI Programming Model x
Data Parallelism in C++ Using SYCL* C/C++ or Fortran with OpenMP* Offload Programming Model Device Selection SYCL* Execution and Memory Hierarchy
oneAPI Development Environment Setup x
Use the setvars and oneapi-vars Scripts with Windows* Use the setvars and oneapi-vars Scripts with Linux* Use Environment Modulefiles with Linux* Use CMake with oneAPI Applications
Use the setvars and oneapi-vars Scripts with Windows* x
Use a Config File for setvars.bat on Windows* Automate the setvars.bat Script with Microsoft Visual Studio*
Use the setvars and oneapi-vars Scripts with Linux* x
Use a Config File for setvars.sh on Linux Automate the setvars.sh Script with Eclipse*
Compile and Run oneAPI Programs x
Single-Source Compilation Invoke the Compiler Standard Intel® oneAPI DPC++/C++ Compiler Options Example Compilation Compilation Flow Overview CPU Flow GPU Flow FPGA Flow
CPU Flow x
Traditional CPU Flow CPU Offload Flow
CPU Offload Flow x
Example CPU Commands Ahead-of-Time Compilation for CPU Architectures Control Binary Execution on Multiple CPU Cores
GPU Flow x
GPU Offload Flow Example GPU Commands Ahead-of-Time Compilation for GPU
FPGA Flow x
Why is FPGA Compilation Different? Types of SYCL* FPGA Compilation
API-Based Programming x
Intel® oneAPI DPC++ Library (oneDPL) Intel® oneAPI Math Kernel Library (oneMKL) Intel® oneAPI Threading Building Blocks (oneTBB) Intel® oneAPI Data Analytics Library (oneDAL) Intel® oneAPI Collective Communications Library (oneCCL) Intel® oneAPI Deep Neural Network Library (oneDNN) Other Libraries
Intel® oneAPI DPC++ Library (oneDPL) x
oneDPL Library Usage oneDPL Code Samples
Intel® oneAPI Math Kernel Library (oneMKL) x
oneMKL Usage oneMKL Code Sample
Intel® oneAPI Threading Building Blocks (oneTBB) x
oneTBB Usage oneTBB Code Sample
Intel® oneAPI Data Analytics Library (oneDAL) x
oneDAL Usage oneDAL Code Sample
Intel® oneAPI Collective Communications Library (oneCCL) x
oneCCL Usage oneCCL Code Sample
Intel® oneAPI Deep Neural Network Library (oneDNN) x
Intel® oneAPI Deep Neural Network Library (oneDNN) Usage Intel® oneAPI Deep Neural Network Library (oneDNN) Code Sample
Software Development Process x
Migrating Code to SYCL* and DPC++ Composability Debugging the DPC++ and OpenMP* Offload Process Performance Tuning Cycle oneAPI Library Compatibility SYCL* Extensions
Migrating Code to SYCL* and DPC++ x
Migrating from C++ to SYCL* Migrating from CUDA* to SYCL* for the oneAPI DPC++ Compiler Migrating from OpenCL Code to SYCL* Migrating Between CPU, GPU, and FPGA
Composability x
C/C++ OpenMP* and SYCL* Composability OpenCL™ Code Interoperability
Debugging the DPC++ and OpenMP* Offload Process x
oneAPI Debug Tools for SYCL* and OpenMP* Development Trace the Offload Process Debug the Offload Process Optimize Offload Performance
Debug the Offload Process x
Using the SYCL* Exception Handler
Performance Tuning Cycle x
Establish Baseline Identify Kernels to Offload Offload Kernels Optimize Your SYCL* Applications Recompile, Run, Profile, and Repeat
Intel® oneAPI Programming Guide

Performance Tuning Cycle

Level Two Title