Deploy to GitHub pages

algorithm.idx

@@ -0,0 +1,47 @@
+nimTitle	algorithm	algorithm.html	module std/algorithm		0
+nim	Descending	algorithm.html#Descending	SortOrder.Descending		52
+nim	Ascending	algorithm.html#Ascending	SortOrder.Ascending		52
+nim	SortOrder	algorithm.html#SortOrder	enum SortOrder		52
+nim	`*`	algorithm.html#*,int,SortOrder	proc `*`(x: int; order: SortOrder): int		55
+nim	fill	algorithm.html#fill,openArray[T],Natural,Natural,T	proc fill[T](a: var openArray[T]; first, last: Natural; value: T)		77
+nim	fill	algorithm.html#fill,openArray[T],T	proc fill[T](a: var openArray[T]; value: T)		90
+nim	reverse	algorithm.html#reverse,openArray[T],Natural,Natural	proc reverse[T](a: var openArray[T]; first, last: Natural)		101
+nim	reverse	algorithm.html#reverse,openArray[T]	proc reverse[T](a: var openArray[T])		123
+nim	reversed	algorithm.html#reversed,openArray[T]	proc reversed[T](a: openArray[T]): seq[T]		138
+nim	reversed	algorithm.html#reversed,openArray[T],Natural,int	proc reversed[T](a: openArray[T]; first: Natural; last: int): seq[T]		150
+nim	binarySearch	algorithm.html#binarySearch,openArray[T],K,proc(T,K)	proc binarySearch[T, K](a: openArray[T]; key: K;\n                   cmp: proc (x: T; y: K): int {.closure.}): int		159
+nim	binarySearch	algorithm.html#binarySearch,openArray[T],T	proc binarySearch[T](a: openArray[T]; key: T): int		210
+nim	lowerBound	algorithm.html#lowerBound,openArray[T],K,proc(T,K)	proc lowerBound[T, K](a: openArray[T]; key: K; cmp: proc (x: T; k: K): int {.closure.}): int		221
+nim	lowerBound	algorithm.html#lowerBound,openArray[T],T	proc lowerBound[T](a: openArray[T]; key: T): int		257
+nim	upperBound	algorithm.html#upperBound,openArray[T],K,proc(T,K)	proc upperBound[T, K](a: openArray[T]; key: K; cmp: proc (x: T; k: K): int {.closure.}): int		271
+nim	upperBound	algorithm.html#upperBound,openArray[T],T	proc upperBound[T](a: openArray[T]; key: T): int		307
+nim	sort	algorithm.html#sort,openArray[T],proc(T,T)	proc sort[T](a: var openArray[T]; cmp: proc (x, y: T): int {.closure.};\n        order = SortOrder.Ascending)		368
+nim	sort	algorithm.html#sort,openArray[T]	proc sort[T](a: var openArray[T]; order = SortOrder.Ascending)		421
+nim	sorted	algorithm.html#sorted,openArray[T],proc(T,T)	proc sorted[T](a: openArray[T]; cmp: proc (x, y: T): int {.closure.};\n          order = SortOrder.Ascending): seq[T]		431
+nim	sorted	algorithm.html#sorted,openArray[T]	proc sorted[T](a: openArray[T]; order = SortOrder.Ascending): seq[T]		453
+nim	sortedByIt	algorithm.html#sortedByIt.t,untyped,untyped	template sortedByIt(seq1, op: untyped): untyped		471
+nim	isSorted	algorithm.html#isSorted,openArray[T],proc(T,T)	proc isSorted[T](a: openArray[T]; cmp: proc (x, y: T): int {.closure.};\n            order = SortOrder.Ascending): bool		507
+nim	isSorted	algorithm.html#isSorted,openArray[T]	proc isSorted[T](a: openArray[T]; order = SortOrder.Ascending): bool		534
+nim	merge	algorithm.html#merge,seq[T],openArray[T],openArray[T],proc(T,T)	proc merge[T](result: var seq[T]; x, y: openArray[T];\n         cmp: proc (x, y: T): int {.closure.})		554
+nim	merge	algorithm.html#merge,seq[T],openArray[T],openArray[T]	proc merge[T](result: var seq[T]; x, y: openArray[T])		631
+nim	product	algorithm.html#product,openArray[seq[T]]	proc product[T](x: openArray[seq[T]]): seq[seq[T]]		646
+nim	nextPermutation	algorithm.html#nextPermutation,openArray[T]	proc nextPermutation[T](x: var openArray[T]): bool		683
+nim	prevPermutation	algorithm.html#prevPermutation,openArray[T]	proc prevPermutation[T](x: var openArray[T]): bool		723
+nim	rotateLeft	algorithm.html#rotateLeft,openArray[T],HSlice[int,int],int	proc rotateLeft[T](arg: var openArray[T]; slice: HSlice[int, int]; dist: int): int		812
+nim	rotateLeft	algorithm.html#rotateLeft,openArray[T],int	proc rotateLeft[T](arg: var openArray[T]; dist: int): int		850
+nim	rotatedLeft	algorithm.html#rotatedLeft,openArray[T],HSlice[int,int],int	proc rotatedLeft[T](arg: openArray[T]; slice: HSlice[int, int]; dist: int): seq[T]		870
+nim	rotatedLeft	algorithm.html#rotatedLeft,openArray[T],int	proc rotatedLeft[T](arg: openArray[T]; dist: int): seq[T]		900
+heading	Basic usage	algorithm.html#basic-usage	 Basic usage		0
+heading	See also	algorithm.html#see-also	 See also		0
+nimgrp	reversed	algorithm.html#reversed-procs-all	proc		138
+nimgrp	sorted	algorithm.html#sorted-procs-all	proc		431
+nimgrp	issorted	algorithm.html#isSorted-procs-all	proc		507
+nimgrp	fill	algorithm.html#fill-procs-all	proc		77
+nimgrp	upperbound	algorithm.html#upperBound-procs-all	proc		271
+nimgrp	rotateleft	algorithm.html#rotateLeft-procs-all	proc		812
+nimgrp	binarysearch	algorithm.html#binarySearch-procs-all	proc		159
+nimgrp	lowerbound	algorithm.html#lowerBound-procs-all	proc		221
+nimgrp	rotatedleft	algorithm.html#rotatedLeft-procs-all	proc		870
+nimgrp	merge	algorithm.html#merge-procs-all	proc		554
+nimgrp	sort	algorithm.html#sort-procs-all	proc		368
+nimgrp	reverse	algorithm.html#reverse-procs-all	proc		101

