# fixed.realQlessQRMatrixSolveFixedpointTypes

Determine fixed-point types for matrix solution of real-valued A'AX=B using QR decomposition

## Syntax

``T = fixed.realQlessQRMatrixSolveFixedpointTypes(m,n,max_abs_A,max_abs_B,precisionBits)``
``T = fixed.realQlessQRMatrixSolveFixedpointTypes(___,noiseStandardDeviation,p_s)``
``T = fixed.realQlessQRMatrixSolveFixedpointTypes(m,n,max_abs_A,max_abs_B,precisionBits,noiseStandardDeviation,p_s,regularizationParameter)``

## Description

example

````T = fixed.realQlessQRMatrixSolveFixedpointTypes(m,n,max_abs_A,max_abs_B,precisionBits)` computes fixed-point types for the matrix solution of real-valued A'AX=B using QR decomposition. T is returned as a struct with fields that specify fixed-point types for A and B that guarantee no overflow will occur in the QR algorithm transforming A in-place into upper-triangular R, where QR=A is the QR decomposition of X, and X such that there is a low probability of overflow.```

example

````T = fixed.realQlessQRMatrixSolveFixedpointTypes(___,noiseStandardDeviation,p_s)` specifies the standard deviation of the additive random noise in A and the probability that the estimate of the lower bound for the smallest singular value of A is larger than the actual smallest singular value of the matrix.```

example

````T = fixed.realQlessQRMatrixSolveFixedpointTypes(m,n,max_abs_A,max_abs_B,precisionBits,noiseStandardDeviation,p_s,regularizationParameter)` computes fixed-point types for the matrix solution of real-valued ${\left[\begin{array}{c}\lambda {I}_{n}\\ A\end{array}\right]}^{\text{'}}\cdot \left[\begin{array}{c}\lambda {I}_{n}\\ A\end{array}\right]X=\left({\lambda }^{2}{I}_{n}+A\text{'}A\right)X=B$ where λ is the `regularizationParameter`, A is an m-by-n matrix, and In = `eye(n)`.`noiseStandardDeviation`, `p_s`, and `regularizationParameter` are optional parameters. If not supplied or empty, then their default values are used.```

## Examples

collapse all

This example shows the algorithms that the `fixed.realQlessQRMatrixSolveFixedpointTypes` function uses to analytically determine fixed-point types for the solution of the real matrix equation ${A}^{\prime }AX=B$, where $A$ is an $m$-by-$n$ matrix with $m>n$, $B$ is $n$-by-$p$, and $X$ is $n$-by-$p$.

Overview

You can solve the fixed-point matrix equation ${A}^{\prime }AX=B$ using QR decomposition. Using a sequence of orthogonal transformations, QR decomposition transforms matrix $A$ in-place to upper triangular $R$, where $QR=A$ is the economy-size QR decomposition. This reduces the equation to an upper-triangular system of equations ${R}^{\prime }RX=B$. To solve for $X$, compute $X=R\\left({R}^{\prime }\B\right)$ through forward- and backward-substitution of $R$ into $B$.

You can determine appropriate fixed-point types for the matrix equation ${A}^{\prime }AX=B$ by selecting the fraction length based on the number of bits of precision defined by your requirements. The `fixed.realQlessQRMatrixSolveFixedpointTypes` function analytically computes the following upper bounds on $R$, and $X$ to determine the number of integer bits required to avoid overflow [1,2,3].

The upper bound for the magnitude of the elements of $R={Q}^{\prime }A$ is

$\mathrm{max}\left(|R\left(:\right)|\right)\le \sqrt{m}\mathrm{max}\left(|A\left(:\right)|\right)$.

The upper bound for the magnitude of the elements of $X=\left({A}^{\prime }A\right)\B$ is

$\mathrm{max}\left(|X\left(:\right)|\right)\le \frac{\sqrt{n}\mathrm{max}\left(|B\left(:\right)|\right)}{\mathrm{min}\left(\text{svd}\left(A\right){\right)}^{2}}$.

Since computing $\text{svd}\left(A\right)$ is more computationally expensive than solving the system of equations, the `fixed.realQlessQRMatrixSolveFixedpointTypes` function estimates a lower bound of $\mathrm{min}\left(\text{svd}\left(A\right)\right)$.

