mirror of
https://github.com/nim-lang/Nim.git
synced 2025-12-29 01:14:41 +00:00
561 lines
71 KiB
HTML
561 lines
71 KiB
HTML
<?xml version="1.0" encoding="utf-8" ?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<!-- This file is generated by Nim. -->
|
|
<html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en" data-theme="auto">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<title>std/hashes</title>
|
|
|
|
<!-- Google fonts -->
|
|
<link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
|
|
<link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
|
|
|
|
<!-- Favicon -->
|
|
<link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/>
|
|
<link rel="icon" type="image/png" sizes="32x32" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4QQQEwksSS9ZWwAAAk1JREFUWMPtll2ITVEUx39nn/O7Y5qR8f05wtCUUr6ZIS++8pEnkZInPImneaCQ5METNdOkeFBKUhMPRIkHKfEuUZSUlGlKPN2TrgfncpvmnntnmlEyq1Z7t89/rf9a6+y99oZxGZf/XeIq61EdtgKXgdXA0xrYAvBjOIF1AI9zvjcC74BSpndrJPkBWDScTF8Aa4E3wDlgHbASaANmVqlcCnwHvgDvgVfAJ+AikAAvgfVZwLnSVZHZaOuKoQi3ZOMi4NkYkpe1p4J7A8BpYAD49hfIy/oqG0+hLomiKP2L5L+1ubn5115S+3OAn4EnwBlgMzCjyt6ZAnQCJ4A7wOs88iRJHvw50HoujuPBoCKwHWiosy8MdfZnAdcHk8dxXFJ3VQbQlCTJvRBCGdRbD4M6uc5glpY3eAihpN5S5w12diSEcCCEcKUO4ljdr15T76ur1FDDLIQQ3qv71EdDOe3Kxj3leRXyk+pxdWnFWod6Wt2bY3de3aSuUHcPBVimHs7mK9WrmeOF6lR1o9qnzskh2ar2qm1qizpfXaPeVGdlmGN5pb09qMxz1Xb1kLqgzn1RyH7JUXW52lr5e/Kqi9qpto7V1atuUzfnARrV7jEib1T76gG2qxdGmXyiekkt1GswPTtek0aBfJp6YySGBfWg2tPQ0FAYgf1stUfdmdcjarbYJEniKIq6gY/Aw+zWHAC+p2labGpqiorFYgGYCEzN7oQdQClN07O1/EfDyGgC0ALMBdYAi4FyK+4H3gLPsxfR1zRNi+NP7nH5J+QntnXe5B5mpfQAAAAASUVORK5CYII=">
|
|
|
|
<!-- CSS -->
|
|
<link rel="stylesheet" type="text/css" href="nimdoc.out.css?v=2.3.1">
|
|
|
|
<!-- JS -->
|
|
<script type="text/javascript" src="dochack.js?v=2.3.1"></script>
|
|
</head>
|
|
<body>
|
|
<div class="document" id="documentId">
|
|
<div class="container">
|
|
<h1 class="title">std/hashes</h1>
|
|
<div class="row">
|
|
<div class="three columns">
|
|
<div class="theme-select-wrapper">
|
|
<label for="theme-select">Theme: </label>
|
|
<select id="theme-select" onchange="setTheme(this.value)">
|
|
<option value="auto">🌗 Match OS</option>
|
|
<option value="dark">🌑 Dark</option>
|
|
<option value="light">🌕 Light</option>
|
|
</select>
|
|
</div>
|
|
<div id="global-links">
|
|
<ul class="simple-boot">
|
|
<li><a href="manual.html">Manual</a></li>
|
|
<li><a href="lib.html">Standard library</a></li>
|
|
<li> <a id="indexLink" href="theindex.html">Index</a></li>
|
|
<li><a href="compiler/theindex.html">Compiler docs</a></li>
|
|
<li><a href="https://nim-lang.github.io/fusion/theindex.html">Fusion docs</a></li>
|
|
<li><a href="https://nim-lang.github.io/Nim/">devel</a>, <a href="https://nim-lang.org/documentation.html">stable</a></li>
|
|
</ul>
|
|
</div>
|
|
<div id="searchInputDiv">
|
|
Search: <input type="search" id="searchInput"
|
|
oninput="search()" />
|
|
</div>
|
|
|
|
<ul class="simple simple-toc" id="toc-list">
|
|
<li><a class="reference" id="see-also_toc" href="#see-also">See also</a></li>
|
|
<li>
|
|
<a class="reference reference-toplevel" href="#6" id="56">Imports</a>
|
|
</li>
|
|
<li>
|
|
<details open>
|
|
<summary><a class="reference reference-toplevel" href="#7" id="57">Types</a></summary>
|
|
<ul class="simple simple-toc-section">
|
|
<li><a class="reference" href="#Hash" title="Hash = int">Hash</a></li>
|
|
|
|
</ul>
|
|
</details>
|
|
</li>
|
|
<li>
|
|
<details open>
|
|
<summary><a class="reference reference-toplevel" href="#12" id="62">Procs</a></summary>
|
|
<ul class="simple simple-toc-section">
|
|
<ul class="simple nested-toc-section">!$
|
|
<li><a class="reference" href="#%21%24%2CHash" title="`!$`(h: Hash): Hash">`!$`(h: Hash): Hash</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">!&
|
|
<li><a class="reference" href="#%21%26%2CHash%2Cint" title="`!&`(h: Hash; val: int): Hash">`!&`(h: Hash; val: int): Hash</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">hash
|
|
<li><a class="reference" href="#hash%2Cstring%2Cint%2Cint" title="hash(sBuf: string; sPos, ePos: int): Hash">hash(sBuf: string; sPos, ePos: int): Hash</a></li>
|
|
<li><a class="reference" href="#hash%2Ccstring" title="hash(x: cstring): Hash">hash(x: cstring): Hash</a></li>
|
|
<li><a class="reference" href="#hash%2Cfloat" title="hash(x: float): Hash">hash(x: float): Hash</a></li>
|
|
<li><a class="reference" href="#hash%2Cpointer" title="hash(x: pointer): Hash">hash(x: pointer): Hash</a></li>
|
|
<li><a class="reference" href="#hash%2Cstring" title="hash(x: string): Hash">hash(x: string): Hash</a></li>
|
|
<li><a class="reference" href="#hash%2CopenArray%5BA%5D%2Cint%2Cint" title="hash[A](aBuf: openArray[A]; sPos, ePos: int): Hash">hash[A](aBuf: openArray[A]; sPos, ePos: int): Hash</a></li>
|
|
<li><a class="reference" href="#hash%2CopenArray%5BA%5D" title="hash[A](x: openArray[A]): Hash">hash[A](x: openArray[A]): Hash</a></li>
|
|
<li><a class="reference" href="#hash%2Cset%5BA%5D" title="hash[A](x: set[A]): Hash">hash[A](x: set[A]): Hash</a></li>
|
|
<li><a class="reference" href="#hash%2CT" title="hash[T: Ordinal | enum](x: T): Hash">hash[T: Ordinal | enum](x: T): Hash</a></li>
|
|
<li><a class="reference" href="#hash%2CT_2" title="hash[T: tuple | object | proc | iterator {.closure.}](x: T): Hash">hash[T: tuple | object | proc | iterator {.closure.}](x: T): Hash</a></li>
|
|
<li><a class="reference" href="#hash%2Cptr." title="hash[T](x: ptr [T]): Hash">hash[T](x: ptr [T]): Hash</a></li>
|
|
<li><a class="reference" href="#hash%2Cref." title="hash[T](x: ref [T]): Hash">hash[T](x: ref [T]): Hash</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">hashData
|
|
<li><a class="reference" href="#hashData%2Cpointer%2Cint" title="hashData(data: pointer; size: int): Hash">hashData(data: pointer; size: int): Hash</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">hashIdentity
|
|
<li><a class="reference" href="#hashIdentity%2CT" title="hashIdentity[T: Ordinal | enum](x: T): Hash">hashIdentity[T: Ordinal | enum](x: T): Hash</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">hashIgnoreCase
|
|
<li><a class="reference" href="#hashIgnoreCase%2Cstring%2Cint%2Cint" title="hashIgnoreCase(sBuf: string; sPos, ePos: int): Hash">hashIgnoreCase(sBuf: string; sPos, ePos: int): Hash</a></li>
|
|
<li><a class="reference" href="#hashIgnoreCase%2Cstring" title="hashIgnoreCase(x: string): Hash">hashIgnoreCase(x: string): Hash</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">hashIgnoreStyle
|
|
<li><a class="reference" href="#hashIgnoreStyle%2Cstring%2Cint%2Cint" title="hashIgnoreStyle(sBuf: string; sPos, ePos: int): Hash">hashIgnoreStyle(sBuf: string; sPos, ePos: int): Hash</a></li>
|
|
<li><a class="reference" href="#hashIgnoreStyle%2Cstring" title="hashIgnoreStyle(x: string): Hash">hashIgnoreStyle(x: string): Hash</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">hashWangYi1
|
|
<li><a class="reference" href="#hashWangYi1" title="hashWangYi1(x: int64 | uint64 | Hash): Hash">hashWangYi1(x: int64 | uint64 | Hash): Hash</a></li>
|
|
|
|
</ul>
|
|
|
|
</ul>
|
|
</details>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</div>
|
|
<div class="nine columns" id="content">
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/hashes.nim#L1" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/hashes.nim#L1" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
<div id="tocRoot"></div>
|
|
|
|
<p class="module-desc">This module implements efficient computations of hash values for diverse Nim types. All the procs are based on these two building blocks:<ul class="simple"><li><a class="reference external" href="#!&,Hash,int">!& proc</a> used to start or mix a hash value, and</li>
|
|
<li><a class="reference external" href="#!$,Hash">!$ proc</a> used to finish the hash value.</li>
|
|
</ul>
|
|
<p>If you want to implement hash procs for your custom types, you will end up writing the following kind of skeleton of code:</p>
|
|
|
|
<p><strong class="examples_text">Example:</strong></p>
|
|
<pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">hashes</span>
|
|
<span class="Keyword">type</span>
|
|
<span class="Identifier">Something</span> <span class="Operator">=</span> <span class="Keyword">object</span>
|
|
<span class="Identifier">foo</span><span class="Punctuation">:</span> <span class="Identifier">int</span>
|
|
<span class="Identifier">bar</span><span class="Punctuation">:</span> <span class="Identifier">string</span>
|
|
|
|
<span class="Keyword">iterator</span> <span class="Identifier">items</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Punctuation">:</span> <span class="Identifier">Something</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Identifier">Hash</span> <span class="Operator">=</span>
|
|
<span class="Keyword">yield</span> <span class="Identifier">hash</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Operator">.</span><span class="Identifier">foo</span><span class="Punctuation">)</span>
|
|
<span class="Keyword">yield</span> <span class="Identifier">hash</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Operator">.</span><span class="Identifier">bar</span><span class="Punctuation">)</span>
|
|
|
|
<span class="Keyword">proc</span> <span class="Identifier">hash</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Punctuation">:</span> <span class="Identifier">Something</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Identifier">Hash</span> <span class="Operator">=</span>
|
|
<span class="Comment">## Computes a Hash from `x`.</span>
|
|
<span class="Keyword">var</span> <span class="Identifier">h</span><span class="Punctuation">:</span> <span class="Identifier">Hash</span> <span class="Operator">=</span> <span class="DecNumber">0</span>
|
|
<span class="Comment"># Iterate over parts of `x`.</span>
|
|
<span class="Keyword">for</span> <span class="Identifier">xAtom</span> <span class="Keyword">in</span> <span class="Identifier">x</span><span class="Punctuation">:</span>
|
|
<span class="Comment"># Mix the atom with the partial hash.</span>
|
|
<span class="Identifier">h</span> <span class="Operator">=</span> <span class="Identifier">h</span> <span class="Operator">!&</span> <span class="Identifier">xAtom</span>
|
|
<span class="Comment"># Finish the hash.</span>
|
|
<span class="Identifier">result</span> <span class="Operator">=</span> <span class="Operator">!$</span><span class="Identifier">h</span></pre>If your custom types contain fields for which there already is a <tt class="docutils literal"><span class="pre"><span class="Identifier">hash</span></span></tt> proc, you can simply hash together the hash values of the individual fields:
|
|
<p><strong class="examples_text">Example:</strong></p>
|
|
<pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">hashes</span>
|
|
<span class="Keyword">type</span>
|
|
<span class="Identifier">Something</span> <span class="Operator">=</span> <span class="Keyword">object</span>
|
|
<span class="Identifier">foo</span><span class="Punctuation">:</span> <span class="Identifier">int</span>
|
|
<span class="Identifier">bar</span><span class="Punctuation">:</span> <span class="Identifier">string</span>
|
|
|
|
<span class="Keyword">proc</span> <span class="Identifier">hash</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Punctuation">:</span> <span class="Identifier">Something</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Identifier">Hash</span> <span class="Operator">=</span>
|
|
<span class="Comment">## Computes a Hash from `x`.</span>
|
|
<span class="Keyword">var</span> <span class="Identifier">h</span><span class="Punctuation">:</span> <span class="Identifier">Hash</span> <span class="Operator">=</span> <span class="DecNumber">0</span>
|
|
<span class="Identifier">h</span> <span class="Operator">=</span> <span class="Identifier">h</span> <span class="Operator">!&</span> <span class="Identifier">hash</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Operator">.</span><span class="Identifier">foo</span><span class="Punctuation">)</span>
|
|
<span class="Identifier">h</span> <span class="Operator">=</span> <span class="Identifier">h</span> <span class="Operator">!&</span> <span class="Identifier">hash</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Operator">.</span><span class="Identifier">bar</span><span class="Punctuation">)</span>
|
|
<span class="Identifier">result</span> <span class="Operator">=</span> <span class="Operator">!$</span><span class="Identifier">h</span></pre><div class="admonition admonition-warning"><span class="admonition-warning-text"><b>Important:</b></span>
|
|
Use <tt class="docutils literal"><span class="pre"><span class="Operator">-</span><span class="Identifier">d</span><span class="Punctuation">:</span><span class="Identifier">nimPreviewHashRef</span></span></tt> to enable hashing <tt class="docutils literal"><span class="pre"><span class="Keyword">ref</span></span></tt>s. It is expected that this behavior becomes the new default in upcoming versions.</div>
|
|
<div class="admonition admonition-info"><span class="admonition-info-text"><b>Note:</b></span>
|
|
If the type has a <tt class="docutils literal"><span class="pre"><span class="Operator">==</span></span></tt> operator, the following must hold: If two values compare equal, their hashes must also be equal.</div>
|
|
|
|
<h1><a class="toc-backref" id="see-also" href="#see-also">See also</a></h1><ul class="simple"><li><a class="reference external" href="md5.html">md5 module</a> for the MD5 checksum algorithm</li>
|
|
<li><a class="reference external" href="base64.html">base64 module</a> for a Base64 encoder and decoder</li>
|
|
<li><a class="reference external" href="sha1.html">sha1 module</a> for the SHA-1 checksum algorithm</li>
|
|
<li><a class="reference external" href="tables.html">tables module</a> for hash tables</li>
|
|
</ul>
|
|
</p>
|
|
<div class="section" id="6">
|
|
<h1><a class="toc-backref" href="#6">Imports</a></h1>
|
|
<dl class="item">
|
|
<a class="reference external" href="since.html">since</a>, <a class="reference external" href="jsutils.html">jsutils</a>, <a class="reference external" href="assertions.html">assertions</a>, <a class="reference external" href="endians.html">endians</a>
|
|
</dl>
|
|
</div>
|
|
<div class="section" id="7">
|
|
<h1><a class="toc-backref" href="#7">Types</a></h1>
|
|
<dl class="item">
|
|
<div id="Hash">
|
|
<dt><pre><a href="hashes.html#Hash"><span class="Identifier">Hash</span></a> <span class="Other">=</span> <a href="system.html#int"><span class="Identifier">int</span></a></pre></dt>
|
|
<dd>
|
|
|
|
A hash value. Hash tables using these values should always have a size of a power of two so they can use the <tt class="docutils literal"><span class="pre"><span class="Keyword">and</span></span></tt> operator instead of <tt class="docutils literal"><span class="pre"><span class="Keyword">mod</span></span></tt> for truncation of the hash value.
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/hashes.nim#L75" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/hashes.nim#L75" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</dl>
|
|
</div>
|
|
<div class="section" id="12">
|
|
<h1><a class="toc-backref" href="#12">Procs</a></h1>
|
|
<dl class="item">
|
|
<div id="!$-procs-all">
|
|
<div id="!$,Hash">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#%21%24%2CHash"><span class="Identifier">`!$`</span></a><span class="Other">(</span><span class="Identifier">h</span><span class="Other">:</span> <a href="hashes.html#Hash"><span class="Identifier">Hash</span></a><span class="Other">)</span><span class="Other">:</span> <a href="hashes.html#Hash"><span class="Identifier">Hash</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
<p>Finishes the computation of the hash value.</p>
|
|
<p>This is only needed if you need to implement a <tt class="docutils literal"><span class="pre"><span class="Identifier">hash</span></span></tt> proc for a new datatype.</p>
|
|
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/hashes.nim#L90" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/hashes.nim#L90" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="!&-procs-all">
|
|
<div id="!&,Hash,int">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#%21%26%2CHash%2Cint"><span class="Identifier">`!&`</span></a><span class="Other">(</span><span class="Identifier">h</span><span class="Other">:</span> <a href="hashes.html#Hash"><span class="Identifier">Hash</span></a><span class="Other">;</span> <span class="Identifier">val</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="hashes.html#Hash"><span class="Identifier">Hash</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
<p>Mixes a hash value <tt class="docutils literal"><span class="pre"><span class="Identifier">h</span></span></tt> with <tt class="docutils literal"><span class="pre"><span class="Identifier">val</span></span></tt> to produce a new hash value.</p>
|
|
<p>This is only needed if you need to implement a <tt class="docutils literal"><span class="pre"><span class="Identifier">hash</span></span></tt> proc for a new datatype.</p>
|
|
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/hashes.nim#L79" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/hashes.nim#L79" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="hash-procs-all">
|
|
<div id="hash,string,int,int">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#hash%2Cstring%2Cint%2Cint"><span class="Identifier">hash</span></a><span class="Other">(</span><span class="Identifier">sBuf</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">sPos</span><span class="Other">,</span> <span class="Identifier">ePos</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="hashes.html#Hash"><span class="Identifier">Hash</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
|
<span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
<p>Efficient hashing of a string buffer, from starting position <tt class="docutils literal"><span class="pre"><span class="Identifier">sPos</span></span></tt> to ending position <tt class="docutils literal"><span class="pre"><span class="Identifier">ePos</span></span></tt> (included).</p>
|
|
<p><tt class="docutils literal"><span class="pre"><span class="Identifier">hash</span><span class="Punctuation">(</span><span class="Identifier">myStr</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">,</span> <span class="Identifier">myStr</span><span class="Operator">.</span><span class="Identifier">high</span><span class="Punctuation">)</span></span></tt> is equivalent to <tt class="docutils literal"><span class="pre"><span class="Identifier">hash</span><span class="Punctuation">(</span><span class="Identifier">myStr</span><span class="Punctuation">)</span></span></tt>.</p>
|
|
|
|
<p><strong class="examples_text">Example:</strong></p>
|
|
<pre class="listing"><span class="Keyword">var</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="StringLit">"abracadabra"</span>
|
|
<span class="Identifier">doAssert</span> <span class="Identifier">hash</span><span class="Punctuation">(</span><span class="Identifier">a</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">hash</span><span class="Punctuation">(</span><span class="Identifier">a</span><span class="Punctuation">,</span> <span class="DecNumber">7</span><span class="Punctuation">,</span> <span class="DecNumber">10</span><span class="Punctuation">)</span></pre>
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/hashes.nim#L562" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/hashes.nim#L562" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="hash,cstring">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#hash%2Ccstring"><span class="Identifier">hash</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a><span class="Other">)</span><span class="Other">:</span> <a href="hashes.html#Hash"><span class="Identifier">Hash</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
Efficient hashing of null-terminated strings.
|
|
<p><strong class="examples_text">Example:</strong></p>
|
|
<pre class="listing"><span class="Identifier">doAssert</span> <span class="Identifier">hash</span><span class="Punctuation">(</span><span class="RawData">cstring"abracadabra"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">hash</span><span class="Punctuation">(</span><span class="StringLit">"abracadabra"</span><span class="Punctuation">)</span>
|
|
<span class="Identifier">doAssert</span> <span class="Identifier">hash</span><span class="Punctuation">(</span><span class="RawData">cstring"AbracadabrA"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">hash</span><span class="Punctuation">(</span><span class="StringLit">"AbracadabrA"</span><span class="Punctuation">)</span>
|
|
<span class="Identifier">doAssert</span> <span class="Identifier">hash</span><span class="Punctuation">(</span><span class="RawData">cstring"abracadabra"</span><span class="Punctuation">)</span> <span class="Operator">!=</span> <span class="Identifier">hash</span><span class="Punctuation">(</span><span class="RawData">cstring"AbracadabrA"</span><span class="Punctuation">)</span></pre>
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/hashes.nim#L538" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/hashes.nim#L538" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="hash,float">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#hash%2Cfloat"><span class="Identifier">hash</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#float"><span class="Identifier">float</span></a><span class="Other">)</span><span class="Other">:</span> <a href="hashes.html#Hash"><span class="Identifier">Hash</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
Efficient hashing of floats.
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/hashes.nim#L273" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/hashes.nim#L273" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="hash,pointer">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#hash%2Cpointer"><span class="Identifier">hash</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a><span class="Other">)</span><span class="Other">:</span> <a href="hashes.html#Hash"><span class="Identifier">Hash</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
Efficient <tt class="docutils literal"><span class="pre"><span class="Identifier">hash</span></span></tt> overload.
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/hashes.nim#L232" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/hashes.nim#L232" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="hash,string">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#hash%2Cstring"><span class="Identifier">hash</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="hashes.html#Hash"><span class="Identifier">Hash</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
<p>Efficient hashing of strings.</p>
|
|
<p><strong>See also:</strong></p>
|
|
<ul class="simple"><li><a class="reference external" href="#hashIgnoreStyle,string">hashIgnoreStyle</a></li>
|
|
<li><a class="reference external" href="#hashIgnoreCase,string">hashIgnoreCase</a></li>
|
|
</ul>
|
|
|
|
<p><strong class="examples_text">Example:</strong></p>
|
|
<pre class="listing"><span class="Identifier">doAssert</span> <span class="Identifier">hash</span><span class="Punctuation">(</span><span class="StringLit">"abracadabra"</span><span class="Punctuation">)</span> <span class="Operator">!=</span> <span class="Identifier">hash</span><span class="Punctuation">(</span><span class="StringLit">"AbracadabrA"</span><span class="Punctuation">)</span></pre>
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/hashes.nim#L521" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/hashes.nim#L521" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="hash,openArray[A],int,int">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#hash%2CopenArray%5BA%5D%2Cint%2Cint"><span class="Identifier">hash</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">aBuf</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">sPos</span><span class="Other">,</span> <span class="Identifier">ePos</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="hashes.html#Hash"><span class="Identifier">Hash</span></a></pre></dt>
|
|
<dd>
|
|
|
|
<p>Efficient hashing of portions of arrays and sequences, from starting position <tt class="docutils literal"><span class="pre"><span class="Identifier">sPos</span></span></tt> to ending position <tt class="docutils literal"><span class="pre"><span class="Identifier">ePos</span></span></tt> (included). There must be a <tt class="docutils literal"><span class="pre"><span class="Identifier">hash</span></span></tt> proc defined for the element type <tt class="docutils literal"><span class="pre"><span class="Identifier">A</span></span></tt>.</p>
|
|
<p><tt class="docutils literal"><span class="pre"><span class="Identifier">hash</span><span class="Punctuation">(</span><span class="Identifier">myBuf</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">,</span> <span class="Identifier">myBuf</span><span class="Operator">.</span><span class="Identifier">high</span><span class="Punctuation">)</span></span></tt> is equivalent to <tt class="docutils literal"><span class="pre"><span class="Identifier">hash</span><span class="Punctuation">(</span><span class="Identifier">myBuf</span><span class="Punctuation">)</span></span></tt>.</p>
|
|
|
|
<p><strong class="examples_text">Example:</strong></p>
|
|
<pre class="listing"><span class="Keyword">let</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="Punctuation">[</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">,</span> <span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">6</span><span class="Punctuation">]</span>
|
|
<span class="Identifier">doAssert</span> <span class="Identifier">hash</span><span class="Punctuation">(</span><span class="Identifier">a</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">,</span> <span class="DecNumber">1</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">hash</span><span class="Punctuation">(</span><span class="Identifier">a</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">4</span><span class="Punctuation">)</span></pre>
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/hashes.nim#L728" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/hashes.nim#L728" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="hash,openArray[A]">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#hash%2CopenArray%5BA%5D"><span class="Identifier">hash</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="hashes.html#Hash"><span class="Identifier">Hash</span></a></pre></dt>
|
|
<dd>
|
|
|
|
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/hashes.nim#L287" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/hashes.nim#L287" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="hash,set[A]">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#hash%2Cset%5BA%5D"><span class="Identifier">hash</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="hashes.html#Hash"><span class="Identifier">Hash</span></a></pre></dt>
|
|
<dd>
|
|
|
|
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/hashes.nim#L288" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/hashes.nim#L288" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="hash,T">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#hash%2CT"><span class="Identifier">hash</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#Ordinal"><span class="Identifier">Ordinal</span></a> <span class="Operator">|</span> <span class="Keyword">enum</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <a href="hashes.html#Hash"><span class="Identifier">Hash</span></a> {.<span class="Identifier">inline</span>.}</pre></dt>
|
|
<dd>
|
|
|
|
Efficient hashing of integers.
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/hashes.nim#L214" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/hashes.nim#L214" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="hash,T_2">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#hash%2CT_2"><span class="Identifier">hash</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Keyword">tuple</span> <span class="Operator">|</span> <span class="Keyword">object</span> <span class="Operator">|</span> <span class="Keyword">proc</span> <span class="Operator">|</span> <span class="Keyword">iterator</span> {.<span class="Identifier">closure</span>.}<span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <a href="hashes.html#Hash"><span class="Identifier">Hash</span></a></pre></dt>
|
|
<dd>
|
|
|
|
Efficient <tt class="docutils literal"><span class="pre"><span class="Identifier">hash</span></span></tt> overload.
|
|
<p><strong class="examples_text">Example:</strong></p>
|
|
<pre class="listing"><span class="Comment"># for `tuple|object`, `hash` must be defined for each component of `x`.</span>
|
|
<span class="Keyword">type</span> <span class="Identifier">Obj</span> <span class="Operator">=</span> <span class="Keyword">object</span>
|
|
<span class="Identifier">x</span><span class="Punctuation">:</span> <span class="Identifier">int</span>
|
|
<span class="Identifier">y</span><span class="Punctuation">:</span> <span class="Identifier">string</span>
|
|
<span class="Keyword">type</span> <span class="Identifier">Obj2</span><span class="Punctuation">[</span><span class="Identifier">T</span><span class="Punctuation">]</span> <span class="Operator">=</span> <span class="Keyword">object</span>
|
|
<span class="Identifier">x</span><span class="Punctuation">:</span> <span class="Identifier">int</span>
|
|
<span class="Identifier">y</span><span class="Punctuation">:</span> <span class="Identifier">string</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">hash</span><span class="Punctuation">(</span><span class="Identifier">Obj</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Punctuation">:</span> <span class="DecNumber">520</span><span class="Punctuation">,</span> <span class="Identifier">y</span><span class="Punctuation">:</span> <span class="StringLit">"Nim"</span><span class="Punctuation">)</span><span class="Punctuation">)</span> <span class="Operator">!=</span> <span class="Identifier">hash</span><span class="Punctuation">(</span><span class="Identifier">Obj</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Punctuation">:</span> <span class="DecNumber">520</span><span class="Punctuation">,</span> <span class="Identifier">y</span><span class="Punctuation">:</span> <span class="StringLit">"Nim2"</span><span class="Punctuation">)</span><span class="Punctuation">)</span>
|
|
<span class="Comment"># you can define custom hashes for objects (even if they're generic):</span>
|
|
<span class="Keyword">proc</span> <span class="Identifier">hash</span><span class="Punctuation">(</span><span class="Identifier">a</span><span class="Punctuation">:</span> <span class="Identifier">Obj2</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Identifier">Hash</span> <span class="Operator">=</span> <span class="Identifier">hash</span><span class="Punctuation">(</span><span class="Punctuation">(</span><span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">x</span><span class="Punctuation">)</span><span class="Punctuation">)</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">hash</span><span class="Punctuation">(</span><span class="Identifier">Obj2</span><span class="Punctuation">[</span><span class="Identifier">float</span><span class="Punctuation">]</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Punctuation">:</span> <span class="DecNumber">520</span><span class="Punctuation">,</span> <span class="Identifier">y</span><span class="Punctuation">:</span> <span class="StringLit">"Nim"</span><span class="Punctuation">)</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">hash</span><span class="Punctuation">(</span><span class="Identifier">Obj2</span><span class="Punctuation">[</span><span class="Identifier">float</span><span class="Punctuation">]</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Punctuation">:</span> <span class="DecNumber">520</span><span class="Punctuation">,</span> <span class="Identifier">y</span><span class="Punctuation">:</span> <span class="StringLit">"Nim2"</span><span class="Punctuation">)</span><span class="Punctuation">)</span></pre>
|
|
<p><strong class="examples_text">Example:</strong></p>
|
|
<pre class="listing"><span class="Comment"># proc</span>
|
|
<span class="Keyword">proc</span> <span class="Identifier">fn1</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">=</span> <span class="Keyword">discard</span>
|
|
<span class="Keyword">const</span> <span class="Identifier">fn1b</span> <span class="Operator">=</span> <span class="Identifier">fn1</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">hash</span><span class="Punctuation">(</span><span class="Identifier">fn1b</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">hash</span><span class="Punctuation">(</span><span class="Identifier">fn1</span><span class="Punctuation">)</span>
|
|
|
|
<span class="Comment"># closure</span>
|
|
<span class="Keyword">proc</span> <span class="Identifier">outer</span> <span class="Operator">=</span>
|
|
<span class="Keyword">var</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="DecNumber">0</span>
|
|
<span class="Keyword">proc</span> <span class="Identifier">fn2</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">=</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">inc</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">fn2</span> <span class="Keyword">is</span> <span class="StringLit">"closure"</span>
|
|
<span class="Keyword">let</span> <span class="Identifier">fn2b</span> <span class="Operator">=</span> <span class="Identifier">fn2</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">hash</span><span class="Punctuation">(</span><span class="Identifier">fn2b</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">hash</span><span class="Punctuation">(</span><span class="Identifier">fn2</span><span class="Punctuation">)</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">hash</span><span class="Punctuation">(</span><span class="Identifier">fn2</span><span class="Punctuation">)</span> <span class="Operator">!=</span> <span class="Identifier">hash</span><span class="Punctuation">(</span><span class="Identifier">fn1</span><span class="Punctuation">)</span>
|
|
<span class="Identifier">outer</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/hashes.nim#L666" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/hashes.nim#L666" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="hash,ptr.">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#hash%2Cptr."><span class="Identifier">hash</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="hashes.html#Hash"><span class="Identifier">Hash</span></a> {.<span class="Identifier">inline</span>.}</pre></dt>
|
|
<dd>
|
|
|
|
Efficient <tt class="docutils literal"><span class="pre"><span class="Identifier">hash</span></span></tt> overload.
|
|
<p><strong class="examples_text">Example:</strong></p>
|
|
<pre class="listing"><span class="Keyword">var</span> <span class="Identifier">a</span><span class="Punctuation">:</span> <span class="Identifier">array</span><span class="Punctuation">[</span><span class="DecNumber">10</span><span class="Punctuation">,</span> <span class="Identifier">uint8</span><span class="Punctuation">]</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">a</span><span class="Punctuation">[</span><span class="DecNumber">0</span><span class="Punctuation">]</span><span class="Operator">.</span><span class="Keyword">addr</span><span class="Operator">.</span><span class="Identifier">hash</span> <span class="Operator">!=</span> <span class="Identifier">a</span><span class="Punctuation">[</span><span class="DecNumber">1</span><span class="Punctuation">]</span><span class="Operator">.</span><span class="Keyword">addr</span><span class="Operator">.</span><span class="Identifier">hash</span>
|
|
<span class="Identifier">assert</span> <span class="Keyword">cast</span><span class="Punctuation">[</span><span class="Identifier">pointer</span><span class="Punctuation">]</span><span class="Punctuation">(</span><span class="Identifier">a</span><span class="Punctuation">[</span><span class="DecNumber">0</span><span class="Punctuation">]</span><span class="Operator">.</span><span class="Keyword">addr</span><span class="Punctuation">)</span><span class="Operator">.</span><span class="Identifier">hash</span> <span class="Operator">==</span> <span class="Identifier">a</span><span class="Punctuation">[</span><span class="DecNumber">0</span><span class="Punctuation">]</span><span class="Operator">.</span><span class="Keyword">addr</span><span class="Operator">.</span><span class="Identifier">hash</span></pre>
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/hashes.nim#L240" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/hashes.nim#L240" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="hash,ref.">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#hash%2Cref."><span class="Identifier">hash</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">ref</span> <span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="hashes.html#Hash"><span class="Identifier">Hash</span></a> {.<span class="Identifier">inline</span>.}</pre></dt>
|
|
<dd>
|
|
|
|
Efficient <tt class="docutils literal"><span class="pre"><span class="Identifier">hash</span></span></tt> overload.<div class="admonition admonition-warning"><span class="admonition-warning-text"><b>Important:</b></span>
|
|
Use <tt class="docutils literal"><span class="pre"><span class="Operator">-</span><span class="Identifier">d</span><span class="Punctuation">:</span><span class="Identifier">nimPreviewHashRef</span></span></tt> to enable hashing <tt class="docutils literal"><span class="pre"><span class="Keyword">ref</span></span></tt>s. It is expected that this behavior becomes the new default in upcoming versions.</div>
|
|
|
|
<p><strong class="examples_text">Example: cmd: -d:nimPreviewHashRef</strong></p>
|
|
<pre class="listing"><span class="Keyword">type</span> <span class="Identifier">A</span> <span class="Operator">=</span> <span class="Keyword">ref</span> <span class="Keyword">object</span>
|
|
<span class="Identifier">x</span><span class="Punctuation">:</span> <span class="Identifier">int</span>
|
|
<span class="Keyword">let</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="Identifier">A</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Punctuation">:</span> <span class="DecNumber">3</span><span class="Punctuation">)</span>
|
|
<span class="Keyword">let</span> <span class="Identifier">ha</span> <span class="Operator">=</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">hash</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">ha</span> <span class="Operator">!=</span> <span class="Identifier">A</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Punctuation">:</span> <span class="DecNumber">3</span><span class="Punctuation">)</span><span class="Operator">.</span><span class="Identifier">hash</span> <span class="Comment"># A(x: 3) is a different ref object from `a`.</span>
|
|
<span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">x</span> <span class="Operator">=</span> <span class="DecNumber">4</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">ha</span> <span class="Operator">==</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">hash</span> <span class="Comment"># the hash only depends on the address</span></pre>
|
|
<p><strong class="examples_text">Example: cmd: -d:nimPreviewHashRef</strong></p>
|
|
<pre class="listing"><span class="Comment"># you can overload `hash` if you want to customize semantics</span>
|
|
<span class="Keyword">type</span> <span class="Identifier">A</span><span class="Punctuation">[</span><span class="Identifier">T</span><span class="Punctuation">]</span> <span class="Operator">=</span> <span class="Keyword">ref</span> <span class="Keyword">object</span>
|
|
<span class="Identifier">x</span><span class="Punctuation">,</span> <span class="Identifier">y</span><span class="Punctuation">:</span> <span class="Identifier">T</span>
|
|
<span class="Keyword">proc</span> <span class="Identifier">hash</span><span class="Punctuation">(</span><span class="Identifier">a</span><span class="Punctuation">:</span> <span class="Identifier">A</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Identifier">Hash</span> <span class="Operator">=</span> <span class="Identifier">hash</span><span class="Punctuation">(</span><span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">x</span><span class="Punctuation">)</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">A</span><span class="Punctuation">[</span><span class="Identifier">int</span><span class="Punctuation">]</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Punctuation">:</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="Identifier">y</span><span class="Punctuation">:</span> <span class="DecNumber">4</span><span class="Punctuation">)</span><span class="Operator">.</span><span class="Identifier">hash</span> <span class="Operator">==</span> <span class="Identifier">A</span><span class="Punctuation">[</span><span class="Identifier">int</span><span class="Punctuation">]</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Punctuation">:</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="Identifier">y</span><span class="Punctuation">:</span> <span class="DecNumber">5</span><span class="Punctuation">)</span><span class="Operator">.</span><span class="Identifier">hash</span></pre>
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/hashes.nim#L249" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/hashes.nim#L249" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="hashData-procs-all">
|
|
<div id="hashData,pointer,int">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#hashData%2Cpointer%2Cint"><span class="Identifier">hashData</span></a><span class="Other">(</span><span class="Identifier">data</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a><span class="Other">;</span> <span class="Identifier">size</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="hashes.html#Hash"><span class="Identifier">Hash</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
|
<span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
Hashes an array of bytes of size <tt class="docutils literal"><span class="pre"><span class="Identifier">size</span></span></tt>.
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/hashes.nim#L189" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/hashes.nim#L189" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="hashIdentity-procs-all">
|
|
<div id="hashIdentity,T">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#hashIdentity%2CT"><span class="Identifier">hashIdentity</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#Ordinal"><span class="Identifier">Ordinal</span></a> <span class="Operator">|</span> <span class="Keyword">enum</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <a href="hashes.html#Hash"><span class="Identifier">Hash</span></a> {.<span class="Identifier">inline</span>.}</pre></dt>
|
|
<dd>
|
|
|
|
The identity hash, i.e. <tt class="docutils literal"><span class="pre"><span class="Identifier">hashIdentity</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Punctuation">)</span> <span class="Operator">=</span> <span class="Identifier">x</span></span></tt>.
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/hashes.nim#L205" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/hashes.nim#L205" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="hashIgnoreCase-procs-all">
|
|
<div id="hashIgnoreCase,string,int,int">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#hashIgnoreCase%2Cstring%2Cint%2Cint"><span class="Identifier">hashIgnoreCase</span></a><span class="Other">(</span><span class="Identifier">sBuf</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">sPos</span><span class="Other">,</span> <span class="Identifier">ePos</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="hashes.html#Hash"><span class="Identifier">Hash</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
|
<span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
<p>Efficient hashing of a string buffer, from starting position <tt class="docutils literal"><span class="pre"><span class="Identifier">sPos</span></span></tt> to ending position <tt class="docutils literal"><span class="pre"><span class="Identifier">ePos</span></span></tt> (included); case is ignored.</p>
|
|
<p><strong>Note:</strong> This uses a different hashing algorithm than <tt class="docutils literal"><span class="pre"><span class="Identifier">hash</span><span class="Punctuation">(</span><span class="Identifier">string</span><span class="Punctuation">)</span></span></tt>.</p>
|
|
<p><tt class="docutils literal"><span class="pre"><span class="Identifier">hashIgnoreCase</span><span class="Punctuation">(</span><span class="Identifier">myBuf</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">,</span> <span class="Identifier">myBuf</span><span class="Operator">.</span><span class="Identifier">high</span><span class="Punctuation">)</span></span></tt> is equivalent to <tt class="docutils literal"><span class="pre"><span class="Identifier">hashIgnoreCase</span><span class="Punctuation">(</span><span class="Identifier">myBuf</span><span class="Punctuation">)</span></span></tt>.</p>
|
|
|
|
<p><strong class="examples_text">Example:</strong></p>
|
|
<pre class="listing"><span class="Keyword">var</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="StringLit">"ABracadabRA"</span>
|
|
<span class="Identifier">doAssert</span> <span class="Identifier">hashIgnoreCase</span><span class="Punctuation">(</span><span class="Identifier">a</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">hashIgnoreCase</span><span class="Punctuation">(</span><span class="Identifier">a</span><span class="Punctuation">,</span> <span class="DecNumber">7</span><span class="Punctuation">,</span> <span class="DecNumber">10</span><span class="Punctuation">)</span></pre>
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/hashes.nim#L646" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/hashes.nim#L646" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="hashIgnoreCase,string">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#hashIgnoreCase%2Cstring"><span class="Identifier">hashIgnoreCase</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="hashes.html#Hash"><span class="Identifier">Hash</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
<p>Efficient hashing of strings; case is ignored.</p>
|
|
<p><strong>Note:</strong> This uses a different hashing algorithm than <tt class="docutils literal"><span class="pre"><span class="Identifier">hash</span><span class="Punctuation">(</span><span class="Identifier">string</span><span class="Punctuation">)</span></span></tt>.</p>
|
|
<p><strong>See also:</strong></p>
|
|
<ul class="simple"><li><a class="reference external" href="#hashIgnoreStyle,string">hashIgnoreStyle</a></li>
|
|
</ul>
|
|
|
|
<p><strong class="examples_text">Example:</strong></p>
|
|
<pre class="listing"><span class="Identifier">doAssert</span> <span class="Identifier">hashIgnoreCase</span><span class="Punctuation">(</span><span class="StringLit">"ABRAcaDABRA"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">hashIgnoreCase</span><span class="Punctuation">(</span><span class="StringLit">"abRACAdabra"</span><span class="Punctuation">)</span>
|
|
<span class="Identifier">doAssert</span> <span class="Identifier">hashIgnoreCase</span><span class="Punctuation">(</span><span class="StringLit">"abcdefghi"</span><span class="Punctuation">)</span> <span class="Operator">!=</span> <span class="Identifier">hash</span><span class="Punctuation">(</span><span class="StringLit">"abcdefghi"</span><span class="Punctuation">)</span></pre>
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/hashes.nim#L627" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/hashes.nim#L627" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="hashIgnoreStyle-procs-all">
|
|
<div id="hashIgnoreStyle,string,int,int">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#hashIgnoreStyle%2Cstring%2Cint%2Cint"><span class="Identifier">hashIgnoreStyle</span></a><span class="Other">(</span><span class="Identifier">sBuf</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">sPos</span><span class="Other">,</span> <span class="Identifier">ePos</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="hashes.html#Hash"><span class="Identifier">Hash</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
|
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
<p>Efficient hashing of a string buffer, from starting position <tt class="docutils literal"><span class="pre"><span class="Identifier">sPos</span></span></tt> to ending position <tt class="docutils literal"><span class="pre"><span class="Identifier">ePos</span></span></tt> (included); style is ignored.</p>
|
|
<p><strong>Note:</strong> This uses a different hashing algorithm than <tt class="docutils literal"><span class="pre"><span class="Identifier">hash</span><span class="Punctuation">(</span><span class="Identifier">string</span><span class="Punctuation">)</span></span></tt>.</p>
|
|
<p><tt class="docutils literal"><span class="pre"><span class="Identifier">hashIgnoreStyle</span><span class="Punctuation">(</span><span class="Identifier">myBuf</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">,</span> <span class="Identifier">myBuf</span><span class="Operator">.</span><span class="Identifier">high</span><span class="Punctuation">)</span></span></tt> is equivalent to <tt class="docutils literal"><span class="pre"><span class="Identifier">hashIgnoreStyle</span><span class="Punctuation">(</span><span class="Identifier">myBuf</span><span class="Punctuation">)</span></span></tt>.</p>
|
|
|
|
<p><strong class="examples_text">Example:</strong></p>
|
|
<pre class="listing"><span class="Keyword">var</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="StringLit">"ABracada_b_r_a"</span>
|
|
<span class="Identifier">doAssert</span> <span class="Identifier">hashIgnoreStyle</span><span class="Punctuation">(</span><span class="Identifier">a</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">hashIgnoreStyle</span><span class="Punctuation">(</span><span class="Identifier">a</span><span class="Punctuation">,</span> <span class="DecNumber">7</span><span class="Punctuation">,</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">high</span><span class="Punctuation">)</span></pre>
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/hashes.nim#L602" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/hashes.nim#L602" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="hashIgnoreStyle,string">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#hashIgnoreStyle%2Cstring"><span class="Identifier">hashIgnoreStyle</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="hashes.html#Hash"><span class="Identifier">Hash</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
<p>Efficient hashing of strings; style is ignored.</p>
|
|
<p><strong>Note:</strong> This uses a different hashing algorithm than <tt class="docutils literal"><span class="pre"><span class="Identifier">hash</span><span class="Punctuation">(</span><span class="Identifier">string</span><span class="Punctuation">)</span></span></tt>.</p>
|
|
<p><strong>See also:</strong></p>
|
|
<ul class="simple"><li><a class="reference external" href="#hashIgnoreCase,string">hashIgnoreCase</a></li>
|
|
</ul>
|
|
|
|
<p><strong class="examples_text">Example:</strong></p>
|
|
<pre class="listing"><span class="Identifier">doAssert</span> <span class="Identifier">hashIgnoreStyle</span><span class="Punctuation">(</span><span class="StringLit">"aBr_aCa_dAB_ra"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">hashIgnoreStyle</span><span class="Punctuation">(</span><span class="StringLit">"abracadabra"</span><span class="Punctuation">)</span>
|
|
<span class="Identifier">doAssert</span> <span class="Identifier">hashIgnoreStyle</span><span class="Punctuation">(</span><span class="StringLit">"abcdefghi"</span><span class="Punctuation">)</span> <span class="Operator">!=</span> <span class="Identifier">hash</span><span class="Punctuation">(</span><span class="StringLit">"abcdefghi"</span><span class="Punctuation">)</span></pre>
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/hashes.nim#L577" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/hashes.nim#L577" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="hashWangYi1-procs-all">
|
|
<div id="hashWangYi1">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#hashWangYi1"><span class="Identifier">hashWangYi1</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a> <span class="Operator">|</span> <a href="system.html#uint64"><span class="Identifier">uint64</span></a> <span class="Operator">|</span> <a href="hashes.html#Hash"><span class="Identifier">Hash</span></a><span class="Other">)</span><span class="Other">:</span> <a href="hashes.html#Hash"><span class="Identifier">Hash</span></a> {.<span class="Identifier">inline</span>.}</pre></dt>
|
|
<dd>
|
|
|
|
<p>Wang Yi's hash_v1 for 64-bit ints (see <a class="reference external" href="https://github.com/rurban/smhasher">https://github.com/rurban/smhasher</a> for more details). This passed all scrambling tests in Spring 2019 and is simple.</p>
|
|
<p><strong>Note:</strong> It's ok to define <tt class="docutils literal"><span class="pre"><span class="Keyword">proc</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Punctuation">:</span> <span class="Identifier">int16</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Identifier">Hash</span> <span class="Operator">=</span> <span class="Identifier">hashWangYi1</span><span class="Punctuation">(</span><span class="Identifier">Hash</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Punctuation">)</span><span class="Punctuation">)</span></span></tt>.</p>
|
|
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/hashes.nim#L166" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/hashes.nim#L166" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</dl>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="twelve-columns footer">
|
|
<span class="nim-sprite"></span>
|
|
<br>
|
|
<small style="color: var(--hint);">Made with Nim. Generated: 2025-12-28 23:29:48 UTC</small>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<script defer data-domain="nim-lang.org" src="https://plausible.io/js/plausible.js"></script>
|
|
|
|
</body>
|
|
</html>
|