.. This file is generated by bin/gen-function-list.py from
   misc/function-specs.yaml.  Do not edit it by hand.

.. _functions:

Supported functions
===================

Ixion implements the 57 functions listed below, grouped by
category.  A function marked *volatile* gets re-calculated on every
calculation, whether or not any cell it references has changed.

The parser also recognizes the names of 265 other functions
that are not implemented yet.  A formula using one of them parses, but
yields the ``#NAME?`` error when calculated.

Mathematical
------------

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

   * - Function
     - Arguments
     - Returns
     - Notes
   * - ``ABS``
     - 1
     -
     -
   * - ``INT``
     - 1
     -
     -
   * - ``MMULT``
     - 2
     - array
     -
   * - ``PI``
     - 0
     -
     -
   * - ``RAND``
     - 0
     - numeric
     - Volatile.
   * - ``SUBTOTAL``
     - 2
     -
     - This function is not fully implemented.
   * - ``SUM``
     - 1 or more
     -
     -

Statistical
-----------

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

   * - Function
     - Arguments
     - Returns
     - Notes
   * - ``AVERAGE``
     - 1 or more
     -
     -
   * - ``COUNT``
     - any number
     - numeric
     -
   * - ``COUNTA``
     - any number
     - numeric
     -
   * - ``COUNTBLANK``
     - 1
     - numeric
     - Unlike COUNT() or COUNTA(), this function only takes one argument, and that argument must be a cell or range reference.
   * - ``MAX``
     - 1 or more
     -
     -
   * - ``MEDIAN``
     - 1 or more
     - numeric
     -
   * - ``MIN``
     - 1 or more
     -
     -
   * - ``MODE``
     - 1 or more
     - numeric
     -

Logical
-------

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

   * - Function
     - Arguments
     - Returns
     - Notes
   * - ``AND``
     - 1 or more
     - boolean
     -
   * - ``FALSE``
     - 0
     - boolean
     -
   * - ``IF``
     - 3
     -
     -
   * - ``NOT``
     - 1
     - boolean
     - It triggers ``#VALUE!`` error on string value input.
   * - ``OR``
     - 1 or more
     - boolean
     -
   * - ``TRUE``
     - 0
     - boolean
     -

Information
-----------

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

   * - Function
     - Arguments
     - Returns
     - Notes
   * - ``ISBLANK``
     - 1
     - boolean
     - When a range reference is passed, it returns true only when all of the cells in the specified range are empty.
   * - ``ISERR``
     - 1
     - boolean
     - This is the same as ISERROR except when the error value is ``#N/A`` it returns false.
   * - ``ISERROR``
     - 1
     - boolean
     - This function does NOT take a range reference.
   * - ``ISEVEN``
     - 1
     - boolean
     - This function does NOT take a range reference.
   * - ``ISFORMULA``
     - 1
     - boolean
     -
   * - ``ISLOGICAL``
     - 1
     - boolean
     -
   * - ``ISNA``
     - 1
     - boolean
     -
   * - ``ISNONTEXT``
     - 1
     - boolean
     - This function does NOT take a range reference. Also, the result of this function is the complete opposite of ISTEXT function.
   * - ``ISNUMBER``
     - 1
     - boolean
     - This function does NOT take a range reference.
   * - ``ISODD``
     - 1
     - boolean
     - This function does NOT take a range reference.
   * - ``ISREF``
     - 1
     - boolean
     - This function does NOT take a range reference.
   * - ``ISTEXT``
     - 1
     - boolean
     - This function does NOT take a range reference.
   * - ``N``
     - 1
     - numeric
     -
   * - ``NA``
     - 0
     - error
     -
   * - ``TYPE``
     - 1
     - numeric
     -

Text
----

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

   * - Function
     - Arguments
     - Returns
     - Notes
   * - ``CONCATENATE``
     - any number
     - string
     -
   * - ``EXACT``
     - 2
     - string
     -
   * - ``FIND``
     - 2 to 3
     - string
     - This function performs a case-sensitive search.
   * - ``LEFT``
     - 1 to 2
     - string
     -
   * - ``LEN``
     - 1
     -
     -
   * - ``MID``
     - 3
     - string
     -
   * - ``REPLACE``
     - 4
     - string
     -
   * - ``REPT``
     - 2
     - string
     -
   * - ``RIGHT``
     - 1 to 2
     - string
     -
   * - ``SUBSTITUTE``
     - 3 to 4
     - string
     - This function is case-sensitive.
   * - ``T``
     - 1
     - string
     -
   * - ``TEXTJOIN``
     - 3 or more
     - string
     -
   * - ``TRIM``
     - 1
     - string
     -

Date and time
-------------

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

   * - Function
     - Arguments
     - Returns
     - Notes
   * - ``NOW``
     - 0
     - numeric
     - Volatile. The zero date is 1899-12-30.
   * - ``TODAY``
     - 0
     - numeric
     - Volatile. The zero date is 1899-12-30.

Spreadsheet
-----------

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

   * - Function
     - Arguments
     - Returns
     - Notes
   * - ``COLUMN``
     - up to 1
     - numeric
     -
   * - ``COLUMNS``
     - any number
     - numeric
     -
   * - ``ROW``
     - up to 1
     - numeric
     -
   * - ``ROWS``
     - any number
     - numeric
     -
   * - ``SHEET``
     - up to 1
     - numeric
     -
   * - ``SHEETS``
     - up to 1
     - numeric
     - It triggers an ``#N/A`` error upon string and numeric input. It returns the number of sheets in the document when no arguments are given.
