_doxygen/html/xs3__vect__complex__s32_8h_source.html

 // Copyright 2020-2021 XMOS LIMITED.

 // This Software is subject to the terms of the XMOS Public Licence: Version 1.


 #pragma once


 #include "xs3_math_conf.h"

 #include "xs3_math_types.h"

 #include "xs3_util.h"


 #ifdef __XC__

 extern "C" {

 #endif


 C_API

 headroom_t xs3_vect_complex_s32_add(

     complex_s32_t a[],

     const complex_s32_t b[],

     const complex_s32_t c[],

     const unsigned length,

     const right_shift_t b_shr,

     const right_shift_t c_shr);


 #define xs3_vect_complex_s32_add_prepare xs3_vect_s32_add_prepare


 C_API

 headroom_t xs3_vect_complex_s32_add_scalar(

     complex_s32_t a[],

     const complex_s32_t b[],

     const complex_s32_t c,

     const unsigned length,

     const right_shift_t b_shr);


 #define xs3_vect_complex_s32_add_scalar_prepare xs3_vect_s32_add_prepare


 C_API

 headroom_t xs3_vect_complex_s32_conj_mul(

     complex_s32_t a[],

     const complex_s32_t b[],

     const complex_s32_t c[],

     const unsigned length,

     const right_shift_t b_shr,

     const right_shift_t c_shr);


 #define xs3_vect_complex_s32_conj_mul_prepare xs3_vect_complex_s32_mul_prepare


 C_API

 headroom_t xs3_vect_complex_s32_headroom(

     const complex_s32_t x[],

     const unsigned length);


 C_API

 headroom_t xs3_vect_complex_s32_macc(

     complex_s32_t acc[],

     const complex_s32_t b[],

     const complex_s32_t c[],

     const unsigned length,

     const right_shift_t acc_shr,

     const right_shift_t b_shr,

     const right_shift_t c_shr);


 C_API

 headroom_t xs3_vect_complex_s32_nmacc(

     complex_s32_t acc[],

     const complex_s32_t b[],

     const complex_s32_t c[],

     const unsigned length,

     const right_shift_t acc_shr,

     const right_shift_t b_shr,

     const right_shift_t c_shr);


 C_API

 headroom_t xs3_vect_complex_s32_conj_macc(

     complex_s32_t acc[],

     const complex_s32_t b[],

     const complex_s32_t c[],

     const unsigned length,

     const right_shift_t acc_shr,

     const right_shift_t b_shr,

     const right_shift_t c_shr);


 C_API

 headroom_t xs3_vect_complex_s32_conj_nmacc(

     complex_s32_t acc[],

     const complex_s32_t b[],

     const complex_s32_t c[],

     const unsigned length,

     const right_shift_t acc_shr,

     const right_shift_t b_shr,

     const right_shift_t c_shr);


 C_API

 void xs3_vect_complex_s32_macc_prepare(

     exponent_t* new_acc_exp,

     right_shift_t* acc_shr,

     right_shift_t* b_shr,

     right_shift_t* c_shr,

     const exponent_t acc_exp,

     const exponent_t b_exp,

     const exponent_t c_exp,

     const exponent_t acc_hr,

     const headroom_t b_hr,

     const headroom_t c_hr);


 #define xs3_vect_complex_s32_nmacc_prepare xs3_vect_complex_s32_macc_prepare


 #define xs3_vect_complex_s32_conj_macc_prepare xs3_vect_complex_s32_macc_prepare


 #define xs3_vect_complex_s32_conj_nmacc_prepare xs3_vect_complex_s32_macc_prepare


 C_API

 headroom_t xs3_vect_complex_s32_mag(

     int32_t a[],

     const complex_s32_t b[],

     const unsigned length,

     const right_shift_t b_shr,

     const complex_s32_t* rot_table,

     const unsigned table_rows);


 C_API

 void xs3_vect_complex_s32_mag_prepare(

     exponent_t* a_exp,

     right_shift_t* b_shr,

     const exponent_t b_exp,

     const headroom_t b_hr);


 C_API

 headroom_t xs3_vect_complex_s32_mul(

     complex_s32_t a[],

     const complex_s32_t b[],

     const complex_s32_t c[],

     const unsigned length,

     const right_shift_t b_shr,

     const right_shift_t c_shr);


 C_API

 void xs3_vect_complex_s32_mul_prepare(

     exponent_t* a_exp,

     right_shift_t* b_shr,

     right_shift_t* c_shr,

     const exponent_t b_exp,

     const exponent_t c_exp,

     const headroom_t b_hr,

     const headroom_t c_hr);


 C_API

 headroom_t xs3_vect_complex_s32_real_mul(

     complex_s32_t a[],

     const complex_s32_t b[],

     const int32_t c[],

     const unsigned length,

     const right_shift_t b_shr,

     const right_shift_t c_shr);


 C_API

 void xs3_vect_complex_s32_real_mul_prepare(

     exponent_t* a_exp,

     right_shift_t* b_shr,

     right_shift_t* c_shr,

     const exponent_t b_exp,

     const exponent_t c_exp,

     const headroom_t b_hr,

     const headroom_t c_hr);


 C_API

 headroom_t xs3_vect_complex_s32_real_scale(

     complex_s32_t a[],

     const complex_s32_t b[],

     const int32_t c,

     const unsigned length,

     const right_shift_t b_shr,

     const right_shift_t c_shr);


 #define xs3_vect_complex_s32_real_scale_prepare xs3_vect_s32_mul_prepare


 C_API

 headroom_t xs3_vect_complex_s32_scale(

     complex_s32_t a[],

     const complex_s32_t b[],

     const int32_t c_real,

     const int32_t c_imag,

     const unsigned length,

     const right_shift_t b_shr,

     const right_shift_t c_shr);


 C_API

 void xs3_vect_complex_s32_scale_prepare(

     exponent_t* a_exp,

     right_shift_t* b_shr,

     right_shift_t* c_shr,

     const exponent_t b_exp,

     const exponent_t c_exp,

     const headroom_t b_hr,

     const headroom_t c_hr);


 C_API

 void xs3_vect_complex_s32_set(

     complex_s32_t a[],

     const int32_t b_real,

     const int32_t b_imag,

     const unsigned length);


 C_API

 headroom_t xs3_vect_complex_s32_shl(

     complex_s32_t a[],

     const complex_s32_t b[],

     const unsigned length,

     const left_shift_t b_shl);


 C_API

 headroom_t xs3_vect_complex_s32_shr(

     complex_s32_t a[],

     const complex_s32_t b[],

     const unsigned length,

     const right_shift_t b_shr);


 C_API

 headroom_t xs3_vect_complex_s32_squared_mag(

     int32_t a[],

     const complex_s32_t b[],

     const unsigned length,

     const right_shift_t b_shr);


 C_API

 void xs3_vect_complex_s32_squared_mag_prepare(

     exponent_t* a_exp,

     right_shift_t* b_shr,

     const exponent_t b_exp,

     const headroom_t b_hr);


 C_API

 headroom_t xs3_vect_complex_s32_sub(

     complex_s32_t a[],

     const complex_s32_t b[],

     const complex_s32_t c[],

     const unsigned length,

     const right_shift_t b_shr,

     const right_shift_t c_shr);


 #define xs3_vect_complex_s32_sub_prepare xs3_vect_s32_add_prepare


 C_API

 void xs3_vect_complex_s32_sum(

     complex_s64_t* a,

     const complex_s32_t b[],

     const unsigned length,

     const right_shift_t b_shr);


 C_API

 void xs3_vect_complex_s32_sum_prepare(

     exponent_t* a_exp,

     right_shift_t* b_shr,

     const exponent_t b_exp,

     const headroom_t b_hr,

     const unsigned length);


 C_API

 void xs3_vect_complex_s32_tail_reverse(

     complex_s32_t x[],

     const unsigned length);


 C_API

 headroom_t xs3_vect_complex_s32_conjugate(

     complex_s32_t a[],

     const complex_s32_t b[],

     const unsigned length);


 #ifdef __XC__

 }   //extern "C"

 #endif


