dsp.LowerTriangularSolver System object

Package: dsp

Solve lower-triangular matrix equation

Description

The LowerTriangularSolver object solves LX = B for X when L is a square, lower-triangular matrix with the same number of rows as B.

To solve LX = B for X:

  1. Define and set up your linear system solver. See Construction.

  2. Call step to solve the equation according to the properties of dsp.LowerTriangularSolver. The behavior of step is specific to each object in the toolbox.

Construction

H = dsp.LowerTriangularSolver returns a linear system solver, H, used to solve the linear system LX = B, where L is a lower (or unit-lower) triangular matrix.

H = dsp.LowerTriangularSolver('PropertyName',PropertyValue,...) returns a linear system solver, H, with each specified property set to the specified value.

Properties

OverwriteDiagonal

Replace diagonal elements of input with ones

When you set this property to true, the linear system solver replaces the elements on the diagonal of the input, L, with ones. Set this property to either true or false. The default is false.

RealDiagonalElements

Indicate that diagonal of complex input is real

When you set this property to true, the linear system solver optimizes computation speed if the diagonal elements of complex input, L, are real. This property applies only when you set the OverwriteDiagonal property to false. Set this property to either true or false. The default is false.

 Fixed-Point Properties

Methods

cloneCreate lower triangular solver object with same property values
getNumInputsNumber of expected inputs to step method
getNumOutputsNumber of outputs of step method
isLockedLocked status for input attributes and nontunable properties
releaseAllow property value and input characteristics changes
stepSolve matrix equation for specified inputs

Examples

Solve a lower-triangular matrix equation:

 hlowtriang = dsp.LowerTriangularSolver;
 u = tril(rand(4, 4));
 b = rand(4, 1);
 % Check that result is the solution to the linear
 % equations.
 x1 = inv(u)*b
 x = step(hlowtriang, u, b)

Algorithms

This object implements the algorithm, inputs, and outputs described on the Forward Substitution block reference page. The object properties correspond to the block parameters.

Was this topic helpful?