Fixed-point types for the solution of the matrix equation $\left({A}^{\prime }A\right)X=B$ are generally well-bounded if the number of rows, $m$, of $A$ are much greater than the number of columns, $n$ (i.e. $m\gg n$), and $A$ is full rank. If $A$ is not inherently full rank, then it can be made so by adding random noise. Random noise naturally occurs in physical systems, such as thermal noise in radar or communications systems. If $m=n$, then the dynamic range of the system can be unbounded, for example in the scalar equation $x={a}^{2}/b$ and $a,b\in \left[-1,1\right]$, then $x$ can be arbitrarily large if $b$ is close to $0$.

Proofs of the Bounds

Properties and Definitions of Vector and Matrix Norms

The proofs of the bounds use the following properties and definitions of matrix and vector norms, where $Q$ is an orthogonal matrix, and $v$ is a vector of length $m$ [6].

`$\begin{array}{lcl}||Av|{|}_{2}& \le & ||A|{|}_{2}||v|{|}_{2}\\ ||Q|{|}_{2}& =& 1\\ ||v|{|}_{\infty }& =& \mathrm{max}\left(|v\left(:\right)|\right)\\ ||v|{|}_{\infty }& \le & ||v|{|}_{2}\phantom{\rule{0.2777777777777778em}{0ex}}\le \phantom{\rule{0.2777777777777778em}{0ex}}\sqrt{m}||v|{|}_{\infty }\end{array}$`

If $A$ is an $m$-by-$n$ matrix and $QR=A$ is the economy-size QR decomposition of $A$, where $Q$ is orthogonal and $m$-by-$n$ and $R$ is upper-triangular and $n$-by-$n$, then the singular values of $R$ are equal to the singular values of $A$. If $A$ is nonsingular, then

`$||{R}^{-1}|{|}_{2}=||\left({R}^{\prime }{\right)}^{-1}|{|}_{2}=\frac{1}{\mathrm{min}\left(\text{svd}\left(R\right)\right)}=\frac{1}{\mathrm{min}\left(\text{svd}\left(A\right)\right)}$`

Upper Bound for R = Q'A

The upper bound for the magnitude of the elements of $R$ is

$\mathrm{max}\left(|R\left(:\right)|\right)\le \sqrt{m}\mathrm{max}\left(|A\left(:\right)|\right)$.

Proof of Upper Bound for R = Q'A

The $j$th column of $R$ is equal to $R\left(:,j\right)={Q}^{\prime }A\left(:,j\right)$, so

`$\begin{array}{rcl}\mathrm{max}\left(|R\left(:,j\right)|\right)& =& ||R\left(:,j\right)|{|}_{\infty }\\ & \le & ||R\left(:,j\right)|{|}_{2}\\ & =& ||{Q}^{\prime }A\left(:,j\right)|{|}_{2}\\ & \le & ||{Q}^{\prime }|{|}_{2}||A\left(:,j\right)|{|}_{2}\\ & =& ||A\left(:,j\right)|{|}_{2}\\ & \le & \sqrt{m}||A\left(:,j\right)|{|}_{\infty }\\ & =& \sqrt{m}\mathrm{max}\left(|A\left(:,j\right)|\right)\\ & \le & \sqrt{m}\mathrm{max}\left(|A\left(:\right)|\right).\end{array}$`

Since $\mathrm{max}\left(|R\left(:,j\right)|\right)\le \sqrt{m}\mathrm{max}\left(|A\left(:\right)|\right)$ for all $1\le j$, then

`$\mathrm{max}\left(|R\left(:\right)|\right)\le \sqrt{m}\mathrm{max}\left(|A\left(:\right)|\right).$`

