aboutsummaryrefslogtreecommitdiffstats
path: root/man3/libnormalform_evaluate.3
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2024-07-19 01:29:42 +0200
committerMattias Andrée <maandree@kth.se>2024-07-19 01:29:42 +0200
commit4294ec0ed06ee34920c9edaeebaeb8b65c720791 (patch)
treee0cded59452597c04fb38f403745a384675cb5f9 /man3/libnormalform_evaluate.3
downloadlibnormalform-4294ec0ed06ee34920c9edaeebaeb8b65c720791.tar.gz
libnormalform-4294ec0ed06ee34920c9edaeebaeb8b65c720791.tar.bz2
libnormalform-4294ec0ed06ee34920c9edaeebaeb8b65c720791.tar.xz
First commit
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to '')
-rw-r--r--man3/libnormalform_evaluate.378
1 files changed, 78 insertions, 0 deletions
diff --git a/man3/libnormalform_evaluate.3 b/man3/libnormalform_evaluate.3
new file mode 100644
index 0000000..12675ee
--- /dev/null
+++ b/man3/libnormalform_evaluate.3
@@ -0,0 +1,78 @@
+.TH LIBNORMALFORM_EVALUATE 3 LIBNORMALFORM
+.SH NAME
+libnormalform_evaluate \- Determine value of a formula
+
+.SH SYNOPSIS
+.nf
+#include <libnormalform.h>
+
+int libnormalform_evaluate(LIBNORMALFORM_SENTENCE *\fIformula\fP);
+.fi
+.PP
+Link with
+.IR -lnormalform .
+
+.SH DESCRIPTION
+The
+.BR libnormalform_evaluate ()
+function determines the value of
+.IR formula .
+.PP
+Before calling the
+.BR libnormalform_evaluate ()
+function, the application must configure application
+defined parts of the formula. That is, any
+.IR "struct libnormalform_variable" ,
+.IR "struct libnormalform_function" ,
+.IR "struct libnormalform_map" ,
+and
+.IR "struct libnormalform_transformer"
+must be set configuared accord to the specifications
+specified for the function it was used in.
+
+.SH RETURN VALUE
+Upon successful completion, the
+.BR libnormalform_evaluate ()
+function returns 1 if the
+.I formula
+is true for configured input, 0 if the
+.I formula
+is false for configured input;
+otherwise, the function returns
+.IR -1 .
+
+.SH ERRORS
+The
+.BR libnormalform_evaluate ()
+function fails if an application function fails.
+The
+.BR libnormalform_evaluate ()
+function does not modify
+.IR errno ,
+but lets application functions modify
+.IR errno .
+
+.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_evaluate ()
+T} Thread safety MT-Safe race:\fIsentence\fP
+T{
+.BR libnormalform_evaluate ()
+T} Async-signal safety AS-Unsafe heap
+T{
+.BR libnormalform_evaluate ()
+T} Async-cancel safety AC-Safe mem, AC-Unsafe heap
+.TE
+
+.SH SEE ALSO
+.BR libnormalform (7)