2
0
mirror of https://github.com/boostorg/math.git synced 2026-01-19 04:22:09 +00:00

Add overview

This commit is contained in:
Matt Borland
2024-08-30 15:46:17 -04:00
parent ab57b2093e
commit 814cb6e49f
2 changed files with 60 additions and 0 deletions

View File

@@ -557,6 +557,7 @@ and as a CD ISBN 0-9504833-2-X 978-0-9504833-2-0, Classification 519.2-dc22.
[include overview/standalone.qbk]
[include overview/result_type_calc.qbk]
[include overview/error_handling.qbk]
[include overview/gpu.qbk]
[section:compilers_overview Compilers]
[compilers_overview]

59
doc/overview/gpu.qbk Normal file
View File

@@ -0,0 +1,59 @@
[section:gpu Support for GPU programming in Boost.Math]
[h4 GPU Support]
Selected functions, distributions, tools, etc. support running on both host and devices.
These functions will have the annotation `BOOST_MATH_GPU_ENABLED` next to their individual documentation.
We test using CUDA (both NVCC and NVRTC) as well as SYCL to provide a wide range of support.
[h4 How to build with device support]
When compiling with CUDA or SYCL you will have to ensure that your code is being run inside of a kernel function.
It is not enough to simply compile existing code with the NVCC compiler to run the code on the device.
A simple CUDA kernel to run the Beta Distribution CDF on NVCC would be:
__global__ void cuda_beta_dist(const double* in, double* out, int num_elements)
{
const int i = blockDim.x * blockIdx.x + threadIdx.x;
if (i < num_elements)
{
out[i] = cdf(boost::math::beta_distribution<double>(), in[i]);
}
}
And on CUDA on NVRTC:
const char* cuda_kernel = R"(
#include <boost/math/distributions/beta.hpp>
extern "C" __global__
void test_beta_dist_kernel(const double* in, double* out, int num_elements)
{
const int i = blockDim.x * blockIdx.x + threadIdx.x;
if (i < num_elements)
{
out[i] = boost::math::cdf(boost::math::beta_distribution<double>(), in[i]);
}
}
)";
And lastly on SYCL:
void sycl_beta_dist(const double* in, double* out, int num_elements, sycl::queue& q)
{
q.submit([&](sycl::handler& h) {
h.parallel_for(sycl::range<1>(num_elements), [=](sycl::id<1> i) {
out[i] = boost::math::cdf(boost::math::beta_distribution<double>(), in[i]);
});
});
}
Once your kernel function has been written then use the framework mechanism for launching the kernel.
[/
Copyright 2024. Matt Borland
Distributed under the Boost Software License, Version 1.0.
(See accompanying file LICENSE_1_0.txt or copy at
http://www.boost.org/LICENSE_1_0.txt).
]