Upper Bound for X = (A'A)\B

The upper bound for the magnitude of the elements of $X=\left({A}^{\prime }A\right)\B$ is

$\mathrm{max}\left(|X\left(:\right)|\right)\le \frac{\sqrt{n}\mathrm{max}\left(|B\left(:\right)|\right)}{\mathrm{min}\left(\text{svd}\left(A\right){\right)}^{2}}$.

Proof of Upper Bound for X = (A'A)\B

If $A$ is not full rank, then $\mathrm{min}\left(\text{svd}\left(A\right)\right)=0$, and if $B$ is not equal to zero, then $\sqrt{n}\mathrm{max}\left(|B\left(:\right)|\right)/\mathrm{min}\left(\text{svd}\left(A\right){\right)}^{2}=\infty$and so the inequality is true.

If ${A}^{\prime }Ax=b$ and $QR=A$ is the economy-size QR decomposition of $A$, then ${A}^{\prime }Ax={R}^{\prime }{Q}^{\prime }QRx={R}^{\prime }Rx=b$. If $A$ is full rank then $x={R}^{-1}\cdot \left(\left({R}^{\prime }{\right)}^{-1}b\right)$. Let $x=X\left(:,j\right)$ be the $j$th column of $X$, and $b=B\left(:,j\right)$ be the $j$th column of $B$. Then

`$\begin{array}{rcl}\mathrm{max}\left(|x\left(:\right)|\right)& =& ||x|{|}_{\infty }\\ & \le & ||x|{|}_{2}\\ & =& ||{R}^{-1}\cdot \left(\left({R}^{\prime }{\right)}^{-1}b\right)|{|}_{2}\\ & \le & ||{R}^{-1}|{|}_{2}||\left({R}^{\prime }{\right)}^{-1}|{|}_{2}||b|{|}_{2}\\ & =& \left(1/\mathrm{min}\left(\text{svd}\left(A\right){\right)}^{2}\right)\cdot ||b|{|}_{2}\\ & =& ||b|{|}_{2}/\mathrm{min}\left(\text{svd}\left(A\right){\right)}^{2}\\ & \le & \sqrt{n}||b|{|}_{\infty }/\mathrm{min}\left(\text{svd}\left(A\right){\right)}^{2}\\ & =& \sqrt{n}\mathrm{max}\left(|b\left(:\right)|\right)/\mathrm{min}\left(\text{svd}\left(A\right){\right)}^{2}.\end{array}$`

Since $\mathrm{max}\left(|x\left(:\right)|\right)\le \sqrt{n}\mathrm{max}\left(|b\left(:\right)|\right)/\mathrm{min}\left(\text{svd}\left(A\right){\right)}^{2}$ for all rows and columns of $B$ and $X$, then

$\mathrm{max}\left(|X\left(:\right)|\right)\le \frac{\sqrt{n}\mathrm{max}\left(|B\left(:\right)|\right)}{\mathrm{min}\left(\text{svd}\left(A\right){\right)}^{2}}$.

Lower Bound for min(svd(A))

You can estimate a lower bound $s$ of $\mathrm{min}\left(\text{svd}\left(A\right)\right)$for real-valued $A$ using the following formula,

`$s={\sigma }_{N}\sqrt{2{\gamma }^{-1}\left(\frac{{p}_{s}\phantom{\rule{0.16666666666666666em}{0ex}}\Gamma \left(m-n+1\right)\Gamma \left(n/2\right)}{{2}^{m-n}\Gamma \left(\frac{m+1}{2}\right)\Gamma \left(\frac{m-n+1}{2}\right)},\phantom{\rule{0.2777777777777778em}{0ex}}\frac{m-n+1}{2}\right)}$`

where ${\sigma }_{N}$ is the standard deviation of random noise added to the elements of $A$, $1-{p}_{s}$ is the probability that $s\le \mathrm{min}\left(\text{svd}\left(A\right)\right)$, $\Gamma$ is the `gamma` function, and ${\gamma }^{-1}$is the inverse incomplete gamma function `gammaincinv`.

The proof is found in [1]. It is derived by integrating the formula in Lemma 3.3 from [3] and rearranging terms.

Since $s\le \mathrm{min}\left(\text{svd}\left(A\right)\right)$ with probability $1-{p}_{s}$, then you can bound the magnitude of the elements of $X$ without computing $\text{svd}\left(A\right)$,

$\mathrm{max}\left(|X\left(:\right)|\right)\le \frac{\sqrt{n}\mathrm{max}\left(|B\left(:\right)|\right)}{\mathrm{min}\left(\text{svd}\left(A\right){\right)}^{2}}\le \frac{\sqrt{n}\mathrm{max}\left(|B\left(:\right)|\right)}{{s}^{2}}$ with probability $1-{p}_{s}$.

You can compute $s$ using the `fixed.realSingularValueLowerBound` function which uses a default probability of 5 standard deviations below the mean, ${p}_{s}=\left(1+\text{erf}\left(-5/\sqrt{2}\right)\right)/2\approx 2.8665\cdot 1{0}^{-7}$, so the probability that the estimated bound for the smallest singular value $s$ is less than the actual smallest singular value of $A$ is $1-{p}_{s}\approx 0.9999997$.

Example

This example runs a simulation with many random matrices and compares the analytical bounds with the actual singular values of $A$ and the actual largest elements of $R={Q}^{\prime }A$, and $X=\left({A}^{\prime }A\right)\B$.

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 = 24;`

In this example, real-valued matrices `A` and `B` are constructed such that the magnitude of their elements is less than or equal to one. 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 = 1; `

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

`max_abs_B = 1;`

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 standard deviation of the noise from quantizing a real signal is ${2}^{-\text{precisionBits}}/\sqrt{12}$ [4,5]. Use `fixed.realQuantizationNoiseStandardDeviation` to compute this. See that it is less than `thermalNoiseStandardDeviation`.

`quantizationNoiseStandardDeviation = fixed.realQuantizationNoiseStandardDeviation(precisionBits)`
```quantizationNoiseStandardDeviation = 1.7206e-08 ```

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 `fixed.realQlessQRMatrixSolveFixedpointTypes` to compute fixed-point types.

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

`T.A` is the type computed for transforming $\mathit{A}$ to $\mathit{R}$ in-place so that it does not overflow.

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

`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: 27 FractionLength: 24 ```

`T.X` is the type computed for the solution $X=\left({A}^{\prime }A\right)\B$ so that there is a low probability that it overflows.

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

Upper Bound for R

The upper bound for $R$ is computed using the formula $\mathrm{max}\left(|R\left(:\right)|\right)\le \sqrt{m}\mathrm{max}\left(|A\left(:\right)|\right)$, where $m$ is the number of rows of matrix $A$. This upper bound is used to select a fixed-point type with the required number of bits of precision to avoid an overflow in the upper bound.

`upperBoundR = sqrt(m)*max_abs_A`
```upperBoundR = 17.3205 ```

Lower Bound for min(svd(A)) for Real A

A lower bound for $\mathrm{min}\left(\text{svd}\left(A\right)\right)$ is estimated by the `fixed.realSingularValueLowerBound` function using a probability that the estimate $s$ is not greater than the actual smallest singular value. The default probability is 5 standard deviations below the mean. You can change this probability by specifying it as the last input parameter to the `fixed.realSingularValueLowerBound` function.

`estimatedSingularValueLowerBound = fixed.realSingularValueLowerBound(m,n,noiseStandardDeviation)`
```estimatedSingularValueLowerBound = 0.0371 ```

Simulate and Compare to the Computed Bounds

The bounds are within an order of magnitude of the simulated results. This is sufficient because the number of bits translates to a logarithmic scale relative to the range of values. Being within a factor of 10 is between 3 and 4 bits. This is a good starting point for specifying a fixed-point type. If you run the simulation for more samples, then it is more likely that the simulated results will be closer to the bound. This example uses a limited number of simulations so it doesn't take too long to run. For real-world system design, you should run additional simulations.

Define the number of samples, `numSamples`, over which to run the simulation.

`numSamples = 1e4;`

Run the simulation.

```[actualMaxR,singularValues,X_values] = runSimulations(m,n,p,rankA,max_abs_A,max_abs_B,numSamples,... noiseStandardDeviation,T);```

You can see that the upper bound on $R$ compared to the measured simulation results of the maximum value of $R$ over all runs is within an order of magnitude.

`upperBoundR`
```upperBoundR = 17.3205 ```
`max(actualMaxR)`
```ans = 8.1682 ```

Finally, see that the estimated lower bound of $\mathrm{min}\left(\text{svd}\left(A\right)\right)$ compared to the measured simulation results of $\mathrm{min}\left(\text{svd}\left(A\right)\right)$ over all runs is also within an order of magnitude.

`estimatedSingularValueLowerBound`
```estimatedSingularValueLowerBound = 0.0371 ```
`actualSmallestSingularValue = min(singularValues,[],'all')`
```actualSmallestSingularValue = 0.0421 ```

Plot the distribution of the singular values over all simulation runs. The distributions of the largest singular values correspond to the signals that determine the rank of the matrix. The distributions of the smallest singular values correspond to the noise. The derivation of the estimated bound of the smallest singular value makes use of the random nature of the noise.

```clf fixed.example.plot.singularValueDistribution(m,n,rankA,... noiseStandardDeviation,singularValues,... estimatedSingularValueLowerBound,"real");```

Zoom in to the smallest singular value to see that the estimated bound is close to it.

`xlim([estimatedSingularValueLowerBound*0.9, max(singularValues(n,:))]);`

Estimate the largest value of the solution, X, and compare it to the largest value of X found during the simulation runs. The estimation is within an order of magnitude of the actual value, which is sufficient for estimating a fixed-point data type, because it is between 3 and 4 bits.

This example uses a limited number of simulation runs. With additional simulation runs, the actual largest value of X will approach the estimated largest value of X.

`estimated_largest_X = fixed.realQlessQRMatrixSolveUpperBoundX(m,n,max_abs_B,noiseStandardDeviation)`
```estimated_largest_X = 7.2565e+03 ```
`actual_largest_X = max(abs(X_values),[],'all')`
```actual_largest_X = 582.6761 ```

Plot the distribution of X values and compare it to the estimated upper bound for X.

```clf fixed.example.plot.xValueDistribution(m,n,rankA,noiseStandardDeviation,... X_values,estimated_largest_X,"real normally distributed random");```

Supporting Functions

The `runSimulations` function creates a series of random matrices $A$ and $B$ of a given size and rank, quantizes them according to the computed types, computes the QR decomposition of $A$, and solves the equation ${A}^{\prime }AX=B$. It returns the maximum values of $R={Q}^{\prime }A$, the singular values of $A$, and the values of $X$ so their distributions can be plotted and compared to the bounds.

```function [actualMaxR,singularValues,X_values] = runSimulations(m,n,p,rankA,max_abs_A,max_abs_B,... numSamples,noiseStandardDeviation,T) precisionBits = T.A.FractionLength; A_WordLength = T.A.WordLength; B_WordLength = T.B.WordLength; actualMaxR = zeros(1,numSamples); singularValues = zeros(n,numSamples); X_values = zeros(n,numSamples); for j = 1:numSamples A = max_abs_A*fixed.example.realRandomLowRankMatrix(m,n,rankA); % Adding random noise makes A non-singular. A = A + fixed.example.realNormalRandomArray(0,noiseStandardDeviation,m,n); A = quantizenumeric(A,1,A_WordLength,precisionBits); B = fixed.example.realUniformRandomArray(-max_abs_B,max_abs_B,n,p); B = quantizenumeric(B,1,B_WordLength,precisionBits); [~,R] = qr(A,0); X = R\(R'\B); actualMaxR(j) = max(abs(R(:))); singularValues(:,j) = svd(A); X_values(:,j) = X; end end```

References

1. Thomas A. Bryan and Jenna L. Warren. “Systems and Methods for Design Parameter Selection”. Patent pending. U.S. Patent Application No. 16/947,130. 2020.

2. Perform QR Factorization Using CORDIC. Derivation of the bound on growth when computing QR. MathWorks. 2010. url: https://www.mathworks.com/help/fixedpoint/examples/perform-qr-factorization-using-cordic.html.

3. Zizhong Chen and Jack J. Dongarra. “Condition Numbers of Gaussian Random Matrices”. In: SIAM J. Matrix Anal. Appl. 27.3 (July 2005), pp. 603–620. issn: 0895-4798. doi: 10.1137/040616413. url: http://dx.doi.org/10.1137/040616413.

4. Bernard Widrow. “A Study of Rough Amplitude Quantization by Means of Nyquist Sampling Theory”. In: IRE Transactions on Circuit Theory 3.4 (Dec. 1956), pp. 266–276.

5. Bernard Widrow and István Kollár. Quantization Noise – Roundoff Error in Digital Computation, Signal Processing, Control, and Communications. Cambridge, UK: Cambridge University Press, 2008.

6. Gene H. Golub and Charles F. Van Loan. Matrix Computations. Second edition. Baltimore: Johns Hopkins University Press, 1989.

Suppress mlint warnings in this file.

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

This example shows how to use the `fixed.realQlessQRMatrixSolveFixedpointTypes` function to analytically determine fixed-point types for the solution of the real least-squares matrix equation ${A}^{\prime }AX=B$, where $A$ is an $m$-by-$n$ matrix with $m\ge n$, $B$ is $n$-by-$p$, and $X$ is $n$-by-$p$.

Fixed-point types for the solution of the matrix equation ${A}^{\prime }AX=B$ are well-bounded if the number of rows, $m$, of $A$ are much greater than the number of columns, $n$ (i.e. $m\gg n$), and $A$ is full rank. If $A$ is not inherently full rank, then it can be made so by adding random noise. Random noise naturally occurs in physical systems, such as thermal noise in radar or communications systems. If $m=n$, then the dynamic range of the system can be unbounded, for example in the scalar equation $x=a/b$ and $a,b\in \left[-1,1\right]$, then $x$ can be arbitrarily large if $b$ is close to $0$.

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 = 24;`

In this example, real-valued matrices `A` and `B` are constructed such that the magnitude of their elements is less than or equal to one. 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 = 1;`

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

`max_abs_B = 1;`

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.realQuantizationNoiseStandardDeviation` to compute this. See that it is less than `thermalNoiseStandardDeviation`.

`quantizationNoiseStandardDeviation = fixed.realQuantizationNoiseStandardDeviation(precisionBits)`
```quantizationNoiseStandardDeviation = 1.7206e-08 ```

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 `fixed.realQlessQRMatrixSolveFixedpointTypes` to compute fixed-point types.

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

`T.A` is the type computed for transforming $\mathit{A}$ to $\mathit{R}={\mathit{Q}}^{\prime }\mathit{A}$ in-place so that it does not overflow.

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

`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: 27 FractionLength: 24 ```

`T.X` is the type computed for the solution $X=\left({A}^{\prime }A\right)\B$ so that there is a low probability that it overflows.

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

Use the Specified Types to Solve the Matrix Equation A'AX=B

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.realRandomQlessQRMatrices(m,n,p,rankA); A = A + fixed.example.realNormalRandomArray(0,noiseStandardDeviation,m,n);```

Cast the inputs to the types determined by `fixed.realQlessQRMatrixSolveFixedpointTypes``. `Quantizing to fixed-point is equivalent to adding random noise [4,5].

```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} -o qlessQRMatrixSolve_mex`

Specify output type `T.X` and compute fixed-point $X=\left({A}^{\prime }A\right)\B$ using the QR method.

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

Compute the relative error to verify the accuracy of the ouput.

`relative_error = norm(double(A'*A*X - B))/norm(double(B))`
```relative_error = 0.0561 ```

Suppress mlint warnings in this file.

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

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

`${\left[\begin{array}{c}\lambda {I}_{n}\\ A\end{array}\right]}^{T}\left[\begin{array}{c}\lambda {I}_{n}\\ A\end{array}\right]X=\left({\lambda }^{2}{I}_{n}+{A}^{T}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, real-valued matrices `A` and `B` are constructed such that the magnitude of their elements is less than or equal to one. 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 = 1;`

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

`max_abs_B = 1;`

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.realQuantizationNoiseStandardDeviation` to compute this. See that it is less than `thermalNoiseStandardDeviation`.

`quantizationNoiseStandardDeviation = fixed.realQuantizationNoiseStandardDeviation(precisionBits)`
```quantizationNoiseStandardDeviation = 6.7212e-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.realQlessQRMatrixSolveFixedpointTypes` function to compute fixed-point types.

```T = fixed.realQlessQRMatrixSolveFixedpointTypes(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}^{T}\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: 39 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]}^{T}\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.realRandomQlessQRMatrices(m,n,p,rankA); A = A + fixed.example.realNormalRandomArray(0,noiseStandardDeviation,m,n);```

Cast the inputs to the types determined by `fixed.realQlessQRMatrixSolveFixedpointTypes`. 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]}^{T}\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]}^{T}\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.0133e-05 ```

