From 7f89ffe4a4632f1c308036b4b55c67dfc4412883 Mon Sep 17 00:00:00 2001 From: Alan Xu Date: Tue, 7 Nov 2023 23:22:19 +0800 Subject: [PATCH] docs(10_insertionsort/readme.md): fix the markdown's warning fix the markdown's warning --- 10_InsertionSort/InsertionSort.sol | 1 - 10_InsertionSort/readme.md | 184 ++++++++++++++++------------- 2 files changed, 100 insertions(+), 85 deletions(-) diff --git a/10_InsertionSort/InsertionSort.sol b/10_InsertionSort/InsertionSort.sol index 6200e68f5..632f3f311 100644 --- a/10_InsertionSort/InsertionSort.sol +++ b/10_InsertionSort/InsertionSort.sol @@ -50,7 +50,6 @@ contract InsertionSort { // 插入排序 错误版 function insertionSortWrong(uint[] memory a) public pure returns(uint[] memory) { - // note that uint can not take negative value for (uint i = 1;i < a.length;i++){ uint temp = a[i]; uint j=i-1; diff --git a/10_InsertionSort/readme.md b/10_InsertionSort/readme.md index a15b9dad8..534edb0d2 100644 --- a/10_InsertionSort/readme.md +++ b/10_InsertionSort/readme.md @@ -9,7 +9,7 @@ tags: # WTF Solidity极简入门: 10. 控制流，用solidity实现插入排序 -我最近在重新学solidity，巩固一下细节，也写一个“WTF Solidity极简入门”，供小白们使用（编程大佬可以另找教程），每周更新1-3讲。 +我最近在重新学Solidity，巩固一下细节，也写一个“WTF Solidity极简入门”，供小白们使用（编程大佬可以另找教程），每周更新1-3讲。 推特：[@0xAA_Science](https://twitter.com/0xAA_Science) @@ -18,143 +18,159 @@ tags: 所有代码和教程开源在github: [github.com/AmazingAng/WTFSolidity](https://github.com/AmazingAng/WTFSolidity) ----- -这一讲，我们将介绍`solidity`中的控制流，然后讲如何用`solidity`实现插入排序（`InsertionSort`），一个看起来简单，但实际上很容易写出`bug`的程序。 +这一讲，我们将介绍`Solidity`中的控制流，然后讲如何用`Solidity`实现插入排序（`InsertionSort`），一个看起来简单，但实际上很容易写出`bug`的程序。 ## 控制流 + `Solidity`的控制流与其他语言类似，主要包含以下几种： 1. `if-else` -```solidity -function ifElseTest(uint256 _number) public pure returns(bool){ - if(_number == 0){ - return(true); - }else{ - return(false); + ```solidity + function ifElseTest(uint256 _number) public pure returns(bool){ + if(_number == 0){ + return(true); + }else{ + return(false); + } } -} -``` + ``` + 2. `for循环` -```solidity -function forLoopTest() public pure returns(uint256){ - uint sum = 0; - for(uint i = 0; i < 10; i++){ - sum += i; + ```solidity + function forLoopTest() public pure returns(uint256){ + uint sum = 0; + for(uint i = 0; i < 10; i++){ + sum += i; + } + return(sum); } - return(sum); -} -``` + ``` + 3. `while循环` -```solidity -function whileTest() public pure returns(uint256){ - uint sum = 0; - uint i = 0; - while(i < 10){ - sum += i; - i++; + ```solidity + function whileTest() public pure returns(uint256){ + uint sum = 0; + uint i = 0; + while(i < 10){ + sum += i; + i++; + } + return(sum); } - return(sum); -} -``` + ``` + 4. `do-while循环` -```solidity -function doWhileTest() public pure returns(uint256){ - uint sum = 0; - uint i = 0; - do{ - sum += i; - i++; - }while(i < 10); - return(sum); -} -``` + ```solidity + function doWhileTest() public pure returns(uint256){ + uint sum = 0; + uint i = 0; + do{ + sum += i; + i++; + }while(i < 10); + return(sum); + } + ``` 5. `三元运算符` -三元运算符是`solidity`中唯一一个接受三个操作数的运算符，规则`条件? 条件为真的表达式:条件为假的表达式`。 此运算符经常用作 if 语句的快捷方式。 -```solidity -// 三元运算符 ternary/conditional operator -function ternaryTest(uint256 x, uint256 y) public pure returns(uint256){ - // return the max of x and y - return x >= y ? x: y; -} -``` + 三元运算符是`Solidity`中唯一一个接受三个操作数的运算符，规则`条件? 条件为真的表达式:条件为假的表达式`。此运算符经常用作`if`语句的快捷方式。 + + ```solidity + // 三元运算符 ternary/conditional operator + function ternaryTest(uint256 x, uint256 y) public pure returns(uint256){ + // return the max of x and y + return x >= y ? x: y; + } + ``` 另外还有`continue`（立即进入下一个循环）和`break`（跳出当前循环）关键字可以使用。 -## 用`solidity`实现插入排序 -### 写在前面：90%以上的人用`solidity`写插入算法都会出错。 +## 用`Solidity`实现插入排序 + +**写在前面：90%以上的人用`Solidity`写插入算法都会出错。** ### 插入排序 + 排序算法解决的问题是将无序的一组数字，例如`[2, 5, 3, 1]`，从小到大依次排列好。插入排序（`InsertionSort`）是最简单的一种排序算法，也是很多人学习的第一个算法。它的思路很简单，从前往后，依次将每一个数和排在他前面的数字比大小，如果比前面的数字小，就互换位置。示意图： ![插入排序](https://i.pinimg.com/originals/92/b0/34/92b034385c440e08bc8551c97df0a2e3.gif) ### `python`代码 + 我们可以先看一下插入排序的python代码： + ```python # Python program for implementation of Insertion Sort def insertionSort(arr): - for i in range(1, len(arr)): - key = arr[i] - j = i-1 - while j >=0 and key < arr[j] : - arr[j+1] = arr[j] - j -= 1 - arr[j+1] = key + for i in range(1, len(arr)): + key = arr[i] + j = i-1 + while j >=0 and key < arr[j] : + arr[j+1] = arr[j] + j -= 1 + arr[j+1] = key return arr ``` -### 改写成`solidity`后有`BUG`！ -一共8行`python`代码就可以完成插入排序，非常简单。那么我们将它改写成`solidity`代码，将函数，变量，循环等等都做了相应的转换，只需要9行代码： + +### 改写成`Solidity`后有`BUG` + +一共8行`python`代码就可以完成插入排序，非常简单。那么我们将它改写成`Solidity`代码，将函数，变量，循环等等都做了相应的转换，只需要9行代码： + ``` solidity // 插入排序 错误版 - function insertionSortWrong(uint[] memory a) public pure returns(uint[] memory) { - - for (uint i = 1;i < a.length;i++){ - uint temp = a[i]; - uint j=i-1; - while( (j >= 0) && (temp < a[j])){ - a[j+1] = a[j]; - j--; - } - a[j+1] = temp; +function insertionSortWrong(uint[] memory a) public pure returns(uint[] memory) { + for (uint i = 1;i < a.length;i++){ + uint temp = a[i]; + uint j=i-1; + while( (j >= 0) && (temp < a[j])){ + a[j+1] = a[j]; + j--; } - return(a); + a[j+1] = temp; } + return(a); +} ``` + 那我们把改好的放到`remix`上去跑，输入`[2, 5, 3, 1]`。BOOM！有`bug`！改了半天，没找到`bug`在哪。我又去`google`搜”solidity insertion sort”，然后发现网上用`solidity`写的插入算法教程都是错的，比如：[Sorting in Solidity without Comparison](https://medium.com/coinmonks/sorting-in-solidity-without-comparison-4eb47e04ff0d) Remix decoded output 出现错误内容 + ![10-1](./img/10-1.jpg) -### 正确的solidity插入排序 -花了几个小时，在`Dapp-Learning`社群一个朋友的帮助下，终于找到了`bug`所在。`solidity`中最常用的变量类型是`uint`，也就是正整数，取到负值的话，会报`underflow`错误。而在插入算法中，变量`j`有可能会取到`-1`，引起报错。 +### 正确的Solidity插入排序 + +花了几个小时，在`Dapp-Learning`社群一个朋友的帮助下，终于找到了`bug`所在。`Solidity`中最常用的变量类型是`uint`，也就是正整数，取到负值的话，会报`underflow`错误。而在插入算法中，变量`j`有可能会取到`-1`，引起报错。 这里，我们需要把`j`加1，让它无法取到负值。正确代码： + ```solidity - // 插入排序 正确版 - function insertionSort(uint[] memory a) public pure returns(uint[] memory) { - // note that uint can not take negative value - for (uint i = 1;i < a.length;i++){ - uint temp = a[i]; - uint j=i; - while( (j >= 1) && (temp < a[j-1])){ - a[j] = a[j-1]; - j--; - } - a[j] = temp; +// 插入排序 正确版 +function insertionSort(uint[] memory a) public pure returns(uint[] memory) { + // note that uint can not take negative value + for (uint i = 1;i < a.length;i++){ + uint temp = a[i]; + uint j=i; + while( (j >= 1) && (temp < a[j-1])){ + a[j] = a[j-1]; + j--; } - return(a); + a[j] = temp; } + return(a); +} ``` + 运行后的结果： !["输入[2,5,3,1] 输出[1,2,3,5] "](https://images.mirror-media.xyz/publication-images/S-i6rwCMeXoi8eNJ0fRdB.png?height=300&width=554) ## 总结 -这一讲，我们介绍了`solidity`中控制流，并且用`solidity`写了插入排序。看起来很简单，但实际很难。这就是`solidity`，坑很多，每个月都有项目因为这些小`bug`损失几千万甚至上亿美元。掌握好基础，不断练习，才能写出更好的`solidity`代码。 +这一讲，我们介绍了`Solidity`中控制流，并且用`Solidity`写了插入排序。看起来很简单，但实际很难。这就是`Solidity`，坑很多，每个月都有项目因为这些小`bug`损失几千万甚至上亿美元。掌握好基础，不断练习，才能写出更好的`Solidity`代码。