<p>laforge <strong>submitted</strong> this change.</p><p><a href="https://gerrit.osmocom.org/c/libosmocore/+/20480">View Change</a></p><div style="white-space:pre-wrap">Approvals:
  laforge: Looks good to me, approved
  pespin: Looks good to me, but someone else must approve
  Jenkins Builder: Verified

</div><pre style="font-family: monospace,monospace; white-space: pre-wrap;">doc tweaks for osmo_float_str_to_int(), osmo_int_to_float_str*()<br><br>Drop nonexistent arg from api doc, fix "factor of a million", and explain a bit<br>more.<br><br>Change-Id: I131e839b6b7dd601b859313b358d346904c0e145<br>---<br>M src/utils.c<br>1 file changed, 10 insertions(+), 2 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/src/utils.c b/src/utils.c</span><br><span>index 7fd7223..f5896c4 100644</span><br><span>--- a/src/utils.c</span><br><span>+++ b/src/utils.c</span><br><span>@@ -1214,9 +1214,11 @@</span><br><span>  * 10 to-the-power-of precision to obtain the returned integer.</span><br><span>  * The usable range of digits is -INT64_MAX .. INT64_MAX -- note, not INT64_MIN! The value of INT64_MIN is excluded to</span><br><span>  * reduce implementation complexity. See also utils_test.c.</span><br><span style="color: hsl(120, 100%, 40%);">+ * The advantage over using sscanf("%f") is guaranteed precision: float or double types may apply rounding in the</span><br><span style="color: hsl(120, 100%, 40%);">+ * conversion result. osmo_float_str_to_int() and osmo_int_to_float_str_buf() guarantee true results when converting</span><br><span style="color: hsl(120, 100%, 40%);">+ * back and forth between string and int.</span><br><span>  * \param[out] val  Returned integer value.</span><br><span>  * \param[in] str  String of a float, like '-12.345'.</span><br><span style="color: hsl(0, 100%, 40%);">- * \param[in] in_len  Length of string to parse, or -1 to use strlen(str).</span><br><span>  * \param[in] precision  Fixed-point precision, or  * \returns 0 on success, negative on error.</span><br><span>  */</span><br><span> int osmo_float_str_to_int(int64_t *val, const char *str, unsigned int precision)</span><br><span>@@ -1331,8 +1333,14 @@</span><br><span>     return 0;</span><br><span> }</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-/*! Convert an integer with a factor of a million to a floating point string.</span><br><span style="color: hsl(120, 100%, 40%);">+/*! Convert an integer to a floating point string using a decimal quotient (fixed-point precision).</span><br><span>  * For example, with precision = 3, convert -1230 to "-1.23".</span><br><span style="color: hsl(120, 100%, 40%);">+ * The usable range of digits is -INT64_MAX .. INT64_MAX -- note, not INT64_MIN! The value of INT64_MIN is excluded to</span><br><span style="color: hsl(120, 100%, 40%);">+ * reduce implementation complexity. See also utils_test.c.</span><br><span style="color: hsl(120, 100%, 40%);">+ * The advantage over using printf("%.6g") is guaranteed precision: float or double types may apply rounding in the</span><br><span style="color: hsl(120, 100%, 40%);">+ * conversion result. osmo_float_str_to_int() and osmo_int_to_float_str_buf() guarantee true results when converting</span><br><span style="color: hsl(120, 100%, 40%);">+ * back and forth between string and int.</span><br><span style="color: hsl(120, 100%, 40%);">+ * The resulting string omits trailing zeros in the fractional part (like "%g" would) but never applies rounding.</span><br><span>  * \param[out] buf  Buffer to write string to.</span><br><span>  * \param[in] buflen  sizeof(buf).</span><br><span>  * \param[in] val  Value to convert to float.</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/c/libosmocore/+/20480">change 20480</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.osmocom.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://gerrit.osmocom.org/c/libosmocore/+/20480"/><meta itemprop="name" content="View Change"/></div></div>

<div style="display:none"> Gerrit-Project: libosmocore </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-Change-Id: I131e839b6b7dd601b859313b358d346904c0e145 </div>
<div style="display:none"> Gerrit-Change-Number: 20480 </div>
<div style="display:none"> Gerrit-PatchSet: 2 </div>
<div style="display:none"> Gerrit-Owner: neels <nhofmeyr@sysmocom.de> </div>
<div style="display:none"> Gerrit-Reviewer: Jenkins Builder </div>
<div style="display:none"> Gerrit-Reviewer: laforge <laforge@osmocom.org> </div>
<div style="display:none"> Gerrit-Reviewer: pespin <pespin@sysmocom.de> </div>
<div style="display:none"> Gerrit-MessageType: merged </div>