osmocom
/
libosmocore
mirror of https://gerrit.osmocom.org/libosmocore
11
0
Fork 0
Code Issues Releases Wiki Activity

doc tweaks for osmo_float_str_to_int(), osmo_int_to_float_str*() 

Drop nonexistent arg from api doc, fix "factor of a million", and explain a bit
more.

Change-Id: I131e839b6b7dd601b859313b358d346904c0e145
This commit is contained in:
Neels Hofmeyr 2020-10-08 13:09:49 +02:00 committed by laforge
parent a07f25e3ba
commit 6d744989e2
1 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/utils.c
View File

@ -1214,9 +1214,11 @@ bool osmo_str_startswith(const char *str, const char *startswith_str)
* 10 to-the-power-of precision to obtain the returned integer.
* The usable range of digits is -INT64_MAX .. INT64_MAX -- note, not INT64_MIN! The value of INT64_MIN is excluded to
* reduce implementation complexity. See also utils_test.c.
* The advantage over using sscanf("%f") is guaranteed precision: float or double types may apply rounding in the
* conversion result. osmo_float_str_to_int() and osmo_int_to_float_str_buf() guarantee true results when converting
* back and forth between string and int.
* \param[out] val Returned integer value.
* \param[in] str String of a float, like '-12.345'.
* \param[in] in_len Length of string to parse, or -1 to use strlen(str).
* \param[in] precision Fixed-point precision, or * \returns 0 on success, negative on error.
*/
int osmo_float_str_to_int(int64_t *val, const char *str, unsigned int precision)
@ -1331,8 +1333,14 @@ int osmo_float_str_to_int(int64_t *val, const char *str, unsigned int precision)
return 0;
}
/*! Convert an integer with a factor of a million to a floating point string.
/*! Convert an integer to a floating point string using a decimal quotient (fixed-point precision).
* For example, with precision = 3, convert -1230 to "-1.23".
* The usable range of digits is -INT64_MAX .. INT64_MAX -- note, not INT64_MIN! The value of INT64_MIN is excluded to
* reduce implementation complexity. See also utils_test.c.
* The advantage over using printf("%.6g") is guaranteed precision: float or double types may apply rounding in the
* conversion result. osmo_float_str_to_int() and osmo_int_to_float_str_buf() guarantee true results when converting
* back and forth between string and int.
* The resulting string omits trailing zeros in the fractional part (like "%g" would) but never applies rounding.
* \param[out] buf Buffer to write string to.
* \param[in] buflen sizeof(buf).
* \param[in] val Value to convert to float.