参考:在 Markdown 中书写伪代码

2023/10/18 更新:尝试了下本文的方法不再奏效,可能的原因是 .js 中配置的网址链接丢失。

配置 VSCode

组合: VSCode + Markdown Preview Enhanced + pseudocode.js

  1. 安装好 VSCodeMarkdown Preview Enhanced 插件

  2. 按下快捷键 Ctrl + Shift + P,打开 VSCode 命令窗口,输入 Markdown Preview Enhanced: Extend Parser 命令并回车运行

  3. 下面的配置,覆盖原始 .js 文件:

    // 原始配置
    /*
    module.exports = {
      onWillParseMarkdown: function(markdown) {
        return new Promise((resolve, reject)=> {
          return resolve(markdown)
        })
      },
      onDidParseMarkdown: function(html, {cheerio}) {
        return new Promise((resolve, reject)=> {
          return resolve(html)
        })
      },
      onWillTransformMarkdown: function (markdown) {
            return new Promise((resolve, reject) => {
                return resolve(markdown);
            });
        },
      onDidTransformMarkdown: function (markdown) {
          return new Promise((resolve, reject) => {
              return resolve(markdown);
          });
      }
    }
    */
    
    // Latex 魔改
    module.exports = {
      onWillParseMarkdown: function(markdown) {
        return new Promise((resolve, reject)=> {
          return resolve(markdown)
        })
      },
      onDidParseMarkdown: function(html, {cheerio}) {
        return new Promise((resolve, reject)=> {
          return resolve(`
    <script src="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.11.1/katex.min.js"
        integrity="sha256-F/Xda58SPdcUCr+xhSGz9MA2zQBPb0ASEYKohl8UCHc=" crossorigin="anonymous">
    </script> 
    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/pseudocode@latest/build/pseudocode.min.css">
    <script src="https://cdn.jsdelivr.net/npm/pseudocode@latest/build/pseudocode.min.js">
    </script>
    ` + html + `
    <script>
    elements = document.getElementsByClassName("pseudocode");
    for (var i = 1; i <= elements.length; i++) {
        setTimeout(function() {
            var element = document.getElementsByClassName("pseudocode")[0];
            pseudocode.renderElement(element, { lineNumber: element.getAttribute("lineNumber") == "true" });
        }, i * 100);
    }
    </script>`)
        })
      },
      onWillTransformMarkdown: function (markdown) {
            return new Promise((resolve, reject) => {
                return resolve(markdown);
            });
        },
      onDidTransformMarkdown: function (markdown) {
          return new Promise((resolve, reject) => {
              return resolve(markdown);
          });
      }
    }
    

编写 Latex 源码

下面给出一个 markdown 模板:

<H1 align="center">标题居中</H1>

<H1>目录</H1>
@[toc]
此位置之后 pdf 换页
<div STYLE=" page-break-after: always;"> 
	<!-- 换页符 --> 
</div>



# KD-Tree

## 构建

KD-Tree 的构建算法如下:
1. 首先,计算数据集 $Data$ 各个维度的方差,选择方差最大的坐标轴作为枢轴 $pivot$
2. 然后,计算数据集在枢轴上的中位数 $med$,作为数据集的划分标准
3. 所有枢轴坐标不大于 $med$ 的样本收集到子集合 $L$ 里,所有枢轴坐标大于 $med$ 的样本收集到子集合 $R$ 里
4. 递归构建左右子树,直到子集合大小不超过某个阈值 $T$

<pre class="pseudocode" lineNumber="true">
\begin{algorithm}
\caption{构建 KD-Tree}
\begin{algorithmic}
\STATE \textbf{输入}:集合 $Data = \{x_1,x_2,\cdots,x_n\}$,叶子阈值 $T$
\STATE \textbf{输出}:树根 $root$
\PROCEDURE{KDTree}{$Data,T$}
	\IF{$n \le T$}
		\STATE $root.data := Data$
		\STATE $root.isleaf := 1$
		\RETURN $root$
	\ENDIF
	\STATE // 选择方差最大的坐标轴作为枢轴,划分数据集
	\STATE $root.pivot := \argmax_{1 \le j \le D} variance(Data,j)$
	\STATE $root.med := medain(Data,r)$
	\STATE $L,R := \empty$
	\FOR{$i:=1$ \TO $n$}
		\IF{$x_i[root.pivot] \le root.med$}
			\STATE $L := L \cup \{x_i\}$
		\ELSE
			\STATE $R := R \cup \{x_i\}$
		\ENDIF
	\ENDFOR
	\STATE // 递归构建左右子树
	\STATE $root.left :=$ \CALL{KDTree}{$L,T$}
	\STATE $root.right :=$ \CALL{KDTree}{$R,T$}
	\STATE $root.isleaf := 0$
	\RETURN $root$
