doc-exports/docs/dli/sqlreference/dli_spark_ln.html
Su, Xiaomeng 76a5b1ee83 dli_sqlreference_20240227
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: Su, Xiaomeng <suxiaomeng1@huawei.com>
Co-committed-by: Su, Xiaomeng <suxiaomeng1@huawei.com>
2024-03-27 22:02:33 +00:00

50 lines
5.1 KiB
HTML

<a name="dli_spark_ln"></a><a name="dli_spark_ln"></a>
<h1 class="topictitle1">ln</h1>
<div id="body8662426"><p id="dli_spark_ln__en-us_topic_0000001648002600_p18471163815215">This function is used to return the natural logarithm of a given value.</p>
<div class="section" id="dli_spark_ln__en-us_topic_0000001648002600_section45291954203217"><h4 class="sectiontitle">Syntax</h4><pre class="screen" id="dli_spark_ln__en-us_topic_0000001648002600_screen19928459112517">ln(DOUBLE a)</pre>
</div>
<div class="section" id="dli_spark_ln__en-us_topic_0000001648002600_section992014913317"><h4 class="sectiontitle">Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_spark_ln__en-us_topic_0000001648002600_table1829154762513" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter</caption><thead align="left"><tr id="dli_spark_ln__en-us_topic_0000001648002600_row8830104792517"><th align="left" class="cellrowborder" valign="top" width="19.220000000000002%" id="mcps1.3.3.2.2.5.1.1"><p id="dli_spark_ln__en-us_topic_0000001648002600_p983074711252">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.44%" id="mcps1.3.3.2.2.5.1.2"><p id="dli_spark_ln__en-us_topic_0000001648002600_p6830124732517">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.57%" id="mcps1.3.3.2.2.5.1.3"><p id="dli_spark_ln__en-us_topic_0000001648002600_p13318164512614">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51.77%" id="mcps1.3.3.2.2.5.1.4"><p id="dli_spark_ln__en-us_topic_0000001648002600_p08301547132513">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_spark_ln__en-us_topic_0000001648002600_row15830184792511"><td class="cellrowborder" valign="top" width="19.220000000000002%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_spark_ln__en-us_topic_0000001648002600_p683034714250">a</p>
</td>
<td class="cellrowborder" valign="top" width="13.44%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_spark_ln__en-us_topic_0000001648002600_p12830184752518">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15.57%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_spark_ln__en-us_topic_0000001648002600_p0318545102615">DOUBLE, BIGINT, DECIMAL, or STRING</p>
</td>
<td class="cellrowborder" valign="top" width="51.77%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_spark_ln__en-us_topic_0000001648002600_p18653154615263">The value can be a float, integer, or string.</p>
<p id="dli_spark_ln__en-us_topic_0000001648002600_p9484232112711">If the value is not of the DOUBLE type, the system will implicitly convert it to the DOUBLE type for calculation.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dli_spark_ln__en-us_topic_0000001648002600_section210162513312"><h4 class="sectiontitle">Return Values</h4><p id="dli_spark_ln__en-us_topic_0000001648002600_p184124317231">The return value is of the DOUBLE type.</p>
<div class="note" id="dli_spark_ln__en-us_topic_0000001648002600_note61422099395"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="dli_spark_ln__en-us_topic_0000001648002600_ul3525245143511"><li id="dli_spark_ln__en-us_topic_0000001648002600_li152741248183517">If the value of <strong id="dli_spark_ln__en-us_topic_0000001648002600_b916411114596">a</strong> is negative or <strong id="dli_spark_ln__en-us_topic_0000001648002600_b125431721135917">0</strong>, <strong id="dli_spark_ln__en-us_topic_0000001648002600_b4547924135915">NULL</strong> is returned.</li><li id="dli_spark_ln__en-us_topic_0000001648002600_li152514452351">If the value of <strong id="dli_spark_ln__en-us_topic_0000001648002600_b40938601655756">a</strong> is <strong id="dli_spark_ln__en-us_topic_0000001648002600_b172919826055756">NULL</strong>, <strong id="dli_spark_ln__en-us_topic_0000001648002600_b74957399855756">NULL</strong> is returned.</li></ul>
</div></div>
</div>
<div class="section" id="dli_spark_ln__en-us_topic_0000001648002600_section13277192233920"><h4 class="sectiontitle">Example Code</h4><p id="dli_spark_ln__en-us_topic_0000001648002600_p467513165713">The value <strong id="dli_spark_ln__en-us_topic_0000001648002600_b14365138165911">1.144729868791239</strong> is returned.</p>
<pre class="screen" id="dli_spark_ln__en-us_topic_0000001648002600_screen735819141576">select ln(3.1415926);</pre>
<p id="dli_spark_ln__en-us_topic_0000001648002600_p8132116165716">The value <strong id="dli_spark_ln__en-us_topic_0000001648002600_b179503149065621">1</strong> is returned.</p>
<pre class="screen" id="dli_spark_ln__en-us_topic_0000001648002600_screen557812265710">select ln(2.718281828459045);</pre>
<p id="dli_spark_ln__en-us_topic_0000001648002600_p1564497165713">The value <strong id="dli_spark_ln__en-us_topic_0000001648002600_b454624610592">NULL</strong> is returned.</p>
<pre class="screen" id="dli_spark_ln__en-us_topic_0000001648002600_screen1053213431579">select ln(null);</pre>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dli_08_0473.html">Mathematical Functions</a></div>
</div>
</div>