Suppress `mlint` warnings in this file.

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

## Input Arguments

collapse all

Number of rows in A and B, specified as a positive integer-valued scalar.

Data Types: `double`

Number of columns in A, specified as a positive integer-valued scalar.

Data Types: `double`

Maximum of the absolute value of A, specified as a scalar.

Example: `max(abs(A(:)))`

Data Types: `double`

Maximum of the absolute value of B, specified as a scalar.

Example: `max(abs(B(:)))`

Data Types: `double`

Required number of bits of precision of the input and output, specified as a positive integer-valued scalar.

Data Types: `double`

Standard deviation of additive random noise in A, specified as a scalar.

If `noiseStandardDeviation` is not specified, then the default is the standard deviation of the real-valued quantization noise ${\sigma }_{q}=\left({2}^{-\mathrm{precisionBits}}\right)/\left(\sqrt{12}\right)$, which is calculated by `fixed.realQuantizationNoiseStandardDeviation`.

Data Types: `double`

Probability that estimate of lower bound s is larger than actual smallest singular value of matrix, specified as a scalar. Use `fixed.realSingularValueLowerBound` to estimate the smallest singular value, s, of A. If `p_s` is not specified, the default value is ${p}_{s}=\left(1/2\right)\cdot \left(1+\text{erf}\left(-5/\sqrt{2}\right)\right)\approx 3\cdot {10}^{-7}$ which is 5 standard deviations below the mean, so the probability that the estimated bound for the smallest singular value is less than the actual smallest singular value is 1-ps ≈ 0.9999997.

