Get DATA Packet - 7.2 English

FIR Compiler (PG149)

Document ID
PG149
Release Date
2022-10-26
Version
7.2 English

xip_status

xip_fir_v7_2_data_get(

xip_fir_v7_2* model,

xip_array_real* data,

xip_array_complex* cmplx_data

);

xip_status

xip_fir_v7_2_data_get_mpz(

xip_fir_v7_2* model,

xip_array_mpz* data,

xip_array_mpz_complex* cmplx_data

);

This function retrieves a filtered data packet from the model into the xip_array_<type> pointed to by data or cmplx_data . Only one of data or cmplx_data maybe set, the other should be set to NULL (or 0).

The size of the array dim[2] ( This Figure ) determines how much data is fetched from the model. If the request is greater than available, then the array size is reduced to reflect this. The model does not modify the amount of space allocated. Both versions of the functions maybe used regardless of the internal implementation method of the model. If double data ( xip_real ) is requested when mpz_t (xip_mpz) has been used internally by the model the output data is truncated, as per the mpz_get_d function (see [Ref 15] ).

mpz_t (xip_mpz) is an integer type so the model scales the input data and coefficients by their specified fractional width to use an integer representation. The output is also supplied as an integer value when mpz_t is requested. To correctly interpret the mpz_t output the model configuration, returned by the xip_fir_v7_2_get_config function (see Get Model Configuration ), should be interrogated to determine the output fractional width.