Operator Reference

HALCON Operator Reference / Matrix / Features
ClassesClasses | | Operators

norm_matrixT_norm_matrixNormMatrixNormMatrixnorm_matrix (Operator)

norm_matrixT_norm_matrixNormMatrixNormMatrixnorm_matrix — Norm of a matrix.

Signature

norm_matrix( : : MatrixID, NormType : Value)

Herror T_norm_matrix(const Htuple MatrixID, const Htuple NormType, Htuple* Value)

void NormMatrix(const HTuple& MatrixID, const HTuple& NormType, HTuple* Value)

double HMatrix::NormMatrix(const HString& NormType) const

double HMatrix::NormMatrix(const char* NormType) const

double HMatrix::NormMatrix(const wchar_t* NormType) const   ( Windows only)

static void HOperatorSet.NormMatrix(HTuple matrixID, HTuple normType, out HTuple value)

double HMatrix.NormMatrix(string normType)

def norm_matrix(matrix_id: HHandle, norm_type: str) -> float

Description

The operator norm_matrixnorm_matrixNormMatrixNormMatrixnorm_matrix computes the norm of the elements of the Matrix defined by the matrix handle MatrixIDMatrixIDMatrixIDmatrixIDmatrix_id. The return value is a floating point number.

The type of norming of the matrix can be selected via the parameter NormTypeNormTypeNormTypenormTypenorm_type:

'frobenius-norm'"frobenius-norm""frobenius-norm""frobenius-norm""frobenius-norm":

The Frobenius norm is computed. The formula for the calculation of the result is: with m = number of rows and n = number of columns of the Matrix.

Example:

'infinity-norm'"infinity-norm""infinity-norm""infinity-norm""infinity-norm":

The infinity norm is computed. The result is the largest value of the sum of the absolute values of the elements of the rows. The formula for the calculation is: with m = number of rows and n = number of columns of the Matrix.

Example:

'1-norm'"1-norm""1-norm""1-norm""1-norm":

The 1-norm is computed. The result is the largest value of the sum of the absolute values of the elements of the columns. The formula for the calculation is: with m = number of rows and n = number of columns of the Matrix.

Example:

'2-norm'"2-norm""2-norm""2-norm""2-norm":

The 2-norm is computed. The result is the largest singular value of the Matrix. The formula for the calculation of the result is:

Example:

Execution Information

  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).
  • Multithreading scope: global (may be called from any thread).
  • Processed without parallelization.

Parameters

MatrixIDMatrixIDMatrixIDmatrixIDmatrix_id (input_control)  matrix → HMatrix, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Matrix handle of the input matrix.

NormTypeNormTypeNormTypenormTypenorm_type (input_control)  string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Type of norm.

Default: '2-norm' "2-norm" "2-norm" "2-norm" "2-norm"

List of values: '1-norm'"1-norm""1-norm""1-norm""1-norm", '2-norm'"2-norm""2-norm""2-norm""2-norm", 'frobenius-norm'"frobenius-norm""frobenius-norm""frobenius-norm""frobenius-norm", 'infinity-norm'"infinity-norm""infinity-norm""infinity-norm""infinity-norm"

ValueValueValuevaluevalue (output_control)  real → HTuplefloatHTupleHtuple (real) (double) (double) (double)

Norm of the input matrix.

Result

If the parameters are valid, the operator norm_matrixnorm_matrixNormMatrixNormMatrixnorm_matrix returns the value 2 ( H_MSG_TRUE) . If necessary, an exception is raised.

Possible Predecessors

create_matrixcreate_matrixCreateMatrixCreateMatrixcreate_matrix

See also

sum_matrixsum_matrixSumMatrixSumMatrixsum_matrix, mean_matrixmean_matrixMeanMatrixMeanMatrixmean_matrix

References

David Poole: “Linear Algebra: A Modern Introduction”; Thomson; Belmont; 2006.
Gene H. Golub, Charles F. van Loan: “Matrix Computations”; The Johns Hopkins University Press; Baltimore and London; 1996.

Module

Foundation

ClassesClasses | | Operators