bitsliceget

R2026b

Get consecutive slice of bits

Syntax

c = bitsliceget(a)

c = bitsliceget(a,lidx)

c = bitsliceget(a,lidx,ridx)

Description

c = bitsliceget(a) returns the entire set of bits in the fixed-point input a.

c = bitsliceget(a,lidx) returns a consecutive slice of bits from a, starting at position lidx and ending at the LSB (the bit at position 1).

c = bitsliceget(a,lidx,ridx) returns a consecutive slice of bits from a, starting at position lidx and ending at position ridx.

Note

The bitsliceget arguments must satisfy this condition: a.WordLength >= lidx >= ridx >= 1

Examples

Get Entire Set of Bits

Use the bitsliceget function to get the entire set of bits of the fixed-point input a.

a = fi(85,0,8,0);
disp(bin(a))

01010101

c = bitsliceget(a);
disp(bin(c))

01010101

Get Slice of Consecutive Bits with Unspecified Endpoint

Use the bitsliceget function to get the binary representation of a slice of consecutive bits, starting at position 6 and with no specified endpoint.

a = fi(85,0,8,0);
disp(bin(a))

01010101

c = bitsliceget(a,6);
disp(bin(c))

010101

Get Specified Set of Consecutive Bits from Each Element of Matrix

Use the bitsliceget function to get the binary representation of a consecutive set of bit of matrix a. For each element, start at position 4 and end at position 2. Specify the lidx and ridx indices using fixed-point fi values.

a = fi([2 3 4;6 8 2;3 5 1],0,4,0);
disp(bin(a))

0010   0011   0100
0110   1000   0010
0011   0101   0001

c = bitsliceget(a,fi(4),fi(2));
disp(bin(c))

001   001   010
011   100   001
001   010   000

Input Arguments

a — Input array

scalar | vector | matrix | multidimensional array

Input array, specified as a scalar, vector, matrix, or multidimensional array of built-in integers (since R2026b) or fixed-point fi objects. If a has a signed numerictype, the bit representation of the stored integer is in two’s complement representation.

Data Types: int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | fi

lidx — Start position for slice

scalar

Start position of slice specified as a scalar of built-in type. lidx represents the position in the slice closest to the MSB.

Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | fi

ridx — End position for slice

scalar

End position of slice specified as a scalar of built-in type. ridx represents the position in the slice closest to the LSB (the bit at position 1).

Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | fi

Output Arguments

c — Output array

scalar | vector | matrix | multidimensional array

Fixed-point fi output, returned as a scalar, vector, matrix, or multidimensional array with no scaling. The word length is equal to slice length, lidx-ridx+1.

If lidx and ridx are equal, bitsliceget only slices one bit, and bitsliceget(a,lidx,ridx) is the same as bitget(a,lidx).

Extended Capabilities

C/C++ Code Generation

Generate C and C++ code using MATLAB® Coder™.

The indices lidx and ridx must be compile time constants.

HDL Code Generation

Generate VHDL, Verilog and SystemVerilog code for FPGA and ASIC designs using HDL Coder™.

The indices lidx and ridx must be compile time constants.

Version History

Introduced in R2007b

R2026b: bitsliceget supports built-in integer types

The bitsliceget function now accepts built-in integer types as inputs.