Pseudocode Plugin - Pseudocode plugin

Allows rendering pseudocode using pseudocode.js. For Tex-based exports, simply the raw contents are exported, surrounded by the \algorithm and \algorithmic environments, and with an attempt to add the dependencies with a \usepackage. This will probably throw a Latex error, since packages may only be imported in the preamble. I fixed handling of this in my fork of the myst-to-tex renderer, but this is not yet implemented upstream. If using an incompatible mystmd version, the correct packages imports should be manually added to the tex preamble by adding \usepackage{algorithmic} and \usepackage{algorithm}.

Examples¶

Render

Source

Algorithm 1 Quicksort

procedure Quicksort( $A, p, r$ )

if $p < r$ then

$q =$ Partition( $A, p, r$ )

Quicksort( $A, p, q - 1$ )

Quicksort( $A, q + 1, r$ )

end if

end procedure

procedure Partition( $A, p, r$ )

$x = A[r]$

$i = p - 1$

for $j = p \dots r - 1$ do

if $A[j] < x$ then

$i = i + 1$

exchange $A[i]$ with $A[j]$

end if

exchange $A[i]$ with $A[r]$

end for

end procedure

:::{pseudocode} Quicksort
    \Procedure{Quicksort}{$A, p, r$}
        \If{$p < r$} 
            \State $q = $ \Call{Partition}{$A, p, r$}
            \State \Call{Quicksort}{$A, p, q - 1$}
            \State \Call{Quicksort}{$A, q + 1, r$}
        \EndIf
    \EndProcedure
    \Procedure{Partition}{$A, p, r$}
        \State $x = A[r]$
        \State $i = p - 1$
        \For{$j = p \dots r - 1$}
            \If{$A[j] < x$}
                \State $i = i + 1$
                \State exchange
                $A[i]$ with $A[j]$
            \EndIf
            \State exchange $A[i]$ with $A[r]$
        \EndFor
    \EndProcedure
:::

Refer to Algorithm 2.

Render

Source

Algorithm 2 test Text-style

Require: some preconditions

Ensure: some postconditions

Require: some inputs

Ensure: some outputs

procedure Test-Declarations()

font families: sffamily, ttfamily, normalfont, rmfamily.

font weights: normal weight, bold, medium, lighter.

font shapes: itshape Small-Caps slshape upshape.

font sizes: tiny scriptsize footnotesize small normal large Large Large huge Huge

end procedure

procedure Test-Commands()

textnormal, textrm, textsf, texttt.

textbf, textmd, textlf.

textup, textit, textsc, textsl.

uppercase, LOWERCASE.

end procedure

procedure Test-Colors()

colors: $\color{red}{red}$ , $\color{green}{green}$ , $\color{blue}{blue}$

colors: $\color{yellow}{yellow}$ , $\color{cyan}{cyan}$ , $\color{magenta}{magenta}$

end procedure

:::{pseudocode} test Text-style
:label: alg:2
\Require some preconditions
\Ensure some postconditions
\Require some inputs
\Ensure some outputs
\Procedure{Test-Declarations}{}
    \State font families: {\sffamily sffamily, \ttfamily ttfamily, \normalfont normalfont, \rmfamily rmfamily.}
    \State font weights: {normal weight, \bfseries bold, \mdseries
    medium, \lfseries lighter. }
    \State font shapes: {\itshape itshape \scshape Small-Caps \slshape slshape \upshape upshape.}
    \State font sizes: \tiny tiny \scriptsize scriptsize \footnotesize
    footnotesize \small small \normalsize normal \large large \Large Large
    \Large Large \huge huge \Huge Huge \normalsize
\EndProcedure
\Procedure{Test-Commands}{}
    \State \textnormal{textnormal,} \textrm{textrm,} \textsf{textsf,} \texttt{texttt.}
    \State \textbf{textbf,} \textmd{textmd,} \textlf{textlf.}
    \State \textup{textup,} \textit{textit,} \textsc{textsc,} \textsl{textsl.}
    \State \uppercase{uppercase,} \lowercase{LOWERCASE.}
\EndProcedure
\Procedure{Test-Colors}{}
    \State colors: $\color{red}{red}$, $\color{green}{green}$, $\color{blue}{blue}$
    \State colors: $\color{yellow}{yellow}$, $\color{cyan}{cyan}$, $\color{magenta}{magenta}$
\EndProcedure
:::

Render

Source

Algorithm 3 Test specials

procedure Test-Specials()

Specials: { } $ & # % _

Bools: and or not true false

Carriage return: first line
second line

Text-symbols: \

Quote-symbols: ‘single quotes', ‘‘double quotes''

Math: $(\mathcal{C}_m)$ , $i \gets i + 1$ , $E=mc^2$ , $x^n + y^n = z^n$ , $\$$ , $\$$

end procedure