\ENDPROCEDURE
\end{algorithmic}
\end{algorithm}
</pre>



## 最近邻

在 KD-Tree 上查找给定数据的最近邻,算法如下:
1. 从根节点开始,数据与枢轴上的中值比较,进入 $L, R$ 子集合。递归,直到进入某个叶子节点
2. 计算数据与节点上数据的最小距离点,计算距离 $d_1$
3. 然后回溯到父节点,计算与枢轴中值的距离 $d_2$
4. 如果 $d_1<d_2$,那么已经找到了最近邻;否则还要继续进入兄弟节点,以查找可能存在的更近点,然后继续回溯,直到满足 $d_1<d_2$


<pre class="pseudocode" lineNumber="true">
\begin{algorithm}
\caption{在 KD-Tree 上查找最近邻}
\begin{algorithmic}
\STATE \textbf{输入}:数据 $x$,树根 $root$
\STATE \textbf{输出}:最近邻 $y$
\PROCEDURE{FindNearest}{$x,root$}
	\IF{$root.isleaf = 1$}
		\RETURN $y := \argmin_{i \in root.data} dist(x,i)$
	\ENDIF
	\STATE // 递归查找最近邻,找到可能值之后回溯
	\IF{$x[root.pivot] \le root.med$}
		\STATE $tag := 0$
		\STATE $y :=$ \CALL{FindNearest}{$x,root.left$}
	\ELSE
		\STATE $tag := 1$
		\STATE $y :=$ \CALL{FindNearest}{$x,root.right$}
	\ENDIF
	\STATE $d_1 := dist(x,y)$
	\STATE $d_2 := |x[root.pivot]-root.med|$
	\STATE // 判断是否已经获得最近邻
	\IF{$d_1 > d_2$}
		\IF{$tag = 0$}
			\STATE $z :=$  \CALL{FindNearest}{$x,root.right$}
		\ELSE
			\STATE $z :=$  \CALL{FindNearest}{$x,root.left$}
		\ENDIF 
		\STATE $y := \argmin_{i=y,z} dist(x,i)$
	\ENDIF
	\RETURN $y$
\ENDPROCEDURE
\end{algorithmic}
\end{algorithm}
</pre>



## 添加数据

在已有的数据集上构建好 KD-Tree 之后,我们可能还有加入新样本的需求。新样本的加入规则很简单,只需找出这个样本所属于的区域(某个叶子节点),然后把新样本添加到这个区域内即可。

KD-Tree 的数据添加算法如下:
1. 从根节点开始,数据与枢轴上的中值比较,进入 $L, R$ 子集合。递归,直到进入某个叶子节点
2. 如果添加新数据后,叶子节点中包含的集合大小超过阈值 $T$,那么就把叶子集合按照 KD-Tree 构建算法,分割为多个节点


<pre class="pseudocode" lineNumber="true">
\begin{algorithm}
\caption{在 KD-Tree 上添加新数据}
\begin{algorithmic}
\STATE \textbf{输入}:新数据 $x$,树根 $root$,叶子阈值 $T$
\STATE \textbf{输出}:树根 $root$
\PROCEDURE{AddData}{$x,root,T$}
	\IF{$root.isleaf = 1$}
		\STATE // 判断是否需要分裂
		\IF{$|root.data| \ge T$}
			\STATE $root :=$ \CALL{KDTree}{$root.data \cup \{x\}$}
		\ELSE
			\STATE $root.data := root.data \cup \{x\}$
		\ENDIF
		\RETURN $root$
	\ENDIF
	\STATE // 递归进入左右子树
	\IF{$x[root.pivot] \le root.med$}
		\STATE \CALL{AddData}{$x,root.left,T$}
	\ELSE
		\STATE \CALL{AddData}{$x,root.right,T$}
	\ENDIF
	\RETURN $root$
\ENDPROCEDURE
\end{algorithmic}
\end{algorithm}
</pre>


生成 pseudocode

  1. 使用 VSCode 打开上面的 markdown 文件:

在这里插入图片描述

  1. 右击,出现快捷栏:

在这里插入图片描述

  1. 可以用 Chrome 直接打印 PDF(个人感觉,打印的比其他选项都漂亮)
  2. 也可以使用 Edge 浏览器打开,找到 网页捕获 工具

在这里插入图片描述

  1. 这个工具可以实现长截图(用于伪代码很长的情况,但清晰度不好)

在这里插入图片描述

  1. 如果想要清晰的截图,还是使用 Windows 系统自带的截图工具比较好
Logo

开放原子开发者工作坊旨在鼓励更多人参与开源活动,与志同道合的开发者们相互交流开发经验、分享开发心得、获取前沿技术趋势。工作坊有多种形式的开发者活动,如meetup、训练营等,主打技术交流,干货满满,真诚地邀请各位开发者共同参与!

更多推荐