vsip_cblockfind_p - Get user data (complex)

Core

This manual is preliminary and incomplete.
While our Core implementation implements all functions given in the standard we are still working on completing this documentation.

Please refer to the VSIPL standard for a complete function reference of the Core profile until we have completed work on this documentation.

[next] [prev] [prev-tail] [tail] [up]

1.2.8 vsip_cblockfind_p - Get user data (complex)

void vsip_cblockfind_f(const vsip_cblock_f *p, vsip_scalar_f **rr, vsip_scalar_f **ri);

Description

This function queries the user data array(s) of the given complex block p. Depending on the data format, the function sets the pointers rr and ri accordingly:

If the data is in interleaved format, only rr will be set, and ri will be set to NULL.
If the data is in split format, both rr and ri will be set to point to the real and imaginary parts, respectively.

The block must have been bound previously and must be in the released state before calling this function.

Parameters

const vsip_cblock_p *p: Pointer to the complex block whose user data arrays are to be queried.
vsip_scalar_p **rr: Pointer to the real part of the user array.
vsip_scalar_p **ri: Pointer to the imaginary part of the user array.

Error Handling

On error, both rr and ri are set to NULL.

Example

vsip_cblock_f *block; 
vsip_scalar_f *real_part; 
vsip_scalar_f *imag_part; 
 
// Assuming block has been properly initialized, bound, and released 
vsip_cblockfind_f(block, &real_part, &imag_part); 
 
if (real_part == NULL) { 
    // Handle error 
}

[next] [prev] [prev-tail] [front] [up]