:::{pseudocode} Test specials
:label: alg:3
\Procedure{Test-Specials}{}
    \State \textbf{Specials:} \{ \} \$ \& \# \% \_
    \State \textbf{Bools:} \And \Or \Not \True \False
    \State \textbf{Carriage return:} first line \\ second line
    \State \textbf{Text-symbols:} \textbackslash
    \State \textbf{Quote-symbols:} `single quotes', ``double quotes''
    \State \textbf{Math:} $(\mathcal{C}_m)$, $i \gets i + 1$, $E=mc^2$, \( x^n + y^n = z^n \), $\$$, \(\$\)
\EndProcedure
:::

Render

Source

Algorithm 4 Test control blocks

procedure Test-If()

if <cond> then

<block>;

else if <cond>; then

<block>;

else

<block>;

end if

end procedure

procedure Test-For( $n$ )

$i \gets 0$

for $i < n$ do

print $i$

$i \gets i + 1$

end for

end procedure

procedure Test-For-To( $n$ )

$i \gets 0$

for $i \dots n$ do

print $i$

end for

end procedure

procedure Test-For-All( $n$ )

for all $i \in \{0, 1, \cdots, n\}$ do

print $i$

end for

end procedure

procedure Test-While( $n$ )

$i \gets 0$

while $i < n$ do

print $i$

$i \gets i + 1$

end while

end procedure

procedure Test-Repeat( $n$ )

$i \gets 0$

repeat

print $i$

$i \gets i + 1$

until $i>n$

end procedure

procedure Test-Break-Continue( $n$ )

for $i = 0 \dots 2n$ do

if $i < n/2$ then

continue

else if $i > n$ then

break

end if

print $i$

end for

end procedure

:::{algorithm} Test control blocks
\Procedure{Test-If}{}
    \If{<cond>}
        \State <block>;
    \ElsIf{<cond>;}
        \State <block>;
    \Else
        \State <block>;
    \EndIf
\EndProcedure
\Procedure{Test-For}{$n$}
    \State $i \gets 0$
    \For{$i < n$}
        \Print $i$
        \State $i \gets i + 1$
    \EndFor
\EndProcedure
\Procedure{Test-For-To}{$n$}
    \State $i \gets 0$
    \For{$i \dots n$}
        \Print $i$
    \EndFor
\EndProcedure
\Procedure{Test-For-All}{$n$}
    \ForAll{$i \in \{0, 1, \cdots, n\}$}
        \Print $i$
    \EndFor
\EndProcedure
\Procedure{Test-While}{$n$}
    \State $i \gets 0$
    \While{$i < n$}
        \Print $i$
        \State $i \gets i + 1$
    \EndWhile
\EndProcedure
\Procedure{Test-Repeat}{$n$}
    \State $i \gets 0$
    \Repeat
        \Print $i$
        \State $i \gets i + 1$
    \Until{$i>n$}
\EndProcedure
\Procedure{Test-Break-Continue}{$n$}
    \For{$i = 0 \dots 2n$}
        \If{$i < n/2$}
            \Continue
        \ElsIf{$i > n$}
            \Break
        \EndIf
        \Print $i$
    \EndFor
\EndProcedure
:::

Render

Source

Algorithm 5 Test comments

procedure Test-Comments() // comment for procedure

a statement // inline comment

// line comment

if some condition then // comment for if

return true // another inline comment

else // comment for else

return false // yet another inline comment

end if

end procedure

:::{algorithm} Test comments
\Procedure{Test-Comments}{} \Comment{comment for procedure}
    \State a statement \Comment{inline comment}
    \State \Comment{line comment}
    \If{some condition} \Comment{ comment for if}

        \Return \True \Comment{another inline comment}
    \Else \Comment{comment for else}

        \Return \False \Comment{yet another inline comment}
    \EndIf
\EndProcedure
:::

Note: the scope-lines and no-end options only work in HTML-based rendering.

Render

Source

Algorithm 6 Classical Euclidean Algorithm

procedure Euclid( $a,b$ )

while $a \neq b$ do

if $a > b$ then

$a \gets a - b$

else

$b \gets b - a$

end if

end while

return $a$

end procedure

:::{algorithm} Classical Euclidean Algorithm
:scope-lines: true
\Procedure{Euclid}{$a,b$}
    \While{$a \neq b$}
        \If{$a > b$}
            \State $a \gets a - b$
        \Else
            \State $b \gets b - a$
        \EndIf
    \EndWhile
\Return $a$
\EndProcedure
:::

Render

Source

Algorithm 7 DBSCAN

Require: A dataset $D$ , the $\varepsilon$ distance threshold, and the minimum number of points $minPts$

Ensure: A set of clusters $K$

procedure DBSCAN( $D, \varepsilon, minPts$ )

$K \gets \emptyset$

for all $p \in D$ do

if $p$ has not been visited then

mark $p$ as visited

$N_{\varepsilon}(p) \gets$ RangeQuery $(p, \varepsilon, D)$

if $N_{\varepsilon}(p) < minPts$ then

mark $p$ as noise

else // p is a core object

$C \gets$ ExpandCluster $(p, N_{\varepsilon}(p))$

$K \gets K \cup \{C\}$

return $K$

:::{algorithm} DBSCAN
:scope-lines: true
:no-end: true

\Require A dataset $D$, the $\varepsilon$ distance threshold, and the minimum number of points $minPts$
\Ensure A set of clusters $K$
\Procedure{DBSCAN}{$D, \varepsilon, minPts$}
    \State $K \gets \emptyset$
    \ForAll{$p \in D$}
        \If{$p$ has not been visited}
            \State mark $p$ as visited
            \State $N_{\varepsilon}(p) \gets $ \textsc{RangeQuery}$(p, \varepsilon, D)$
            \If{$N_{\varepsilon}(p) < minPts$}
                \State mark $p$ as noise
            \Else
                \Comment{p is a core object}
                \State $C \gets $ \textsc{ExpandCluster}$(p, N_{\varepsilon}(p))$
                \State $K \gets K \cup \{C\}$
            \EndIf
        \EndIf
    \EndFor
    \Return $K$
\EndProcedure
:::