exponent_t
int exponent_t
An exponent.
Definition: xs3_math_types.h:76

left_shift_t
int left_shift_t
A leftwards arithmetic bit-shift.
Definition: xs3_math_types.h:110

right_shift_t
int right_shift_t
A rightwards arithmetic bit-shift.
Definition: xs3_math_types.h:98

headroom_t
unsigned headroom_t
Headroom of some integer or integer array.
Definition: xs3_math_types.h:86

xs3_vect_complex_s32_add_scalar
headroom_t xs3_vect_complex_s32_add_scalar(complex_s32_t a[], const complex_s32_t b[], const complex_s32_t c, const unsigned length, const right_shift_t b_shr)
Add a scalar to a complex 32-bit vector.
Definition: xs3_vect.c:230

xs3_vect_complex_s32_real_scale
headroom_t xs3_vect_complex_s32_real_scale(complex_s32_t a[], const complex_s32_t b[], const int32_t c, const unsigned length, const right_shift_t b_shr, const right_shift_t c_shr)
Multiply a complex 32-bit vector by a real scalar.
Definition: xs3_vect.c:153

xs3_vect_complex_s32_shr
headroom_t xs3_vect_complex_s32_shr(complex_s32_t a[], const complex_s32_t b[], const unsigned length, const right_shift_t b_shr)
Right-shift each element of a complex 32-bit vector by a specified number of bits.
Definition: xs3_vect.c:173

