Algorithm Extension

The algorithm extension provides a means to display pseudo-code similar to the latex algorithmicx package. Algorithms are similar to tables in that users can assign captions, ids, and provide shortcuts to the algorithm.

Configuration options for the algorithm extension.

Key	Default	Description
active	True	Toggle for disabling the extension. This only changes the initial active state, use setActive to control at runtime.
prefix	Algorithm	The caption prefix (e.g., Alg.).

The Algorithm Float

Example of assigning a caption and id

Markdown
HTML

!algorithm caption=Test id=algotest
[!function!begin name=testFunction]
[!function!end]

Look at [!ref](algotest)

Configuration options for the algorithm command.

Key	Default	Description
style	None	The style settings that are passed to rendered HTML tag.
class	None	The class settings to be passed to rendered HTML tag.
id	None	The class settings to be passed to the rendered tag.
caption	None	The caption text for the float object.
prefix	None	The numbered caption label to include prior to the caption text.

Line Commands

The algorithm command by itself is not very informative. Users should use the following line commands following the algorithm float definition. Below is an example using some of the commands described in the following sections. $\quad$

Markdown
HTML

!algorithm caption=The Bellman-Kalaba algorithm id=bk
[!function!begin name=BellmanKalab param=$G$, $u$, $l$, $p$]
[!for!begin condition=$v\in V(G)$]
[!state text=$l(v) \leftarrow \infty$]
[!for!end]
[!state text=$l(u) \leftarrow 0$]
[!while!begin condition=$changed$ comment=Initial is $changed \leftarrow \text{True}$]
[!for!begin condition=$i \leftarrow 1, n$]
[!state text=$min \leftarrow l(v_i)$]
[!for!begin condition=$j \leftarrow 1, n$]
[!ifthen!if condition=$min > e(v_i, v_j) + l(v_j)$]
[!state text=$min \leftarrow e(v_i, v_j) + l(v_j)$]
[!state text=$p(i) \leftarrow v_j$]
[!ifthen!end]
[!for!end]
[!state text=$l’(i) \leftarrow min$]
[!for!end]
[!state text=$changed \leftarrow l \not= l’$]
[!state text=$l \leftarrow l’$]
[!while!end]
[!function!end]

Algorithm 1: The Bellman-Kalaba algorithm

1: function BellmanKalab(

G

u

l

p

)

2: for

v\in V(G)

l(v) \leftarrow \infty

4: end for

l(u) \leftarrow 0

6: while

changed

do▹ Initial is

changed \leftarrow \text{True}

7: for

i \leftarrow 1, n

min \leftarrow l(v_i)

9: for

j \leftarrow 1, n

10: if

min > e(v_i, v_j) + l(v_j)

then

11:

min \leftarrow e(v_i, v_j) + l(v_j)

12:

p(i) \leftarrow v_j

13: end if

14: end for

15:

l’(i) \leftarrow min

16: end for

17:

changed \leftarrow l \not= l’

18:

l \leftarrow l’

19: end while

20: end function

Function Commands

Example of using function line commands

Markdown
HTML

!algorithm
[!function!begin name=<function name> param=parameters]
<content>
[!function!end]
[!procedure!begin name=<procedure name> param=parameters]
<content>
[!procedure!end]

Configuration options for the algorithm command.

Key	Default	Description
style	None	The style settings that are passed to rendered HTML tag.
class	None	The class settings to be passed to rendered HTML tag.
id	None	The class settings to be passed to the rendered tag.
comment	None	Comment placed to right of algorithm component.
name	None	Function name
param	None	Function parameters

Loop Commands

Example of using loop line commands

Markdown
HTML

!algorithm
[!while!begin condition=<condition>]
<content>
[!while!end]
[!for!begin condition=<condition>]
<content>
[!for!end]

Configuration options for the algorithm command.

Key	Default	Description
style	None	The style settings that are passed to rendered HTML tag.
class	None	The class settings to be passed to rendered HTML tag.
id	None	The class settings to be passed to the rendered tag.
comment	None	Comment placed to right of algorithm component.
condition		Loop condition

If-Then Commands

Example of using if-then line commands

Markdown
HTML

!algorithm
[!ifthen!if condition=<condition>]
<content>
[!ifthen!elif condition=<condition>]
<content>
[!ifthen!else]
<content>
[!ifthen!end]

Configuration options for the algorithm command.

Key	Default	Description
style	None	The style settings that are passed to rendered HTML tag.
class	None	The class settings to be passed to rendered HTML tag.
id	None	The class settings to be passed to the rendered tag.
comment	None	Comment placed to right of algorithm component.
condition		If and if else condition

Statement Command

Example of using statement line commands

Markdown
HTML

!algorithm
[!state text=<text>]

Configuration options for the algorithm command.

Key	Default	Description
style	None	The style settings that are passed to rendered HTML tag.
class	None	The class settings to be passed to rendered HTML tag.
id	None	The class settings to be passed to the rendered tag.
comment	None	Comment placed to right of algorithm component.
text		Statement text

The Algorithm Float
Line Commands