Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve algorithmic codegen, return multiline string #167

Merged
merged 6 commits into from
Dec 13, 2022
Merged

Improve algorithmic codegen, return multiline string #167

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a15e7f4
better string output
Dec 12, 2022
72457f7
spacing
Dec 12, 2022
c870af9
rm comment
Dec 12, 2022
a5a8ed7
prefix
Dec 13, 2022
405831f
context mgr
Dec 13, 2022
646af5b
Update src/latexify/codegen/algorithmic_codegen.py
ZibingZhang Dec 13, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 33 additions & 26 deletions src/integration_tests/algorithmic_style_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

from __future__ import annotations

import textwrap
from typing import Any, Callable

from latexify import frontend
Expand Down Expand Up @@ -34,17 +35,20 @@ def fact(n):
else:
return n * fact(n - 1)

latex = (
r"\begin{algorithmic}"
r" \Function{fact}{$n$}"
r" \If{$n = 0$}"
r" \State \Return $1$"
r" \Else"
r" \State \Return $n \mathrm{fact} \mathopen{}\left( n - 1 \mathclose{}\right)$"
r" \EndIf"
r" \EndFunction"
r" \end{algorithmic}"
)
latex = textwrap.dedent(
r"""
\begin{algorithmic}
\Function{fact}{$n$}
\If{$n = 0$}
\State \Return $1$
\Else
\State \Return $n \mathrm{fact} \mathopen{}\left( n - 1 \mathclose{}\right)$
\EndIf
\EndFunction
\end{algorithmic}
""" # noqa: E501
).strip()

check_algorithm(fact, latex)


Expand All @@ -59,19 +63,22 @@ def collatz(n):
iterations = iterations + 1
return iterations

