Name
mean_matrixmean_matrixMeanMatrixmean_matrixMeanMatrixMeanMatrix — Returns the elementwise mean of a matrix.
The operator mean_matrixmean_matrixMeanMatrixmean_matrixMeanMatrixMeanMatrix returns the mean values of the
elements of the MatrixMatrixMatrixMatrixMatrixmatrix defined by the matrix handle
MatrixIDMatrixIDMatrixIDMatrixIDMatrixIDmatrixID. A new matrix MatrixMeanMatrixMeanMatrixMeanMatrixMeanMatrixMeanmatrixMean is generated
with the result and the matrix handle MatrixMeanIDMatrixMeanIDMatrixMeanIDMatrixMeanIDMatrixMeanIDmatrixMeanID of this
matrix is returned. Access to the elements of the matrix is
possible e.g. with the operator get_full_matrixget_full_matrixGetFullMatrixget_full_matrixGetFullMatrixGetFullMatrix.
The type of mean determination of the matrix can be selected via the
parameter MeanTypeMeanTypeMeanTypeMeanTypeMeanTypemeanType:
- 'columns'"columns""columns""columns""columns""columns":
-
The mean is returned for
each column of the MatrixMatrixMatrixMatrixMatrixmatrix separately. The resulting
matrix MatrixMeanMatrixMeanMatrixMeanMatrixMeanMatrixMeanmatrixMean has one row and the identical number
of columns as the input matrix.
Example:
- 'rows'"rows""rows""rows""rows""rows":
-
The mean is returned for each
row of the MatrixMatrixMatrixMatrixMatrixmatrix separately. The resulting matrix
MatrixMeanMatrixMeanMatrixMeanMatrixMeanMatrixMeanmatrixMean has the identical number of rows as the input
matrix and one column.
Example:
- 'full'"full""full""full""full""full":
-
The mean is returned using all
elements of the MatrixMatrixMatrixMatrixMatrixmatrix. The resulting matrix
MatrixMeanMatrixMeanMatrixMeanMatrixMeanMatrixMeanmatrixMean has one row and one column.
Example:
- Multithreading type: reentrant (runs in parallel with non-exclusive operators).
- Multithreading scope: global (may be called from any thread).
- Processed without parallelization.
Matrix handle of the input matrix.
Type of mean determination.
Default value:
'columns'
"columns"
"columns"
"columns"
"columns"
"columns"
List of values: 'columns'"columns""columns""columns""columns""columns", 'full'"full""full""full""full""full", 'rows'"rows""rows""rows""rows""rows"
Matrix handle with the mean values of the input
matrix.
If the parameters are valid, the operator mean_matrixmean_matrixMeanMatrixmean_matrixMeanMatrixMeanMatrix
returns the value 2 (H_MSG_TRUE). If necessary, an exception is raised.
create_matrixcreate_matrixCreateMatrixcreate_matrixCreateMatrixCreateMatrix
get_full_matrixget_full_matrixGetFullMatrixget_full_matrixGetFullMatrixGetFullMatrix,
get_value_matrixget_value_matrixGetValueMatrixget_value_matrixGetValueMatrixGetValueMatrix
norm_matrixnorm_matrixNormMatrixnorm_matrixNormMatrixNormMatrix,
sum_matrixsum_matrixSumMatrixsum_matrixSumMatrixSumMatrix
Foundation