object

# `atom`

Atom data type predicates.

Availability:
`logtalk_load(types(loader))`
Author: Paulo Moura
Version: 1:9:0
Date: 2023-04-12
Compilation flags:
`static, context_switching_calls`
Extends:
`public` atomic
Uses:
user
Remarks:
(none)
Inherited public predicates:
(<)/2 (=:=)/2 (=<)/2 (=\=)/2 (>)/2 (>=)/2 check/1 depth/2 ground/1 new/1 numbervars/1 numbervars/3 occurs/2 singletons/2 subsumes/2 subterm/2 valid/1 variables/2 variant/2 varnumbers/2 varnumbers/3

## Public predicates

### `replace_sub_atom/4`

Replaces all occurrences 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`

### `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

(no local declarations; see entity ancestors if any)

## Private predicates

(no local declarations; see entity ancestors if any)

## Operators

(none)