comm.gpu.BlockInterleaver

(To be removed) Create block interleaved sequence with GPU

comm.gpu.BlockInterleaver will be removed in a future release. Use intrlv instead. (since R2026a) For information on updating your code, see Version History.

Description

The comm.gpu.BlockInterleaver System object™ permutes the input signal using a graphics processing unit (GPU).

To interleave the input signal:

1. Create the comm.gpu.BlockInterleaver object and set its properties.

2. Call the object with arguments, as if it were a function.

To learn more about how System objects work, see What Are System Objects?

Creation

Syntax

gpublockinterleaver = comm.gpu.BlockInterleaver

gpublockinterleaver = comm.gpu.BlockInterleaver(Name=Value)

gpublockinterleaver = comm.gpu.BlockInterleaver(permvec)

Description

gpublockinterleaver = comm.gpu.BlockInterleaver creates a GPU-based block interleaver System object that permutes the input signal based on a permutation vector.

gpublockinterleaver = comm.gpu.BlockInterleaver(Name=Value) creates a GPU-based block interleaver object and sets properties using one or more name-value arguments. For example, gpublockinterleaver = comm.gpu.BlockInterleaver(PermutationVector=[2;1;4;3]) specifies the permutation vector for a four-element input signal.

gpublockinterleaver = comm.gpu.BlockInterleaver(permvec) creates a GPU-based block interleaver object and sets the PermutationVector property to permvec.

Properties

Unless otherwise indicated, properties are nontunable, which means you cannot change their values after calling the object. Objects lock when you call them, and the release function unlocks them.

If a property is tunable, you can change its value at any time.

For more information on changing property values, see System Design in MATLAB Using System Objects.

PermutationVectorSource — Permutation vector source

Read-only: 'Property'

This property is read-only.

Permutation vector source, specified as 'Property'.

PermutationVector — Permutation vector

[5;4;3;2;1] (default) | column vector of integers

Permutation vector, specified as a column vector of integers. This input vector specifies the mapping used to permute the input signal. The permutation vector length must equal the input signal length and contain each integer in the range [1 length(x)].

Data Types: double

Usage

Syntax

y = gpublockinterleaver(x)

Description

y = gpublockinterleaver(x) permutes the input signal as specified by the PermutationVector property.

Input Arguments

x — Input signal

column vector

Input signal, specified as column vector.

To decrease data transfer latency, format the input signal as a gpuArray (Parallel Computing Toolbox) object. For more information, see Array Processing with GPU-Based System Objects.

Data Types: single | double | int8 | int16 | int32 | uint8 | uint16 | uint32 | logical | fi
Complex Number Support: Yes

Output Arguments

y — Output signal

column vector

Output signal, returned as a column vector with the same length and data type as the input signal, x. The output contains elements from the input signal mapped as y(k) = x(PermutationVector(k)) for each integer k in the range [1 length(x)].

Object Functions

To use an object function, specify the System object as the first input argument. For example, to release system resources of a System object named obj, use this syntax:

release(obj)

Common to All System Objects

step	Run System object algorithm
release	Release resources and allow changes to System object property values and input characteristics

Examples

Block Interleaving and Deinterleaving with GPU

Create GPU-based interleaver and deinterleaver objects.

Set a specific permutation vector.

interleaver = comm.gpu.BlockInterleaver([3 4 1 2]');
deinterleaver = comm.gpu.BlockDeinterleaver([3 4 1 2]');

Pass random data through the interleaver and deinterleaver. The length of the input data vector must equal the length of the PermutationVector property. Generate a 4-by-1 column vector of input data filled with integer values in the range [1, 7] by using the randi function.

data = randi(7,length(interleaver.PermutationVector),1);
intData = interleaver(data);
deintData = deinterleaver(intData);

Display the original sequence, interleaved sequence, and restored sequence.

[data intData deintData]

ans = 4×3

     6     1     6
     7     7     7
     1     6     1
     7     7     7

Confirm that the original and deinterleaved data are identical.

isequal(data,deintData)

ans = logical
   1

Set a random permutation vector. Generate a random 8-by-1 vector of unique integers to use as the permutation vector by using the randperm function.

permVec = randperm(8)';

Specify permVec as the permutation vector for GPU-based interleaver and deinterleaver objects.

interleaver = comm.gpu.BlockInterleaver(permVec);
deinterleaver = comm.gpu.BlockDeinterleaver(permVec);

Pass random data through the interleaver and deinterleaver.

data = randi(10,length(interleaver.PermutationVector),1);
intData = interleaver(data);
deintData = deinterleaver(intData);

Display the original sequence, interleaved sequence, and restored sequence.

[data intData deintData]

ans = 8×3

    10     5    10
     5     8     5
     9     9     9
     2     2     2
     5    10     5
    10     5    10
     8    10     8
    10    10    10

Confirm that the original and deinterleaved data are identical.

isequal(data,deintData)

ans = logical
   1

More About

Array Processing with GPU-Based System Objects

A GPU-based System object accepts typical MATLAB^® arrays or gpuArray (Parallel Computing Toolbox) objects. The output signal data type matches the input signal data type.

• When the input signal to the GPU-based System object is a gpuArray object, calculations take place entirely on the GPU, the data remains on the GPU, and the output signal is a gpuArray object. Passing gpuArray arguments minimizes data transfer latency by limiting the number of data transfers between the CPU and the GPU when your simulation runs. For more information, see Establish Arrays on a GPU (Parallel Computing Toolbox).

• When the input signal is a MATLAB array, the GPU-based System object transfers the data between the CPU and the GPU for each object call. The output signal is a MATLAB array and data transfer latency occurs.

Tips

To use this object, you must install Parallel Computing Toolbox™ and have access to a supported GPU. If the host computer has a GPU configured, processing uses the GPU. Otherwise, processing uses the CPU. For more information about GPUs, see GPU Computing (Parallel Computing Toolbox).

Extended Capabilities

GPU Arrays

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

This System object supports GPU array inputs. For more information, see Accelerate Simulation Using GPUs.

Version History

Introduced in R2012a

R2026a: To be removed

comm.gpu.BlockInterleaver will be removed in a future release. Use intrlv instead. The recommended replacement function does not support gpuArray (Parallel Computing Toolbox) input signals. For GPU processing, you can use direct MATLAB indexing on gpuArray (Parallel Computing Toolbox) inputs instead.

The code in this table shows how to interleave and deinterleave inputs using the recommended functions.

Removed Feature	Recommended Replacement
permVec = randperm(8)'; interleaver = comm.gpu.BlockInterleaver(permVec); deinterleaver = comm.gpu.BlockDeinterleaver(permVec); data = (1:length(interleaver.PermutationVector)); intData = interleaver(data); deintData = deinterleaver(intData); [data intData deintData] isequal(data,deintData)	permVec = randperm(8)'; data = (1:length(permVec))'; intData = intrlv(data,permVec); deintData = deintrlv(intData,permVec); [data intData deintData] isequal(data,deintData) % MATLAB direct indexing for GPU processing gpu data = gpuArray(1:length(permVec))'; intData = data(permVec); % Interleave deintData(permVec) = intData; % Deinterleave [data intData deintData] isequal(data,deintData)