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

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

.. index:: MCLOCK, time, clock ticks, clock ticks

.. _mclock:

MCLOCK --- Time function
************************

.. function:: MCLOCK()

  Returns the number of clock ticks since the start of the process, based
  on the function ``clock(3)`` in the C standard library.

  :return:
    The return value is a scalar of type ``INTEGER(4)``, equal to the
    number of clock ticks since the start of the process, or ``-1`` if
    the system does not support ``clock(3)``.

  Standard:
    GNU extension

  Class:
    Function

  Syntax:
    .. code-block:: fortran

      RESULT = MCLOCK()

  See also:
    :ref:`CTIME`,
    :ref:`GMTIME`,
    :ref:`LTIME`,
    :ref:`MCLOCK`,
    :ref:`TIME`
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:: MCLOCK, time, clock ticks, clock ticks
	7
	8	.. _mclock:
	9
	10	MCLOCK --- Time function
	11	************************
	12
	13	.. function:: MCLOCK()
	14
	15	Returns the number of clock ticks since the start of the process, based
	16	on the function ``clock(3)`` in the C standard library.
	17
	18	:return:
	19	The return value is a scalar of type ``INTEGER(4)``, equal to the
	20	number of clock ticks since the start of the process, or ``-1`` if
	21	the system does not support ``clock(3)``.
	22
	23	Standard:
	24	GNU extension
	25
	26	Class:
	27	Function
	28
	29	Syntax:
	30	.. code-block:: fortran
	31
	32	RESULT = MCLOCK()
	33
	34	See also:
	35	:ref:`CTIME`,
	36	:ref:`GMTIME`,
	37	:ref:`LTIME`,
	38	:ref:`MCLOCK`,
3ed1b4ce	39	:ref:`TIME`