[thirdparty/gcc.git] / gcc / fortran / doc / gfortran / intrinsic-procedures / maskr.rst

..
  Copyright 1988-2022 Free Software Foundation, Inc.
  This is part of the GCC manual.
  For copying conditions, see the copyright.rst file.

.. index:: MASKR, mask, right justified

.. _maskr:

MASKR --- Right justified mask
******************************

.. function:: MASKR(I, KIND)

  ``MASKL(I[, KIND])`` has its rightmost :samp:`{I}` bits set to 1, and the
  remaining bits set to 0.

  :param I:
    Shall be of type ``INTEGER``.

  :param KIND:
    Shall be a scalar constant expression of type
    ``INTEGER``.

  :return:
    The return value is of type ``INTEGER``. If :samp:`{KIND}` is present, it
    specifies the kind value of the return type; otherwise, it is of the
    default integer kind.

  Standard:
    Fortran 2008 and later

  Class:
    Elemental function

  Syntax:
    .. code-block:: fortran

      RESULT = MASKR(I[, KIND])

  See also:
    :ref:`MASKL`
Commit	Line	Data
c63539ff ML	1	..
	2	Copyright 1988-2022 Free Software Foundation, Inc.
	3	This is part of the GCC manual.
	4	For copying conditions, see the copyright.rst file.
	5
	6	.. index:: MASKR, mask, right justified
	7
	8	.. _maskr:
	9
	10	MASKR --- Right justified mask
	11	******************************
	12
	13	.. function:: MASKR(I, KIND)
	14
	15	``MASKL(I[, KIND])`` has its rightmost :samp:`{I}` bits set to 1, and the
	16	remaining bits set to 0.
	17
	18	:param I:
	19	Shall be of type ``INTEGER``.
	20
	21	:param KIND:
	22	Shall be a scalar constant expression of type
	23	``INTEGER``.
	24
	25	:return:
	26	The return value is of type ``INTEGER``. If :samp:`{KIND}` is present, it
	27	specifies the kind value of the return type; otherwise, it is of the
	28	default integer kind.
	29
	30	Standard:
	31	Fortran 2008 and later
	32
	33	Class:
	34	Elemental function
	35
	36	Syntax:
	37	.. code-block:: fortran
	38
	39	RESULT = MASKR(I[, KIND])
	40
	41	See also:
3ed1b4ce	42	:ref:`MASKL`