.. highlightlang:: us

.. index:: bit_lshift

.. _bit_lshift:

bit_lshift
==========

.. us.tag bit_lshift NOTREADYENGLISH bit-ops New5510

:ref:`bit_lshift` shifts the bits left.

.. function:: m = bit_lshift(m, nBits)
              m = bit_lshift(m, nBits, cast)

.. us.return

**Return Value**

*m* is an integer matrix.

.. us.params

**Parameters**

.. uparam:: m

   *m* is an integer matrix.

.. uparam:: nBits

   *nBit* is the bit position starting with 0. For 32-Bit values all bits
   can be used (0..31). For 64 bit values only the bits 0 to 52 can be used.

.. uparam:: cast

   *cast* is one of the following values:

   .. list-table::
      :header-rows: 0

      * - CAST_INT8 (0)
        -
      * - CAST_UINT8 (1)
        -
      * - CAST_INT16 (2)
        -
      * - CAST_UINT16 (3)
        -
      * - CAST_INT32 (4)
        -
      * - CAST_UINT32 (5)
        -
      * - CAST_INT64 (6)
        -
      * - CAST_UINT64 (7)
        - default-Wert.

.. us.comment

**Comment**

UniScript uses double precision floating-point values. When casted to a 
``CAST_INT64`` or ``CAST_UINT64`` only the lower 53 Bits
(Bit 0 .. Bit 52) can be used.

.. us.example

**Example**

::

   * bit_lshift(1, 2)
       4.0000 

.. us.history

**History**

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

   * - Version
     - Description
   * - R2013.10
     - New.

.. seealso::
   :ref:`bit-ops`,
   :ref:`bit_get`,
   :ref:`bit_set`,
   :ref:`bit_and`,
   :ref:`bit_or`,
   :ref:`bit_xor`,
   :ref:`bit_not`,
   :ref:`bit_rshift`

:sub:`id-1884850`