apis.html

@@ -0,0 +1,92 @@
+<?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>API naming design</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.1.1">
+
+<!-- JS -->
+<script type="text/javascript" src="dochack.js?v=2.1.1"></script>
+</head>
+<body>
+  <div class="document" id="documentId">
+    <div class="container">
+      <h1 class="title">API naming design</h1>
+      <p>The API is designed to be <strong>easy to use</strong> and consistent. Ease of use is measured by the number of calls to achieve a concrete high-level action.</p>
+
+<h1 id="naming-scheme">Naming scheme</h1><p>The library uses a simple naming scheme that makes use of common abbreviations to keep the names short but meaningful. Since version 0.8.2 many symbols have been renamed to fit this scheme. The ultimate goal is that the programmer can <em>guess</em> a name.</p>
+<table border="1" class="docutils"><tr><th>English word</th><th>To use</th><th>Notes</th></tr>
+<tr><td>initialize</td><td>initT </td><td><tt class="docutils literal"><span class="pre"><span class="Identifier">init</span></span></tt> is used to create a value type <tt class="docutils literal"><span class="pre"><span class="Identifier">T</span></span></tt></td></tr>
+<tr><td>new</td><td>newP </td><td><tt class="docutils literal"><span class="pre"><span class="Identifier">new</span></span></tt> is used to create a reference type <tt class="docutils literal"><span class="pre"><span class="Identifier">P</span></span></tt></td></tr>
+<tr><td>find</td><td>find</td><td>should return the position where something was found; for a bool result use <tt class="docutils literal"><span class="pre"><span class="Identifier">contains</span></span></tt></td></tr>
+<tr><td>contains</td><td>contains</td><td>often short for <tt class="docutils literal"><span class="pre"><span class="Identifier">find</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">&gt;=</span> <span class="DecNumber">0</span></span></tt></td></tr>
+<tr><td>append</td><td>add</td><td>use <tt class="docutils literal"><span class="pre"><span class="Identifier">add</span></span></tt> instead of <tt class="docutils literal"><span class="pre"><span class="Identifier">append</span></span></tt></td></tr>
+<tr><td>compare</td><td>cmp</td><td>should return an int with the <tt class="docutils literal"><span class="pre"><span class="Operator">&lt;</span> <span class="DecNumber">0</span></span></tt> <tt class="docutils literal"><span class="pre"><span class="Operator">==</span> <span class="DecNumber">0</span></span></tt> or <tt class="docutils literal"><span class="pre"><span class="Operator">&gt;</span> <span class="DecNumber">0</span></span></tt> semantics; for a bool result use <tt class="docutils literal"><span class="pre"><span class="Identifier">sameXYZ</span></span></tt></td></tr>
+<tr><td>put</td><td>put, <tt class="docutils literal"><span class="pre"><span class="Punctuation">[</span><span class="Punctuation">]</span><span class="Operator">=</span></span></tt></td><td>consider overloading <tt class="docutils literal"><span class="pre"><span class="Punctuation">[</span><span class="Punctuation">]</span><span class="Operator">=</span></span></tt> for put</td></tr>
+<tr><td>get</td><td>get, <tt class="docutils literal"><span class="pre"><span class="Punctuation">[</span><span class="Punctuation">]</span></span></tt></td><td>consider overloading <tt class="docutils literal"><span class="pre"><span class="Punctuation">[</span><span class="Punctuation">]</span></span></tt> for get; consider to not use <tt class="docutils literal"><span class="pre"><span class="Identifier">get</span></span></tt> as a prefix: <tt class="docutils literal"><span class="pre"><span class="Identifier">len</span></span></tt> instead of <tt class="docutils literal"><span class="pre"><span class="Identifier">getLen</span></span></tt></td></tr>
+<tr><td>length</td><td>len</td><td>also used for <em>number of elements</em></td></tr>
+<tr><td>size</td><td>size, len</td><td>size should refer to a byte size</td></tr>
+<tr><td>capacity</td><td>cap</td><td></td></tr>
+<tr><td>memory</td><td>mem</td><td>implies a low-level operation</td></tr>
+<tr><td>items</td><td>items</td><td>default iterator over a collection</td></tr>
+<tr><td>pairs</td><td>pairs</td><td>iterator over (key, value) pairs</td></tr>
+<tr><td>delete</td><td>delete, del</td><td>del is supposed to be faster than delete, because it does not keep the order; delete keeps the order</td></tr>
+<tr><td>remove</td><td>delete, del</td><td>inconsistent right now</td></tr>
+<tr><td>remove-and-return</td><td>pop</td><td><tt class="docutils literal"><span class="pre"><span class="Identifier">Table</span></span></tt>/<tt class="docutils literal"><span class="pre"><span class="Identifier">TableRef</span></span></tt> alias to <tt class="docutils literal"><span class="pre"><span class="Identifier">take</span></span></tt></td></tr>
+<tr><td>include</td><td>incl</td><td></td></tr>
+<tr><td>exclude</td><td>excl</td><td></td></tr>
+<tr><td>command</td><td>cmd</td><td></td></tr>
+<tr><td>execute</td><td>exec</td><td></td></tr>
+<tr><td>environment</td><td>env</td><td></td></tr>
+<tr><td>variable</td><td>var</td><td></td></tr>
+<tr><td>value</td><td>value, val </td><td>val is preferred, inconsistent right now</td></tr>
+<tr><td>executable</td><td>exe</td><td></td></tr>
+<tr><td>directory</td><td>dir</td><td></td></tr>
+<tr><td>path</td><td>path</td><td>path is the string &quot;/usr/bin&quot; (for example), dir is the content of &quot;/usr/bin&quot;; inconsistent right now</td></tr>
+<tr><td>extension</td><td>ext</td><td></td></tr>
+<tr><td>separator</td><td>sep</td><td></td></tr>
+<tr><td>column</td><td>col, column </td><td>col is preferred, inconsistent right now</td></tr>
+<tr><td>application</td><td>app</td><td></td></tr>
+<tr><td>configuration</td><td>cfg</td><td></td></tr>
+<tr><td>message</td><td>msg</td><td></td></tr>
+<tr><td>argument</td><td>arg</td><td></td></tr>
+<tr><td>object</td><td>obj</td><td></td></tr>
+<tr><td>parameter</td><td>param</td><td></td></tr>
+<tr><td>operator</td><td>opr</td><td></td></tr>
+<tr><td>procedure</td><td>proc</td><td></td></tr>
+<tr><td>function</td><td>func</td><td></td></tr>
+<tr><td>coordinate</td><td>coord</td><td></td></tr>
+<tr><td>rectangle</td><td>rect</td><td></td></tr>
+<tr><td>point</td><td>point</td><td></td></tr>
+<tr><td>symbol</td><td>sym</td><td></td></tr>
+<tr><td>literal</td><td>lit</td><td></td></tr>
+<tr><td>string</td><td>str</td><td></td></tr>
+<tr><td>identifier</td><td>ident</td><td></td></tr>
+<tr><td>indentation</td><td>indent</td><td></td></tr>
+</table>
+
+
+      <div class="twelve-columns footer">
+        <span class="nim-sprite"></span>
+        <br>
+        <small style="color: var(--hint);">Made with Nim. Generated: 2024-06-02 10:03:03 UTC</small>
+      </div>
+    </div>
+  </div>
+      <script defer data-domain="nim-lang.org" src="https://plausible.io/js/plausible.js"></script>
+
+</body>
+</html>

apis.idx

@@ -0,0 +1,2 @@
+markupTitle	API naming design	apis.html	API naming design		0
+heading	Naming scheme	apis.html#naming-scheme	 Naming scheme		0