.. _auto_matrix_scalarmultiply:

*SCALE THE MATRIX BY A NUMBER*
==============================

Multiplies every element of a matrix by a scalar factor, returning a scaled matrix of identical dimensions. Use this worker whenever a uniform scaling operation is needed on a matrix within a transformation pipeline.

When to use
-----------

Classification: **process**.

Tagged: ``element_wise``, ``linear_algebra``, ``matrix``, ``multiply``, ``scalar``, ``scale``, ``transformation``.

Inputs
------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20 20 20

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Matrix 1
     - matrix1
     - matrix
     - —
     - 
     - Input matrix to be scaled; all elements will be multiplied by the scalar factor — provide any 2-D numeric matrix (dense or sparse).
   * - Multiplication Factor
     - multiplication_factor
     - scalar
     - —
     - 
     - Dimensionless scalar value by which every element of Matrix 1 is multiplied; e.g. 0.001 to convert mm to m, or –1 to negate the matrix.

Outputs
-------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20

   * - Label
     - ID
     - Type
     - Description
   * - matrix_scalarmultiply_output_1
     - matrix_scalarmultiply_output_1
     - matrix
     - Resulting matrix after element-wise scalar multiplication; same shape and type as the input matrix, with all values scaled by the multiplication factor.

Disciplines
-----------

- data.dataset.transform

.. raw:: html

   <hr style="margin-top:2em">
   <p style="font-size:11px;color:#888">
   Auto-generated from <code>transformation</code> schema. Worker id: <code>matrix_scalarmultiply</code>. Schema hash: <code>93fb6da373b4</code>. Hand-curated docs in <code>workerexamples/</code> override this page when present.
   </p>