CxSVDS

Advanced Analysis Library Only

AnalysisLibErrType CxSVDS (void *inputMatrix, int numberOfRows, int numberOfColumns, ComplexNum singularValuesVector[]);

Purpose

Note  This function is obsolete. National Instruments recommends that you use CxSVDEx instead.

Calculates only the singular values that result from the Singular Value Decomposition (SVD) factorization of the complex input matrix. The input matrix can be square or rectangular.

Use this function if your application requires only the singular values.

Parameters

Input
Name Type Description
inputMatrix numeric array Input complex matrix. The input matrix can be either square or rectangular. This matrix must be an array of ComplexNum.

The following C typedef statement defines the ComplexNum structure:

typedef struct {

double real;

double imaginary;

} ComplexNum;

numberOfRows integer Number of rows in inputMatrix.
numberOfColumns integer Number of columns in inputMatrix.
Output
Name Type Description
singularValuesVector ComplexNum array Array that contains the singular values of inputMatrix, in descending order.

The following C typedef statement defines the ComplexNum structure:

typedef struct {

double real;

double imaginary;

} ComplexNum;

Return Value

Name Type Description
status AnalysisLibErrType A value that specifies the type of error that occurred. Refer to analysis.h for definitions of these constants.