Data Types: `double`

Regularization parameter, specified as a nonnegative scalar. 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` is the Tikhonov regularization parameter of the matrix problem

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

Data Types: `single` | `double` | `int8` | `int16` | `int32` | `int64` | `uint8` | `uint16` | `uint32` | `uint64` | `fi`

## Output Arguments

collapse all

Fixed-point types for A, B, and X, returned as a struct. The struct `T` has fields `T.A`, `T.B`, and `T.X`. These fields contain `fi` objects that specify fixed-point types for:

• A and B that guarantee no overflow will occur in the QR algorithm.

The QR algorithm transforms A in-place into upper-triangular R, where QR=A is the QR decomposition of A.

• X such that there is a low probability of overflow.

## Tips

Use `fixed.realQlessQRMatrixSolveFixedpointTypes` to compute fixed-point types for the inputs of these functions and blocks.

## Algorithms

The fixed-point type for A is computed using `fixed.qlessqrFixedpointTypes`. The required number of integer bits to prevent overflow is derived from the following bound on the growth of R [1]. The required number of integer bits is added to the number of bits of precision, `precisionBits`, of the input, plus one for the sign bit, plus one bit for intermediate CORDIC gain of approximately 1.6468 [2].

The elements of R are bounded in magnitude by

`$\mathrm{max}\left(|R\left(:\right)|\right)\le \sqrt{m}\mathrm{max}\left(|A\left(:\right)|\right).$`

Matrix B is not transformed, so it does not need any additional growth bits.

The elements of X=R\(R'\B) are bounded in magnitude by

`$\mathrm{max}\left(|X\left(:\right)|\right)\le \frac{n\cdot \mathrm{max}\left(|B\left(:\right)|\right)}{\mathrm{min}{\left(\text{svd}\left(A\right)\right)}^{2}}.$`

Computing the singular value decomposition to derive the above bound on X is more computationally intensive than the entire matrix solve, so the `fixed.realSingularValueLowerBound` function is used to estimate a bound on `min(svd(A))`.

## References

[2] Voler, Jack E. "The CORDIC Trigonometric Computing Technique." IRE Transactions on Electronic Computers EC-8 (1959): 330-334.

## Version History

Introduced in R2021b