latex = (
r"\begin{algorithmic}"
r" \Function{collatz}{$n$}"
r" \State $\mathrm{iterations} \gets 0$"
r" \While{$n > 1$}"
r" \If{$n \mathbin{\%} 2 = 0$}"
r" \State $n \gets \left\lfloor\frac{n}{2}\right\rfloor$"
r" \Else \State $n \gets 3 n + 1$"
r" \EndIf"
r" \State $\mathrm{iterations} \gets \mathrm{iterations} + 1$"
r" \EndWhile"
r" \State \Return $\mathrm{iterations}$"
r" \EndFunction"
r" \end{algorithmic}"
)
latex = textwrap.dedent(
r"""
\begin{algorithmic}
\Function{collatz}{$n$}
\State $\mathrm{iterations} \gets 0$
\While{$n > 1$}
\If{$n \mathbin{\%} 2 = 0$}
\State $n \gets \left\lfloor\frac{n}{2}\right\rfloor$
\Else
\State $n \gets 3 n + 1$
\EndIf
\State $\mathrm{iterations} \gets \mathrm{iterations} + 1$
\EndWhile
\State \Return $\mathrm{iterations}$
\EndFunction
\end{algorithmic}
"""
).strip()
check_algorithm(collatz, latex)
63 changes: 45 additions & 18 deletions src/latexify/codegen/algorithmic_codegen.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,10 @@ class AlgorithmicCodegen(ast.NodeVisitor):
LaTeX expression of the given algorithm.
"""

_SPACES_PER_INDENT = 4

_identifier_converter: identifier_converter.IdentifierConverter
_indent: int

def __init__(
self, *, use_math_symbols: bool = False, use_set_symbols: bool = False
Expand All @@ -33,6 +36,7 @@ def __init__(
self._identifier_converter = identifier_converter.IdentifierConverter(
use_math_symbols=use_math_symbols
)
self._indent = 0

def generic_visit(self, node: ast.AST) -> str:
raise exceptions.LatexifyNotSupportedError(
Expand All @@ -46,41 +50,52 @@ def visit_Assign(self, node: ast.Assign) -> str:
]
operands.append(self._expression_codegen.visit(node.value))
operands_latex = r" \gets ".join(operands)
return rf"\State ${operands_latex}$"
return rf"{self._prefix()}\State ${operands_latex}$"
ZibingZhang marked this conversation as resolved.
Show resolved Hide resolved

def visit_Expr(self, node: ast.Expr) -> str:
"""Visit an Expr node."""
return rf"\State ${self._expression_codegen.visit(node.value)}$"
return rf"{self._prefix()}\State ${self._expression_codegen.visit(node.value)}$"

def visit_FunctionDef(self, node: ast.FunctionDef) -> str:
"""Visit a FunctionDef node."""
# Arguments
arg_strs = [
self._identifier_converter.convert(arg.arg)[0] for arg in node.args.args
]

latex = f"{self._prefix()}\\begin{{algorithmic}}\n"
self._indent += 1
ZibingZhang marked this conversation as resolved.
Show resolved Hide resolved
latex += (
f"{self._prefix()}\\Function{{{node.name}}}{{${', '.join(arg_strs)}$}}\n"
)

# Body
self._indent += 1
body_strs: list[str] = [self.visit(stmt) for stmt in node.body]
return (
rf"\begin{{algorithmic}}"
rf" \Function{{{node.name}}}{{${', '.join(arg_strs)}$}}"
f" {' '.join(body_strs)}"
r" \EndFunction"
rf" \end{{algorithmic}}"
)
self._indent -= 1
body_latex = "\n".join(body_strs)

latex += f"{body_latex}\n{self._prefix()}\\EndFunction\n"
self._indent -= 1
return latex + rf"{self._prefix()}\end{{algorithmic}}"

# TODO(ZibingZhang): support \ELSIF
def visit_If(self, node: ast.If) -> str:
"""Visit an If node."""
cond_latex = self._expression_codegen.visit(node.test)
body_latex = " ".join(self.visit(stmt) for stmt in node.body)
self._indent += 1
body_latex = "\n".join(self.visit(stmt) for stmt in node.body)
self._indent -= 1

latex = rf"\If{{${cond_latex}$}} {body_latex}"
latex = f"{self._prefix()}\\If{{${cond_latex}$}}\n{body_latex}"

if node.orelse:
latex += r" \Else "
latex += " ".join(self.visit(stmt) for stmt in node.orelse)
latex += f"\n{self._prefix()}\\Else\n"
self._indent += 1
latex += "\n".join(self.visit(stmt) for stmt in node.orelse)
self._indent -= 1

return latex + r" \EndIf"
return latex + f"\n{self._prefix()}\\EndIf"

def visit_Module(self, node: ast.Module) -> str:
"""Visit a Module node."""
Expand All @@ -89,9 +104,12 @@ def visit_Module(self, node: ast.Module) -> str:
def visit_Return(self, node: ast.Return) -> str:
"""Visit a Return node."""
return (
rf"\State \Return ${self._expression_codegen.visit(node.value)}$"
(
rf"{self._prefix()}\State \Return"
f" ${self._expression_codegen.visit(node.value)}$"
)
if node.value is not None
else r"\State \Return"
else rf"{self._prefix()}\State \Return"
)

def visit_While(self, node: ast.While) -> str:
Expand All @@ -102,5 +120,14 @@ def visit_While(self, node: ast.While) -> str:
)

cond_latex = self._expression_codegen.visit(node.test)
body_latex = " ".join(self.visit(stmt) for stmt in node.body)
return rf"\While{{${cond_latex}$}} {body_latex} \EndWhile"
self._indent += 1
body_latex = "\n".join(self.visit(stmt) for stmt in node.body)
self._indent -= 1
return (
f"{self._prefix()}\\While{{${cond_latex}$}}\n"
f"{body_latex}\n"
rf"{self._prefix()}\EndWhile"
)

def _prefix(self) -> str:
ZibingZhang marked this conversation as resolved.
Show resolved Hide resolved
return self._indent * self._SPACES_PER_INDENT * " "
82 changes: 57 additions & 25 deletions src/latexify/codegen/algorithmic_codegen_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,14 @@ class UnknownNode(ast.AST):
@pytest.mark.parametrize(
"code,latex",
[
("x = 3", r"\State $x \gets 3$"),
("a = b = 0", r"\State $a \gets b \gets 0$"),
(
"x = 3",
r"\State $x \gets 3$",
),
(
"a = b = 0",
r"\State $a \gets b \gets 0$",
),
],
)
def test_visit_assign(code: str, latex: str) -> None:
Expand All @@ -40,46 +46,65 @@ def test_visit_assign(code: str, latex: str) -> None:
[
(
"def f(x): return x",
(
r"\begin{algorithmic}"
r" \Function{f}{$x$}"
r" \State \Return $x$"
r" \EndFunction"
r" \end{algorithmic}"
),
r"""
\begin{algorithmic}
\Function{f}{$x$}
\State \Return $x$
\EndFunction
\end{algorithmic}
""",
),
(
"def xyz(a, b, c): return 3",
(
r"\begin{algorithmic}"
r" \Function{xyz}{$a, b, c$}"
r" \State \Return $3$"
r" \EndFunction"
r" \end{algorithmic}"
),
r"""
\begin{algorithmic}
\Function{xyz}{$a, b, c$}
\State \Return $3$
\EndFunction
\end{algorithmic}
""",
),
],
)
def test_visit_functiondef(code: str, latex: str) -> None:
node = ast.parse(textwrap.dedent(code)).body[0]
assert isinstance(node, ast.FunctionDef)
assert algorithmic_codegen.AlgorithmicCodegen().visit(node) == latex
assert (
algorithmic_codegen.AlgorithmicCodegen().visit(node)
== textwrap.dedent(latex).strip()
)


@pytest.mark.parametrize(
"code,latex",
[
("if x < y: return x", r"\If{$x < y$} \State \Return $x$ \EndIf"),
(
"if x < y: return x",
r"""
\If{$x < y$}
\State \Return $x$
\EndIf
""",
),
(
"if True: x\nelse: y",
r"\If{$\mathrm{True}$} \State $x$ \Else \State $y$ \EndIf",
r"""
\If{$\mathrm{True}$}
\State $x$
\Else
\State $y$
\EndIf
""",
),
],
)
def test_visit_if(code: str, latex: str) -> None:
node = ast.parse(textwrap.dedent(code)).body[0]
node = ast.parse(code).body[0]
assert isinstance(node, ast.If)
assert algorithmic_codegen.AlgorithmicCodegen().visit(node) == latex
assert (
algorithmic_codegen.AlgorithmicCodegen().visit(node)
== textwrap.dedent(latex).strip()
)


@pytest.mark.parametrize(
Expand All @@ -96,7 +121,7 @@ def test_visit_if(code: str, latex: str) -> None:
],
)
def test_visit_return(code: str, latex: str) -> None:
node = ast.parse(textwrap.dedent(code)).body[0]
node = ast.parse(code).body[0]
assert isinstance(node, ast.Return)
assert algorithmic_codegen.AlgorithmicCodegen().visit(node) == latex

Expand All @@ -106,14 +131,21 @@ def test_visit_return(code: str, latex: str) -> None:
[
(
"while x < y: x = x + 1",
r"\While{$x < y$} \State $x \gets x + 1$ \EndWhile",
r"""
\While{$x < y$}
\State $x \gets x + 1$
\EndWhile
""",
)
],
)
def test_visit_while(code: str, latex: str) -> None:
node = ast.parse(textwrap.dedent(code)).body[0]
node = ast.parse(code).body[0]
assert isinstance(node, ast.While)
assert algorithmic_codegen.AlgorithmicCodegen().visit(node) == latex
assert (
algorithmic_codegen.AlgorithmicCodegen().visit(node)
== textwrap.dedent(latex).strip()
)


def test_visit_while_with_else() -> None:
Expand Down