diff --git a/predicates/atomic_list_concat_2.md b/predicates/atomic_list_concat_2.md new file mode 100644 index 00000000000..c8030a4cf09 --- /dev/null +++ b/predicates/atomic_list_concat_2.md @@ -0,0 +1,21 @@ +--- +sidebar_position: 1 +--- +[//]: # (This file is auto-generated. Please do not modify it yourself.) + +# atomic_list_concat/2 + +## Description + +`atomic_list_concat/2` is a predicate that unifies an Atom with the concatenated elements of a List. + +## Signature + +```text +atomic_list_concat(+List, ?Atom) +``` + +where: + +- List is a list of strings, atoms, integers, floating point numbers or non\-integer rationals +- Atom is an Atom representing the concatenation of the elements of List diff --git a/predicates/atomic_list_concat_3.md b/predicates/atomic_list_concat_3.md new file mode 100644 index 00000000000..86fca9ab3e6 --- /dev/null +++ b/predicates/atomic_list_concat_3.md @@ -0,0 +1,24 @@ +--- +sidebar_position: 2 +--- +[//]: # (This file is auto-generated. Please do not modify it yourself.) + +# atomic_list_concat/3 + +## Description + +`atomic_list_concat/3` is a predicate that unifies an Atom with the concatenated elements of a List using a given separator. + +The atomic\_list\_concat/3 predicate creates an atom just like atomic\_list\_concat/2, but inserts Separator between each pair of inputs. + +## Signature + +```text +atomic_list_concat(+List, +Separator, ?Atom) +``` + +where: + +- List is a list of strings, atoms, integers, floating point numbers or non\-integer rationals +- Separator is an atom \(possibly empty\) +- Atom is an Atom representing the concatenation of the elements of List diff --git a/predicates/bank_balances_2.md b/predicates/bank_balances_2.md index 88be6ee1a22..113211057d8 100644 --- a/predicates/bank_balances_2.md +++ b/predicates/bank_balances_2.md @@ -1,5 +1,5 @@ --- -sidebar_position: 1 +sidebar_position: 3 --- [//]: # (This file is auto-generated. Please do not modify it yourself.) diff --git a/predicates/bank_locked_balances_2.md b/predicates/bank_locked_balances_2.md index 8be50981890..8229a730c7c 100644 --- a/predicates/bank_locked_balances_2.md +++ b/predicates/bank_locked_balances_2.md @@ -1,5 +1,5 @@ --- -sidebar_position: 2 +sidebar_position: 4 --- [//]: # (This file is auto-generated. Please do not modify it yourself.) diff --git a/predicates/bank_spendable_balances_2.md b/predicates/bank_spendable_balances_2.md index bf0547490f3..cc017b16d72 100644 --- a/predicates/bank_spendable_balances_2.md +++ b/predicates/bank_spendable_balances_2.md @@ -1,5 +1,5 @@ --- -sidebar_position: 3 +sidebar_position: 5 --- [//]: # (This file is auto-generated. Please do not modify it yourself.) diff --git a/predicates/bech32_address_2.md b/predicates/bech32_address_2.md index c5777e7ae39..1b369241249 100644 --- a/predicates/bech32_address_2.md +++ b/predicates/bech32_address_2.md @@ -1,5 +1,5 @@ --- -sidebar_position: 4 +sidebar_position: 6 --- [//]: # (This file is auto-generated. Please do not modify it yourself.) diff --git a/predicates/block_height_1.md b/predicates/block_height_1.md index 55167b8617c..fbc397cd684 100644 --- a/predicates/block_height_1.md +++ b/predicates/block_height_1.md @@ -1,5 +1,5 @@ --- -sidebar_position: 5 +sidebar_position: 7 --- [//]: # (This file is auto-generated. Please do not modify it yourself.) diff --git a/predicates/block_time_1.md b/predicates/block_time_1.md index a6fe13e8ed0..9f249bb310d 100644 --- a/predicates/block_time_1.md +++ b/predicates/block_time_1.md @@ -1,5 +1,5 @@ --- -sidebar_position: 6 +sidebar_position: 8 --- [//]: # (This file is auto-generated. Please do not modify it yourself.) diff --git a/predicates/chain_id_1.md b/predicates/chain_id_1.md index 47bb1cf0d27..fd63f697c5a 100644 --- a/predicates/chain_id_1.md +++ b/predicates/chain_id_1.md @@ -1,5 +1,5 @@ --- -sidebar_position: 7 +sidebar_position: 9 --- [//]: # (This file is auto-generated. Please do not modify it yourself.) diff --git a/predicates/consult_1.md b/predicates/consult_1.md index 1b77df7d39d..aa468d4c042 100644 --- a/predicates/consult_1.md +++ b/predicates/consult_1.md @@ -1,5 +1,5 @@ --- -sidebar_position: 8 +sidebar_position: 10 --- [//]: # (This file is auto-generated. Please do not modify it yourself.) diff --git a/predicates/crypto_data_hash_3.md b/predicates/crypto_data_hash_3.md index 9626e6c5a60..25f74af0951 100644 --- a/predicates/crypto_data_hash_3.md +++ b/predicates/crypto_data_hash_3.md @@ -1,5 +1,5 @@ --- -sidebar_position: 9 +sidebar_position: 11 --- [//]: # (This file is auto-generated. Please do not modify it yourself.) diff --git a/predicates/current_output_1.md b/predicates/current_output_1.md index 58c404442e1..d191562baef 100644 --- a/predicates/current_output_1.md +++ b/predicates/current_output_1.md @@ -1,5 +1,5 @@ --- -sidebar_position: 10 +sidebar_position: 12 --- [//]: # (This file is auto-generated. Please do not modify it yourself.) diff --git a/predicates/did_components_2.md b/predicates/did_components_2.md index 7b99e219e1d..190b42a1e7e 100644 --- a/predicates/did_components_2.md +++ b/predicates/did_components_2.md @@ -1,5 +1,5 @@ --- -sidebar_position: 11 +sidebar_position: 13 --- [//]: # (This file is auto-generated. Please do not modify it yourself.) diff --git a/predicates/ecdsa_verify_4.md b/predicates/ecdsa_verify_4.md index 465511f0f8c..9544d43092c 100644 --- a/predicates/ecdsa_verify_4.md +++ b/predicates/ecdsa_verify_4.md @@ -1,5 +1,5 @@ --- -sidebar_position: 12 +sidebar_position: 14 --- [//]: # (This file is auto-generated. Please do not modify it yourself.) diff --git a/predicates/eddsa_verify_4.md b/predicates/eddsa_verify_4.md index a27e5f4a53a..8a2bc807c27 100644 --- a/predicates/eddsa_verify_4.md +++ b/predicates/eddsa_verify_4.md @@ -1,5 +1,5 @@ --- -sidebar_position: 13 +sidebar_position: 15 --- [//]: # (This file is auto-generated. Please do not modify it yourself.) diff --git a/predicates/hex_bytes_2.md b/predicates/hex_bytes_2.md index a10d7fc9964..04960329cf3 100644 --- a/predicates/hex_bytes_2.md +++ b/predicates/hex_bytes_2.md @@ -1,5 +1,5 @@ --- -sidebar_position: 14 +sidebar_position: 16 --- [//]: # (This file is auto-generated. Please do not modify it yourself.) diff --git a/predicates/json_prolog_2.md b/predicates/json_prolog_2.md index d5dbdea7129..d4434495c56 100644 --- a/predicates/json_prolog_2.md +++ b/predicates/json_prolog_2.md @@ -1,5 +1,5 @@ --- -sidebar_position: 15 +sidebar_position: 17 --- [//]: # (This file is auto-generated. Please do not modify it yourself.) diff --git a/predicates/json_read_2.md b/predicates/json_read_2.md new file mode 100644 index 00000000000..7a4c012b831 --- /dev/null +++ b/predicates/json_read_2.md @@ -0,0 +1,23 @@ +--- +sidebar_position: 18 +--- +[//]: # (This file is auto-generated. Please do not modify it yourself.) + +# json_read/2 + +## Description + +`json_read/2` is a predicate that reads a JSON from a stream and unifies it with a Prolog term. + +See json\_prolog/2 for the canonical representation of the JSON term. + +The signature is as follows: + +```text +json_read(+Stream, ?Term) is det +``` + +Where: + +- Stream is the input stream from which the JSON is read. +- Term is the Prolog term that represents the JSON structure. diff --git a/predicates/json_write_2.md b/predicates/json_write_2.md new file mode 100644 index 00000000000..8dd6a131b8a --- /dev/null +++ b/predicates/json_write_2.md @@ -0,0 +1,23 @@ +--- +sidebar_position: 19 +--- +[//]: # (This file is auto-generated. Please do not modify it yourself.) + +# json_write/2 + +## Description + +`json_write/2` is a predicate that writes a Prolog term as a JSON to a stream. + +The JSON object is of the same format as produced by json\_read/2. + +The signature is as follows: + +```text +json_write(+Stream, +Term) is det +``` + +Where: + +- Stream is the output stream to which the JSON is written. +- Term is the Prolog term that represents the JSON structure. diff --git a/predicates/open_3.md b/predicates/open_3.md index 5d5d5a0f0e6..2ab3cb54a6b 100644 --- a/predicates/open_3.md +++ b/predicates/open_3.md @@ -1,5 +1,5 @@ --- -sidebar_position: 17 +sidebar_position: 21 --- [//]: # (This file is auto-generated. Please do not modify it yourself.) diff --git a/predicates/open_4.md b/predicates/open_4.md index 8a3e2c5fb34..e18a4616b5f 100644 --- a/predicates/open_4.md +++ b/predicates/open_4.md @@ -1,5 +1,5 @@ --- -sidebar_position: 16 +sidebar_position: 20 --- [//]: # (This file is auto-generated. Please do not modify it yourself.) diff --git a/predicates/read_string_3.md b/predicates/read_string_3.md index c59005cc33a..e12694e99f4 100644 --- a/predicates/read_string_3.md +++ b/predicates/read_string_3.md @@ -1,5 +1,5 @@ --- -sidebar_position: 18 +sidebar_position: 22 --- [//]: # (This file is auto-generated. Please do not modify it yourself.) diff --git a/predicates/read_term_3.md b/predicates/read_term_3.md new file mode 100644 index 00000000000..2999fee7119 --- /dev/null +++ b/predicates/read_term_3.md @@ -0,0 +1,28 @@ +--- +sidebar_position: 23 +--- +[//]: # (This file is auto-generated. Please do not modify it yourself.) + +# read_term/3 + +## Description + +`read_term/3` is a predicate that reads a term from a stream or alias. + +The signature is as follows: + +```text +read_term(+Stream, -Term, +Options) +``` + +where: + +- Stream represents the stream or alias to read the term from. +- Term represents the term to read. +- Options represents the options to control the reading process. + +Valid options are: + +- singletons\(Vars\): Vars is unified with a list of variables that occur only once in the term. +- variables\(Vars\): Vars is unified with a list of variables that occur in the term. +- variable\_names\(Vars\): Vars is unified with a list of Name = Var terms, where Name is an atom and Var is a variable. diff --git a/predicates/source_file_1.md b/predicates/source_file_1.md index 17052a0adce..681f898f58e 100644 --- a/predicates/source_file_1.md +++ b/predicates/source_file_1.md @@ -1,5 +1,5 @@ --- -sidebar_position: 19 +sidebar_position: 24 --- [//]: # (This file is auto-generated. Please do not modify it yourself.) diff --git a/predicates/string_bytes_3.md b/predicates/string_bytes_3.md index c58eb1954c8..7c18359a743 100644 --- a/predicates/string_bytes_3.md +++ b/predicates/string_bytes_3.md @@ -1,5 +1,5 @@ --- -sidebar_position: 20 +sidebar_position: 25 --- [//]: # (This file is auto-generated. Please do not modify it yourself.) diff --git a/predicates/term_to_atom_2.md b/predicates/term_to_atom_2.md new file mode 100644 index 00000000000..6adefc70750 --- /dev/null +++ b/predicates/term_to_atom_2.md @@ -0,0 +1,30 @@ +--- +sidebar_position: 26 +--- +[//]: # (This file is auto-generated. Please do not modify it yourself.) + +# term_to_atom/2 + +## Description + +`term_to_atom/2` is a predicate that describes Atom as a term that unifies with Term. + +## Signature + +```text +term_to_atom(?Term, ?Atom) +``` + +where: + +- Term is a term that unifies with Atom. +- Atom is an atom. + +When Atom is instantiated, Atom is parsed and the result unified with Term. If Atom has no valid syntax, a syntax\_error exception is raised. Otherwise, Term is “written” on Atom using write\_term/2 with the option quoted\(true\). + +## Example + +```text +# Convert the atom to a term. +- term_to_atom(foo, foo). +``` diff --git a/predicates/uri_encoded_3.md b/predicates/uri_encoded_3.md index 983b97fbe48..96420d72ba0 100644 --- a/predicates/uri_encoded_3.md +++ b/predicates/uri_encoded_3.md @@ -1,5 +1,5 @@ --- -sidebar_position: 21 +sidebar_position: 27 --- [//]: # (This file is auto-generated. Please do not modify it yourself.) diff --git a/predicates/write_term_3.md b/predicates/write_term_3.md new file mode 100644 index 00000000000..6275841bed8 --- /dev/null +++ b/predicates/write_term_3.md @@ -0,0 +1,30 @@ +--- +sidebar_position: 28 +--- +[//]: # (This file is auto-generated. Please do not modify it yourself.) + +# write_term/3 + +## Description + +`write_term/3` is a predicate that writes a term to a stream or alias. + +The signature is as follows: + +```text +write_term(+Stream, +Term, +Options) +``` + +where: + +- Stream represents the stream or alias to write the term to. +- Term represents the term to write. +- Options represents the options to control the writing process. + +Valid options are: + +- quoted\(Bool\): If true, atoms and strings that need quotes will be quoted. The default is false. +- ignore\_ops\(Bool\): If true, the generic term representation \(\\(\ ... \)\) will be used for all terms. Otherwise \(default\), operators will be used where appropriate. +- numbervars\(Bool\): If true, variables will be numbered. The default is false. +- variable\_names\(\+List\): Assign names to variables in Term. List is a list of Name = Var terms, where Name is an atom and Var is a variable. +- max\_depth\(\+Int\): The maximum depth to which the term is written. The default is infinite.