# Determine Fixed-Point Types for Complex Q-less QR Matrix Solve with Tikhonov Regularization

This example shows how to use the `fixed.complexQlessQRMatrixSolveFixedpointTypes` function to analytically determine fixed-point types for the solution of the complex least-squares matrix equation

`${\left[\begin{array}{c}\lambda {I}_{n}\\ A\end{array}\right]}^{H}\left[\begin{array}{c}\lambda {I}_{n}\\ A\end{array}\right]X=\left({\lambda }^{2}{I}_{n}+{A}^{H}A\right)X=B$`

where $A$ is an $m$-by-$n$ matrix with $m\ge n$, $B$ is $n$-by-$p$, $X$ is $n$-by-$p$, ${I}_{n}=\text{eye}\left(n\right)$, and $\lambda$ is a regularization parameter.

### Define System Parameters

Define the matrix attributes and system parameters for this example.

`m` is the number of rows in matrix `A`. In a problem such as beamforming or direction finding, `m` corresponds to the number of samples that are integrated over.

`m = 300;`

`n` is the number of columns in matrix `A` and rows in matrices B and `X`. In a least-squares problem, `m` is greater than `n`, and usually `m` is much larger than `n`. In a problem such as beamforming or direction finding, `n` corresponds to the number of sensors.

`n = 10;`

`p` is the number of columns in matrices `B` and `X`. It corresponds to simultaneously solving a system with `p` right-hand sides.

`p = 1;`

In this example, set the rank of matrix `A` to be less than the number of columns. In a problem such as beamforming or direction finding, $\text{rank}\left(A\right)$ corresponds to the number of signals impinging on the sensor array.

`rankA = 3;`

`precisionBits` defines the number of bits of precision required for the matrix solve. Set this value according to system requirements.

`precisionBits = 32;`

Small, positive values of the regularization parameter can improve the conditioning of the problem and reduce the variance of the estimates. While biased, the reduced variance of the estimate often results in a smaller mean squared error when compared to least-squares estimates.

`regularizationParameter = 0.01;`

In this example, complex-valued matrices `A` and `B` are constructed such that the magnitude of the real and imaginary parts of their elements is less than or equal to one, so the maximum possible absolute value of any element is $|1+1i|=\sqrt{2}$. Your own system requirements will define what those values are. If you don't know what they are, and `A` and `B` are fixed-point inputs to the system, then you can use the `upperbound` function to determine the upper bounds of the fixed-point types of `A` and `B`.

`max_abs_A` is an upper bound on the maximum magnitude element of A.

`max_abs_A = sqrt(2);`

`max_abs_B` is an upper bound on the maximum magnitude element of B.

`max_abs_B = sqrt(2);`

Thermal noise standard deviation is the square root of thermal noise power, which is a system parameter. A well-designed system has the quantization level lower than the thermal noise. Here, set `thermalNoiseStandardDeviation` to the equivalent of $-50$dB noise power.

`thermalNoiseStandardDeviation = sqrt(10^(-50/10))`
```thermalNoiseStandardDeviation = 0.0032 ```

The quantization noise standard deviation is a function of the required number of bits of precision. Use `fixed.complexQuantizationNoiseStandardDeviation` to compute this. See that it is less than `thermalNoiseStandardDeviation`.

`quantizationNoiseStandardDeviation = fixed.complexQuantizationNoiseStandardDeviation(precisionBits)`
```quantizationNoiseStandardDeviation = 9.5053e-11 ```

### Compute Fixed-Point Types

In this example, assume that the designed system matrix $A$ does not have full rank (there are fewer signals of interest than number of columns of matrix $A$), and the measured system matrix $A$ has additive thermal noise that is larger than the quantization noise. The additive noise makes the measured matrix $A$ have full rank.

Set .

`noiseStandardDeviation = thermalNoiseStandardDeviation;`

Use the `fixed.complexQlessQRMatrixSolveFixedpointTypes` function to compute fixed-point types.

```T = fixed.complexQlessQRMatrixSolveFixedpointTypes(m,n,max_abs_A,max_abs_B,... precisionBits,noiseStandardDeviation,[],regularizationParameter)```
```T = struct with fields: A: [0x0 embedded.fi] B: [0x0 embedded.fi] X: [0x0 embedded.fi] ```

`T.A` is the type computed for transforming $\left[\begin{array}{c}\lambda {I}_{n}\\ A\end{array}\right]$ to $R={Q}^{H}\left[\begin{array}{c}\lambda {I}_{n}\\ A\end{array}\right]$ in-place so that it does not overflow.

`T.A`
```ans = [] DataTypeMode: Fixed-point: binary point scaling Signedness: Signed WordLength: 40 FractionLength: 32 ```

`T.B` is the type computed for B so that it does not overflow.

`T.B`
```ans = [] DataTypeMode: Fixed-point: binary point scaling Signedness: Signed WordLength: 35 FractionLength: 32 ```

`T.X` is the type computed for the solution $X=\left({\left[\begin{array}{c}\lambda {I}_{n}\\ A\end{array}\right]}^{H}\left[\begin{array}{c}\lambda {I}_{n}\\ A\end{array}\right]\right)\B$ so that there is a low probability that it overflows.

`T.X`
```ans = [] DataTypeMode: Fixed-point: binary point scaling Signedness: Signed WordLength: 48 FractionLength: 32 ```

### Use the Specified Types to Solve the Matrix Equation

Create random matrices `A` and `B` such that `rankA=rank(A)`. Add random measurement noise to `A` which will make it become full rank.

```rng('default'); [A,B] = fixed.example.complexRandomQlessQRMatrices(m,n,p,rankA); A = A + fixed.example.complexNormalRandomArray(0,noiseStandardDeviation,m,n);```

Cast the inputs to the types determined by `fixed.complexQlessQRMatrixSolveFixedpointTypes`. Quantizing to fixed-point is equivalent to adding random noise.

```A = cast(A,'like',T.A); B = cast(B,'like',T.B);```

Accelerate the `fixed.qlessQRMatrixSolve` function by using `fiaccel` to generate a MATLAB executable (MEX) function.

`fiaccel +fixed/qlessQRMatrixSolve -args {A,B,T.X,[],regularizationParameter} -o qlessQRMatrixSolve_mex`

Specify output type `T.X` and compute fixed-point $X=\left({\left[\begin{array}{c}\lambda {I}_{n}\\ A\end{array}\right]}^{H}\left[\begin{array}{c}\lambda {I}_{n}\\ A\end{array}\right]\right)\B$ using the QR method.

`X = qlessQRMatrixSolve_mex(A,B,T.X,[],regularizationParameter);`

### Verify the Accuracy of the Output

Verify that the relative error between the fixed-point output and builtin MATLAB in double-precision floating-point is small.

`${X}_{\text{double}}=\left({\left[\begin{array}{c}\lambda {I}_{n}\\ A\end{array}\right]}^{H}\left[\begin{array}{c}\lambda {I}_{n}\\ A\end{array}\right]\right)\B$`

```A_lambda = double([regularizationParameter*eye(n);A]); X_double = (A_lambda'*A_lambda)\double(B); relativeError = norm(X_double - double(X))/norm(X_double)```
```relativeError = 1.0591e-05 ```

Suppress `mlint` warnings in this file.

```%#ok<*NASGU> %#ok<*ASGLU>```