The following table shows the types defined for the CIC Compiler C model.
| Name | Type | Description |
|---|---|---|
| xip_real | Double | Used for data sample values input to the CIC and for the double-precision data output. |
| xip_cic_v4_0_config | Struct | Structure of configuration parameters. |
| xip_cic_v4_0_rate_packet | Struct | Data structure of the rate value input to the core at runtime for programmable-rate filters. |
| xip_status | Int | Error code returned from many C model functions. 0 indicates success. Any other value indicates failure. |
| xip_array_real | Struct | Structure used to hold data for input to the CIC |
| xip_array_mpz | Struct | Structure used to hold the arbitrary-precision (mpz) integer data output from the CIC. |
| xip_cic_v4_0 | Struct | Type defined which C (not C++) can use as a handle (pointer) to a C++ object – the C model itself. |
xip_cic_v4_0_config is the configuration of the core
itself. The members of this structure are listed in the
cic_compiler_v4_0_bitacc_cmodel file. The names closely match the same
names in the XCO/XCI files. The cic_compiler_v4_0_bitacc_cmodel file also
contains #define values for enumerated fields.
xip_array_real and
xip_array_mpz are structures whose principal members are:
-
data - A pointer to the array of data values.
-
data_size - Of type
size_t, which describes the number of valid elements in the data array. -
dim - A pointer to a
size_tarray of values that indicate the size of each dimension. -
dim_size (size_t) - Indicates the number of dimensions of the data array.