System configuration
====================

.. sectionauthor:: Travis E. Oliphant

When NumPy is built, information about system configuration is
recorded, and is made available for extension modules using NumPy's C
API.  These are mostly defined in ``numpyconfig.h`` (included in
``ndarrayobject.h``). The public symbols are prefixed by ``NPY_*``.
NumPy also offers some functions for querying information about the
platform in use.

For private use, NumPy also constructs a ``config.h`` in the NumPy
include directory, which is not exported by NumPy (that is a python
extension which use the numpy C API will not see those symbols), to
avoid namespace pollution.


Data type sizes
---------------

The :c:data:`NPY_SIZEOF_{CTYPE}` constants are defined so that sizeof
information is available to the pre-processor.

.. c:var:: NPY_SIZEOF_SHORT

    sizeof(short)

.. c:var:: NPY_SIZEOF_INT

    sizeof(int)

.. c:var:: NPY_SIZEOF_LONG

    sizeof(long)

.. c:var:: NPY_SIZEOF_LONGLONG

    sizeof(longlong) where longlong is defined appropriately on the
    platform.

.. c:var:: NPY_SIZEOF_PY_LONG_LONG


.. c:var:: NPY_SIZEOF_FLOAT

    sizeof(float)

.. c:var:: NPY_SIZEOF_DOUBLE

    sizeof(double)

.. c:var:: NPY_SIZEOF_LONG_DOUBLE

    sizeof(longdouble) (A macro defines **NPY_SIZEOF_LONGDOUBLE** as well.)

.. c:var:: NPY_SIZEOF_PY_INTPTR_T

    Size of a pointer on this platform (sizeof(void \*)) (A macro defines
    NPY_SIZEOF_INTP as well.)


Platform information
--------------------

.. c:var:: NPY_CPU_X86
.. c:var:: NPY_CPU_AMD64
.. c:var:: NPY_CPU_IA64
.. c:var:: NPY_CPU_PPC
.. c:var:: NPY_CPU_PPC64
.. c:var:: NPY_CPU_SPARC
.. c:var:: NPY_CPU_SPARC64
.. c:var:: NPY_CPU_S390
.. c:var:: NPY_CPU_PARISC

    .. versionadded:: 1.3.0

    CPU architecture of the platform; only one of the above is
    defined.

    Defined in ``numpy/npy_cpu.h``

.. c:var:: NPY_LITTLE_ENDIAN

.. c:var:: NPY_BIG_ENDIAN

.. c:var:: NPY_BYTE_ORDER

    .. versionadded:: 1.3.0

    Portable alternatives to the ``endian.h`` macros of GNU Libc.
    If big endian, :c:data:`NPY_BYTE_ORDER` == :c:data:`NPY_BIG_ENDIAN`, and
    similarly for little endian architectures.

    Defined in ``numpy/npy_endian.h``.

.. c:function:: PyArray_GetEndianness()

    .. versionadded:: 1.3.0

    Returns the endianness of the current platform.
    One of :c:data:`NPY_CPU_BIG`, :c:data:`NPY_CPU_LITTLE`,
    or :c:data:`NPY_CPU_UNKNOWN_ENDIAN`.


Compiler directives
-------------------

.. c:var:: NPY_LIKELY
.. c:var:: NPY_UNLIKELY
.. c:var:: NPY_UNUSED


Interrupt Handling
------------------

.. c:var:: NPY_INTERRUPT_H
.. c:var:: NPY_SIGSETJMP
.. c:var:: NPY_SIGLONGJMP
.. c:var:: NPY_SIGJMP_BUF
.. c:var:: NPY_SIGINT_ON
.. c:var:: NPY_SIGINT_OFF
