.. index:: atom
.. _atom/0:

.. rst-class:: right

**object**

``atom``
========

Atom data type predicates.

| **Author:** Paulo Moura
| **Version:** 1.7
| **Date:** 2019/1/8

| **Compilation flags:**
|    ``static, context_switching_calls``


| **Extends:**
|    ``public`` :ref:`atomic <atomic/0>`

| **Remarks:**
|    (none)

.. contents::
   :local:
   :backlinks: top

Public predicates
-----------------

.. raw:: html

   <div id="replace_sub_atom/4"> </div>

.. index:: replace_sub_atom/4
.. _atom/0::replace_sub_atom/4:

``replace_sub_atom/4``
^^^^^^^^^^^^^^^^^^^^^^

Replaces all occurences of ``Old`` by ``New`` in ``Input`` returning ``Output``. Returns ``Input`` if ``Old`` is the empty atom. Fails when ``Output`` does not unify with the resulting atom.

| **Compilation flags:**
|    ``static``

| **Template:**
|    ``replace_sub_atom(Old,New,Input,Output)``
| **Mode and number of proofs:**
|    ``replace_sub_atom(+atom,+atom,+atom,?atom)`` - ``zero_or_one``


------------

.. raw:: html

   <div id="split/3"> </div>

.. index:: split/3
.. _atom/0::split/3:

``split/3``
^^^^^^^^^^^

Splits an atom at a given delimiter into a list of sub-atoms.

| **Compilation flags:**
|    ``static``

| **Template:**
|    ``split(Atom,Delimiter,SubAtoms)``
| **Mode and number of proofs:**
|    ``split(+atom,+atom,-list(atom))`` - ``one``


------------

Protected predicates
--------------------

(see entity ancestors)

Private predicates
------------------

(see entity ancestors)

Operators
---------

(none)

