ClassesClassesClassesClasses | | | | Operators

mean_matrixmean_matrixMeanMatrixmean_matrixMeanMatrixMeanMatrix (Operator)

Name

mean_matrixmean_matrixMeanMatrixmean_matrixMeanMatrixMeanMatrix — Returns the elementwise mean of a matrix.

Signature

mean_matrix( : : MatrixID, MeanType : MatrixMeanID)

Herror mean_matrix(const Hlong MatrixID, const char* MeanType, Hlong* MatrixMeanID)

Herror T_mean_matrix(const Htuple MatrixID, const Htuple MeanType, Htuple* MatrixMeanID)

Herror mean_matrix(const HTuple& MatrixID, const HTuple& MeanType, Hlong* MatrixMeanID)

HMatrix HMatrix::MeanMatrix(const HTuple& MeanType) const

void MeanMatrix(const HTuple& MatrixID, const HTuple& MeanType, HTuple* MatrixMeanID)

HMatrix HMatrix::MeanMatrix(const HString& MeanType) const

HMatrix HMatrix::MeanMatrix(const char* MeanType) const

void HOperatorSetX.MeanMatrix(
[in] VARIANT MatrixID, [in] VARIANT MeanType, [out] VARIANT* MatrixMeanID)

IHMatrixX* HMatrixX.MeanMatrix([in] BSTR MeanType)

static void HOperatorSet.MeanMatrix(HTuple matrixID, HTuple meanType, out HTuple matrixMeanID)

HMatrix HMatrix.MeanMatrix(string meanType)

Description

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:

Parallelization

Parameters

MatrixIDMatrixIDMatrixIDMatrixIDMatrixIDmatrixID (input_control)  matrix HMatrix, HTupleHTupleHMatrix, HTupleHMatrixX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

Matrix handle of the input matrix.

MeanTypeMeanTypeMeanTypeMeanTypeMeanTypemeanType (input_control)  string HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

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"

MatrixMeanIDMatrixMeanIDMatrixMeanIDMatrixMeanIDMatrixMeanIDmatrixMeanID (output_control)  matrix HMatrix, HTupleHTupleHMatrix, HTupleHMatrixX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

Matrix handle with the mean values of the input matrix.

Result

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

Possible Predecessors

create_matrixcreate_matrixCreateMatrixcreate_matrixCreateMatrixCreateMatrix

Possible Successors

get_full_matrixget_full_matrixGetFullMatrixget_full_matrixGetFullMatrixGetFullMatrix, get_value_matrixget_value_matrixGetValueMatrixget_value_matrixGetValueMatrixGetValueMatrix

See also

norm_matrixnorm_matrixNormMatrixnorm_matrixNormMatrixNormMatrix, sum_matrixsum_matrixSumMatrixsum_matrixSumMatrixSumMatrix

Module

Foundation


ClassesClassesClassesClasses | | | | Operators