aboutsummaryrefslogtreecommitdiffstats
path: root/man/libsimple_minimise_number_string.3
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2018-10-31 21:10:30 +0100
committerMattias Andrée <maandree@kth.se>2018-10-31 21:10:30 +0100
commit2db79cba45042bdacb5f2478bc02c5f80f1bb74f (patch)
tree6167a6e9a047b9ffe065fd5428b08bd1575eb375 /man/libsimple_minimise_number_string.3
parentAdd man page for timespectostr and timevaltostr (diff)
downloadlibsimple-2db79cba45042bdacb5f2478bc02c5f80f1bb74f.tar.gz
libsimple-2db79cba45042bdacb5f2478bc02c5f80f1bb74f.tar.bz2
libsimple-2db79cba45042bdacb5f2478bc02c5f80f1bb74f.tar.xz
More documentation
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to '')
-rw-r--r--man/libsimple_minimise_number_string.364
1 files changed, 64 insertions, 0 deletions
diff --git a/man/libsimple_minimise_number_string.3 b/man/libsimple_minimise_number_string.3
new file mode 100644
index 0000000..310b725
--- /dev/null
+++ b/man/libsimple_minimise_number_string.3
@@ -0,0 +1,64 @@
+.TH LIBSIMPLE_MINIMISE_NUMBER_STRING 3 2018-10-31 libsimple
+.SH NAME
+libsimple_minimise_number_string \- ninimise a numerical string
+.SH SYNOPSIS
+.nf
+#include <libsimple.h>
+
+char *libsimple_minimise_number_string(char *\fIs\fP);
+
+#ifndef minimise_number_string
+# define minimise_number_string libsimple_minimise_number_string
+#endif
+.fi
+.PP
+Link with
+.IR \-lsimple .
+.SH DESCRIPTION
+The
+.BR libsimple_minimise_number_string ()
+function minimises a string representing a real value with
+the assumption that the string is on the format
+.B [+-]\e?[0-9]*\e(\e.[0-9]*\e)\e?
+(repeating decimals are not supported).
+.SH RETURN VALUE
+The
+.BR libsimple_minimise_number_string ()
+function returns the pointer
+.IR s .
+.SH ERRORS
+The
+.BR libsimple_minimise_number_string ()
+function cannot fail.
+.SH ATTRIBUTES
+For an explanation of the terms used in this section, see
+.BR attributes (7).
+.TS
+allbox;
+lb lb lb
+l l l.
+Interface Attribute Value
+T{
+.BR libsimple_minimise_number_string ()
+T} Thread safety MT-Safe
+T{
+.BR libsimple_minimise_number_string ()
+T} Async-signal safety AS-Safe
+T{
+.BR libsimple_minimise_number_string ()
+T} Async-cancel safety AC-Safe
+.TE
+.SH EXAMPLES
+None.
+.SH APPLICATION USAGE
+None.
+.SH RATIONALE
+None.
+.SH FUTURE DIRECTIONS
+None.
+.SH NOTES
+None.
+.SH BUGS
+None.
+.SH SEE ALSO
+.BR libsimple_timespectostr (3)