scale_matrixT_scale_matrixScaleMatrixScaleMatrixscale_matrix (Operator)

Name

scale_matrixT_scale_matrixScaleMatrixScaleMatrixscale_matrix — Scale a matrix.

Signature

scale_matrix( : : MatrixID, Factor : MatrixScaledID)

Herror T_scale_matrix(const Htuple MatrixID, const Htuple Factor, Htuple* MatrixScaledID)

void ScaleMatrix(const HTuple& MatrixID, const HTuple& Factor, HTuple* MatrixScaledID)

HMatrix HMatrix::ScaleMatrix(const HTuple& Factor) const

HMatrix HMatrix::ScaleMatrix(double Factor) const

static void HOperatorSet.ScaleMatrix(HTuple matrixID, HTuple factor, out HTuple matrixScaledID)

HMatrix HMatrix.ScaleMatrix(HTuple factor)

HMatrix HMatrix.ScaleMatrix(double factor)

def scale_matrix(matrix_id: HHandle, factor: Union[int, float]) -> HHandle

Description

The operator scale_matrixscale_matrixScaleMatrixScaleMatrixScaleMatrixscale_matrix scales the Matrix by a constant factor. The matrix is defined by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDmatrixIDmatrix_id. A new matrix MatrixScaled is generated with the result. The operator returns the matrix handle MatrixScaledIDMatrixScaledIDMatrixScaledIDMatrixScaledIDmatrixScaledIDmatrix_scaled_id. Access to the elements of the matrix is possible e.g., with the operator get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrixget_full_matrix. The formula for the calculation of the result is:

Example:

FactorFactorFactorFactorfactorfactor = 1.5

Execution Information

Parameters

MatrixIDMatrixIDMatrixIDMatrixIDmatrixIDmatrix_id (input_control)  matrix HMatrix, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Matrix handle of the input matrix.

FactorFactorFactorFactorfactorfactor (input_control)  number HTupleUnion[int, float]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Scale factor.

Default value: 2.0

Suggested values: 0.1, 0.2, 0.3, 0.5, 0.7, 1.0, 1.5, 2.0, 3.0, 5.0, 10.0

MatrixScaledIDMatrixScaledIDMatrixScaledIDMatrixScaledIDmatrixScaledIDmatrix_scaled_id (output_control)  matrix HMatrix, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Matrix handle with the scaled elements.

Result

If the parameters are valid, the operator scale_matrixscale_matrixScaleMatrixScaleMatrixScaleMatrixscale_matrix returns the value TRUE. If necessary, an exception is raised.

Possible Predecessors

create_matrixcreate_matrixCreateMatrixCreateMatrixCreateMatrixcreate_matrix

Possible Successors

get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrixget_full_matrix, get_value_matrixget_value_matrixGetValueMatrixGetValueMatrixGetValueMatrixget_value_matrix

Alternatives

scale_matrix_modscale_matrix_modScaleMatrixModScaleMatrixModScaleMatrixModscale_matrix_mod

See also

mult_element_matrixmult_element_matrixMultElementMatrixMultElementMatrixMultElementMatrixmult_element_matrix, mult_element_matrix_modmult_element_matrix_modMultElementMatrixModMultElementMatrixModMultElementMatrixModmult_element_matrix_mod, div_element_matrixdiv_element_matrixDivElementMatrixDivElementMatrixDivElementMatrixdiv_element_matrix, div_element_matrix_moddiv_element_matrix_modDivElementMatrixModDivElementMatrixModDivElementMatrixModdiv_element_matrix_mod

Module

Foundation