swap¶

Swaps a vector with another vector.

Description

Given two vectors of n elements, x and y, the swap routines return vectors y and x swapped, each replacing the other.

\[\begin{split}\left[\begin{array}{c} y\\x \end{array}\right] \leftarrow \left[\begin{array}{c} x\\y \end{array}\right]\end{split}\]

swap supports the following precisions.

T

float

double

std::complex<float>

std::complex<double>

T
`float`
`double`
`std::complex<float>`
`std::complex<double>`

swap (Buffer Version)¶

Syntax

namespace oneapi::mkl::blas::column_major {
    void swap(sycl::queue &queue,
              std::int64_t n,
              sycl::buffer<T,1> &x,
              std::int64_t incx,
              sycl::buffer<T,1> &y,
              std::int64_t incy)
}

namespace oneapi::mkl::blas::row_major {
    void swap(sycl::queue &queue,
              std::int64_t n,
              sycl::buffer<T,1> &x,
              std::int64_t incx,
              sycl::buffer<T,1> &y,
              std::int64_t incy)
}

Input Parameters

queue: The queue where the routine should be executed.
n: Number of elements in vector x.
x: Buffer holding input vector x. The buffer must be of size at least (1 + (n - 1)*abs(incx)). See Matrix Storage for more details.
incx: Stride of vector x.
y: Buffer holding input vector y. The buffer must be of size at least (1 + (n - 1)*abs(incy)). See Matrix Storage for more details.
incy: Stride of vector y.

Output Parameters

x: Buffer holding updated buffer x, that is, the input vector y.
y: Buffer holding updated buffer y, that is, the input vector x.

Throws

This routine shall throw the following exceptions if the associated condition is detected. An implementation may throw additional implementation-specific exception(s) in case of error conditions not covered here.

oneapi::mkl::invalid_argument

oneapi::mkl::unsupported_device

oneapi::mkl::host_bad_alloc

oneapi::mkl::device_bad_alloc

oneapi::mkl::unimplemented

swap (USM Version)¶

Syntax

namespace oneapi::mkl::blas::column_major {
    sycl::event swap(sycl::queue &queue,
                     std::int64_t n,
                     T *x,
                     std::int64_t incx,
                     T *y,
                     std::int64_t incy,
                     const sycl::vector_class<sycl::event> &dependencies = {})
}

namespace oneapi::mkl::blas::row_major {
    sycl::event swap(sycl::queue &queue,
                     std::int64_t n,
                     T *x,
                     std::int64_t incx,
                     T *y,
                     std::int64_t incy,
                     const sycl::vector_class<sycl::event> &dependencies = {})
}

Input Parameters

queue: The queue where the routine should be executed.
n: Number of elements in vector x.
x: Pointer to the input vector x. The array must be of size at least (1 + (n - 1)*abs(incx)). See Matrix Storage for more details.
incx: Stride of vector x.
y: Pointer to the input vector y. The array must be of size at least (1 + (n - 1)*abs(incy)). See Matrix Storage for more details.
incy: Stride of vector y.
dependencies: List of events to wait for before starting computation, if any. If omitted, defaults to no dependencies.