xs3_vect_complex_s32_scale
headroom_t xs3_vect_complex_s32_scale(complex_s32_t a[], const complex_s32_t b[], const int32_t c_real, const int32_t c_imag, const unsigned length, const right_shift_t b_shr, const right_shift_t c_shr)
Multiply a complex 32-bit vector by a complex 32-bit scalar.
Definition: xs3_vect_complex_mul.c:257

xs3_vect_complex_s32_mul
headroom_t xs3_vect_complex_s32_mul(complex_s32_t a[], const complex_s32_t b[], const complex_s32_t c[], const unsigned length, const right_shift_t b_shr, const right_shift_t c_shr)
Multiply one complex 32-bit vector element-wise by another.
Definition: xs3_vect_complex_mul.c:187

xs3_vect_complex_s32_mag
headroom_t xs3_vect_complex_s32_mag(int32_t a[], const complex_s32_t b[], const unsigned length, const right_shift_t b_shr, const complex_s32_t *rot_table, const unsigned table_rows)
Compute the magnitude of each element of a complex 32-bit vector.
Definition: xs3_vect_complex_mag.c:74

xs3_vect_complex_s32_squared_mag
headroom_t xs3_vect_complex_s32_squared_mag(int32_t a[], const complex_s32_t b[], const unsigned length, const right_shift_t b_shr)
Computes the squared magnitudes of elements of a complex 32-bit vector.
Definition: xs3_vect_complex_mag.c:146

xs3_vect_complex_s32_macc
headroom_t xs3_vect_complex_s32_macc(complex_s32_t acc[], const complex_s32_t b[], const complex_s32_t c[], const unsigned length, const right_shift_t acc_shr, const right_shift_t b_shr, const right_shift_t c_shr)
Multiply one complex 32-bit vector element-wise by another, and add the result to an accumulator.
Definition: xs3_vect_complex_macc.c:97

xs3_vect_complex_s32_tail_reverse
void xs3_vect_complex_s32_tail_reverse(complex_s32_t x[], const unsigned length)
Reverses the order of the tail of a complex 32-bit vector.
Definition: xs3_fft_util.c:250

xs3_vect_complex_s32_conj_macc
headroom_t xs3_vect_complex_s32_conj_macc(complex_s32_t acc[], const complex_s32_t b[], const complex_s32_t c[], const unsigned length, const right_shift_t acc_shr, const right_shift_t b_shr, const right_shift_t c_shr)
Multiply one complex 32-bit vector element-wise by the complex conjugate of another,...
Definition: xs3_vect_complex_conj_macc.c:97

xs3_vect_complex_s32_nmacc
headroom_t xs3_vect_complex_s32_nmacc(complex_s32_t acc[], const complex_s32_t b[], const complex_s32_t c[], const unsigned length, const right_shift_t acc_shr, const right_shift_t b_shr, const right_shift_t c_shr)
Multiply one complex 32-bit vector element-wise by another, and subtract the result from an accumulat...
Definition: xs3_vect_complex_macc.c:129

xs3_vect_complex_s32_set
void xs3_vect_complex_s32_set(complex_s32_t a[], const int32_t b_real, const int32_t b_imag, const unsigned length)
Set each element of a complex 32-bit vector to a specified value.
Definition: xs3_vect_set.c:35

xs3_vect_complex_s32_headroom
headroom_t xs3_vect_complex_s32_headroom(const complex_s32_t x[], const unsigned length)
Calculate the headroom of a complex 32-bit array.
Definition: xs3_vect.c:145

xs3_vect_complex_s32_add
headroom_t xs3_vect_complex_s32_add(complex_s32_t a[], const complex_s32_t b[], const complex_s32_t c[], const unsigned length, const right_shift_t b_shr, const right_shift_t c_shr)
Add one complex 32-bit vector to another.
Definition: xs3_vect.c:132

xs3_vect_complex_s32_real_mul
headroom_t xs3_vect_complex_s32_real_mul(complex_s32_t a[], const complex_s32_t b[], const int32_t c[], const unsigned length, const right_shift_t b_shr, const right_shift_t c_shr)
Multiply a complex 32-bit vector element-wise by a real 32-bit vector.
Definition: xs3_vect_complex_mul.c:159

xs3_vect_complex_s32_shl
headroom_t xs3_vect_complex_s32_shl(complex_s32_t a[], const complex_s32_t b[], const unsigned length, const left_shift_t b_shl)
Left-shift each element of a complex 32-bit vector by a specified number of bits.
Definition: xs3_vect.c:164

xs3_vect_complex_s32_conjugate
headroom_t xs3_vect_complex_s32_conjugate(complex_s32_t a[], const complex_s32_t b[], const unsigned length)
Get the complex conjugate of a complex 32-bit vector.
Definition: xs3_vect_complex_conjugate.c:13

