diff options
Diffstat (limited to 'man3/libnormalform_and.3')
| -rw-r--r-- | man3/libnormalform_and.3 | 233 |
1 files changed, 233 insertions, 0 deletions
diff --git a/man3/libnormalform_and.3 b/man3/libnormalform_and.3 new file mode 100644 index 0000000..bb65a74 --- /dev/null +++ b/man3/libnormalform_and.3 @@ -0,0 +1,233 @@ +.TH LIBNORMALFORM_AND 3 LIBNORMALFORM +.SH NAME +libnormalform_and \- Conjunction + +.SH SYNOPSIS +.nf +#include <libnormalform.h> + +LIBNORMALFORM_SENTENCE *libnormalform_and(LIBNORMALFORM_SENTENCE **\fIxs\fP); +LIBNORMALFORM_SENTENCE *libnormalform_andl(LIBNORMALFORM_SENTENCE *\fIa\fP, ... /*, NULL */); +LIBNORMALFORM_SENTENCE *libnormalform_vand(LIBNORMALFORM_SENTENCE *\fIa\fP, va_list \fPargs\fP); +LIBNORMALFORM_SENTENCE *libnormalform_and_checked(size_t \fIn\fP, LIBNORMALFORM_SENTENCE **\fIxs\fP); +LIBNORMALFORM_SENTENCE *libnormalform_andl_checked(size_t \fIn\fP, LIBNORMALFORM_SENTENCE *\fIa\fP, ... /*, NULL */); +LIBNORMALFORM_SENTENCE *libnormalform_vand_checked(size_t \fIn\fP, LIBNORMALFORM_SENTENCE *\fIa\fP, va_list \fPargs\fP); +LIBNORMALFORM_SENTENCE *libnormalform_and2(LIBNORMALFORM_SENTENCE *\fIp\fP, LIBNORMALFORM_SENTENCE *\fIq\fP); +#define LIBNORMALFORM_AND(...) /* ... */ +.fi +.PP +Link with +.IR -lnormalform . + +.SH DESCRIPTION +The +.BR libnormalform_and () +function creates a sentence that is logically +equivalent to the conjunction of the arguments, +that is, a sentence that is true when and only +when all subsentences are true. +.PP +The value of the +.I xs +parameter shall be a null-pointer terminated list +of subsentences. +.PP +The +.BR libnormalform_andl () +function is a variant of +.BR libnormalform_and () +which uses variadic arguments instead of an array. +.PP +The +.BR libnormalform_vand () +function is a variant of +.BR libnormalform_andl () +which takes an +.I va_list +in place of variadic arguments. +.PP +The +.BR libnormalform_and_checked (), +.BR libnormalform_andl_checked (), +and +.BR libnormalform_vand_checked () +functions are variants of the +.BR libnormalform_and (), +.BR libnormalform_andl (), +and +.BR libnormalform_vand () +functions respectively which assumes +that it is given +.I n +subsentances, and checks that all are +.RI non- NULL . +However, these functions still require +the list of subsentences to be terminated +using a null-pointer. +.PP +.I "libnormalform_and2(p, q)" +is equivalent to +.IR "libnormalform_andl_checked(2, p, q, NULL)" . +.PP +The +.BR LIBNORMALFORM_AND +macro is a wrapper for the +.BR libnormalform_and_checked () +but is more similar to +.BR libnormalform_andl (). +Unlike +.BR libnormalform_andl (), +the argument list +.I must not +be terminated by a null-pointer, instead +the macro automatically as the null-pointer. +The macro will count the number of arguments +it is given, therefore it will fail it the +argument list is has an extra null-pointer. +.PP +The returned pointer shall either be +deallocated with the +.BR libnormalform_free (3) +function or be relinquished by being +used as part of another sentence. +.PP +These functions adopt the ownership of any +.I LIBNORMALFORM_SENTENCE * +passed into it. Therefore, the user shall +not attempt to deallocate input sentences. +This holds even on failure: if the function +fails, input sentences are deallocated. + +.SH RETURN VALUE +Upon successful completion, the +.BR libnormalform_and () +function and its variants return an object +representing the sentence; otherwise, the +functions return +.I NULL +and set +.I errno +to indicate the error. + +.SH ERRORS +These functions fails if: +.TP +.I ENOMEM +Insufficient memory was available to +create the sentence object. +.PP +The +.BR libnormalform_and_checked (), +.BR libnormalform_andl_checked (), +and +.BR libnormalform_vand_checked () +functions will also fail without setting +.I errno +if any of the first +.I n +.IR "LIBNORMALFORM_SENTENCE *" 's +are +.IR NULL . +Likewise, the +.BR libnormalform_and2 () +function will fail without setting +.I errno +if +.I p +or +.I q +is +.IR NULL . + +.SH ATTRIBUTES +For an explanation of the terms used in this +section, see +.BR attributes (7) +and +.IR "info \(dq(libc)POSIX Safety Concepts\(dq" . +.TS +allbox; +lb lb lb +l l l. +Interface Attribute Value +T{ +.BR libnormalform_and (), +.br +.BR libnormalform_and_checked () +T} Thread safety MT-Safe race:\fIxs\fP and elements in \fIxs\fP +T{ +.BR libnormalform_andl (), +.br +.BR libnormalform_andl_checked (), +.br +.BR libnormalform_and2 (), +.br +.BR LIBNORMALFORM_AND () +T} Thread safety MT-Safe race:parameters +T{ +.BR libnormalform_vand (), +.br +.BR libnormalform_vand_checked () +T} Thread safety MT-Safe race:parameters and arguments in \fIargs\fP +T{ +.BR libnormalform_and (), +.br +.BR libnormalform_andl (), +.br +.BR libnormalform_vand (), +.br +.BR libnormalform_and_checked (), +.br +.BR libnormalform_andl_checked (), +.br +.BR libnormalform_vand_checked (), +.br +.BR libnormalform_vand2 (), +.br +.BR LIBNORMALFORM_AND () +T} Async-signal safety AS-Unsafe heap +T{ +.BR libnormalform_and (), +.br +.BR libnormalform_andl (), +.br +.BR libnormalform_vand (), +.br +.BR libnormalform_and_checked (), +.br +.BR libnormalform_andl_checked (), +.br +.BR libnormalform_vand_checked (), +.br +.BR libnormalform_vand2 (), +.br +.BR LIBNORMALFORM_AND () +T} Async-cancel safety AC-Safe mem, AC-Unsafe heap +.TE + +.SH NOTES +If there are no subsentences, the resulting sentence is a tautology. +.PP +The connective is commutative and associative. It's truthtable is (0001). +.PP +The +.BR LIBNORMALFORM_AND () +macro requires ISO C23 support. +.PP +Using +.BR libnormalform_and2 (), +has greatest performance, however +.BR libnormalform_and () +is better at simplifying the sentence. +The other functions are just wrappers for the +.BR libnormalform_and () +function. +.PP +Side-effects in the arguments of the macro +.BR LIBNORMALFORM_AND () +are guaranteed to be applied exactly once. +The side-effects in each macro are applied +in no particular order. + +.SH SEE ALSO +.BR libnormalform (7) |