MatrixNorm
Advanced Analysis Library Only
AnalysisLibErrType MatrixNorm (void *inputMatrix, ssize_t numberOfRows, ssize_t numberOfColumns, int normType, double *norm);
Purpose
Calculates the norm of a real input matrix A. The input matrix can be square or rectangular. The norm of a matrix is a scalar that gives some measure of the size of the elements in the matrix. It is similar to the concept of magnitude or absolute value for scalar numbers.
There are different ways to calculate the norm of a matrix. The normType parameter indicates which type of norm to use to calculate the norm.
Parameters
| Input | |||||||||||||||||
| Name | Type | Description | |||||||||||||||
| inputMatrix | void * | Input matrix. This matrix must be an array of doubles. | |||||||||||||||
| numberOfRows | ssize_t | The number of rows in inputMatrix. | |||||||||||||||
| numberOfColumns | ssize_t | The number of columns in inputMatrix. | |||||||||||||||
| normType | int | Type of norm to calculate. The following table shows valid norm type values.
|
|||||||||||||||
| Output | |||||||||||||||||
| Name | Type | Description | |||||||||||||||
| norm | double | Calculated norm of inputMatrix. | |||||||||||||||
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. |
Additional Information
Library: Advanced Analysis Library
Include file: analysis.h
LabWindows/CVI compatibility: LabWindows/CVI 5.0 and later