xs3_vect_complex_s32_sum
void xs3_vect_complex_s32_sum(complex_s64_t *a, const complex_s32_t b[], const unsigned length, const right_shift_t b_shr)
Compute the sum of elements of a complex 32-bit vector.
Definition: xs3_vect_complex_sum.c:29

xs3_vect_complex_s32_conj_nmacc
headroom_t xs3_vect_complex_s32_conj_nmacc(complex_s32_t acc[], const complex_s32_t b[], const complex_s32_t c[], const unsigned length, const right_shift_t acc_shr, const right_shift_t b_shr, const right_shift_t c_shr)
Multiply one complex 32-bit vector element-wise by the complex conjugate of another,...
Definition: xs3_vect_complex_conj_macc.c:129

xs3_vect_complex_s32_sub
headroom_t xs3_vect_complex_s32_sub(complex_s32_t a[], const complex_s32_t b[], const complex_s32_t c[], const unsigned length, const right_shift_t b_shr, const right_shift_t c_shr)
Subtract one complex 32-bit vector from another.
Definition: xs3_vect.c:183

xs3_vect_complex_s32_conj_mul
headroom_t xs3_vect_complex_s32_conj_mul(complex_s32_t a[], const complex_s32_t b[], const complex_s32_t c[], const unsigned length, const right_shift_t b_shr, const right_shift_t c_shr)
Multiply one complex 32-bit vector element-wise by the complex conjugate of another.
Definition: xs3_vect_complex_mul.c:221

xs3_vect_complex_s32_sum_prepare
void xs3_vect_complex_s32_sum_prepare(exponent_t *a_exp, right_shift_t *b_shr, const exponent_t b_exp, const headroom_t b_hr, const unsigned length)
Obtain the output exponent and input shift used by xs3_vect_complex_s32_sum().
Definition: xs3_complex_prepare.c:416

xs3_vect_complex_s32_macc_prepare
void xs3_vect_complex_s32_macc_prepare(exponent_t *new_acc_exp, right_shift_t *acc_shr, right_shift_t *b_shr, right_shift_t *c_shr, const exponent_t acc_exp, const exponent_t b_exp, const exponent_t c_exp, const exponent_t acc_hr, const headroom_t b_hr, const headroom_t c_hr)
Obtain the output exponent and shifts needed by xs3_vect_complex_s32_macc().
Definition: xs3_complex_prepare.c:199

xs3_vect_complex_s32_squared_mag_prepare
void xs3_vect_complex_s32_squared_mag_prepare(exponent_t *a_exp, right_shift_t *b_shr, const exponent_t b_exp, const headroom_t b_hr)
Obtain the output exponent and input shift used by xs3_vect_complex_s32_squared_mag().
Definition: xs3_complex_prepare.c:386

xs3_vect_complex_s32_real_mul_prepare
void xs3_vect_complex_s32_real_mul_prepare(exponent_t *a_exp, right_shift_t *b_shr, right_shift_t *c_shr, const exponent_t b_exp, const exponent_t c_exp, const headroom_t b_hr, const headroom_t c_hr)
Obtain the output exponent and input shifts used by xs3_vect_complex_s32_real_mul().
Definition: xs3_complex_prepare.c:270

xs3_vect_complex_s32_mag_prepare
void xs3_vect_complex_s32_mag_prepare(exponent_t *a_exp, right_shift_t *b_shr, const exponent_t b_exp, const headroom_t b_hr)
Obtain the output exponent and input shift used by xs3_vect_complex_s32_mag() and xs3_vect_complex_s1...
Definition: xs3_complex_prepare.c:257

xs3_vect_complex_s32_mul_prepare
void xs3_vect_complex_s32_mul_prepare(exponent_t *a_exp, right_shift_t *b_shr, right_shift_t *c_shr, const exponent_t b_exp, const exponent_t c_exp, const headroom_t b_hr, const headroom_t c_hr)
Obtain the output exponent and input shifts used by xs3_vect_complex_s32_mul() and xs3_vect_complex_s...
Definition: xs3_complex_prepare.c:307

xs3_vect_complex_s32_scale_prepare
void xs3_vect_complex_s32_scale_prepare(exponent_t *a_exp, right_shift_t *b_shr, right_shift_t *c_shr, const exponent_t b_exp, const exponent_t c_exp, const headroom_t b_hr, const headroom_t c_hr)
Obtain the output exponent and input shifts used by xs3_vect_complex_s32_scale().
Definition: xs3_complex_prepare.c:350

complex_s32_t
A complex number with a 32-bit real part and 32-bit imaginary part.
Definition: xs3_math_types.h:49

complex_s64_t
A complex number with a 64-bit real part and 64-bit imaginary part.
Definition: xs3_math_types.h:38