isgpuarray

Determine whether input is gpuArray

Since R2020b

Syntax

TF = isgpuarray(X)

Description

TF = isgpuarray(X) returns logical 1 (true) if X is a gpuArray, and logical 0 (false) otherwise. You can use this function with an if statement to avoid executing code that expects gpuArray input.

Examples

Determine if Array is gpuArray

Create an array of random numbers.

X = rand(3,3);

Copy the array onto the GPU.

Y = gpuArray(X);

Use the function isgpuArray to verify that Y is a gpuArray.

isgpuArray(Y)

ans = 
   1

Verify that X is not a gpuArray.

isgpuarray(X)

ans = 
   0

Input Arguments

X — Input variable

workspace variable

Input variable, specified as a workspace variable. X can be any data type.

Extended Capabilities

Thread-Based Environment

Run code in the background using MATLAB® backgroundPool or accelerate code with Parallel Computing Toolbox™ ThreadPool.

This function fully supports thread-based environments. For more information, see Run MATLAB Functions in Thread-Based Environment.

GPU Arrays

Accelerate code by running on a graphics processing unit (GPU) using Parallel Computing Toolbox™.

The isgpuarray function fully supports GPU arrays. To run the function on a GPU, specify the input data as a gpuArray. For more information, see Run MATLAB Functions on a GPU.

Version History

Introduced in R2020b