Use a different algorithm package

Oct 13, 2025 by thesweetdesigns.com 57 views

Introduction

The combination of the cleveref package for automatic reference generation and the algorithm package for typesetting algorithms, along with the algcompatible package for compatibility, has been a popular choice among LaTeX users for creating high-quality documents with algorithmic content. However, with the recent update from TeXLive 2024 to 2025, some users have reported an apparent regression in the behavior of cleveref when referencing lines of algorithms. In this article, we will delve into the issue, provide an example, and explore possible solutions.

Background

The algorithm package is a widely used tool for typesetting algorithms in LaTeX. It provides a flexible and customizable way to present algorithms, including the use of boxes, frames, and other visual elements. The algcompatible package is a companion package that provides compatibility with other algorithm packages, including algorithm2e and algpseudocode. The cleveref package, on the other hand, is a powerful tool for automatic reference generation, allowing users to easily create references to equations, figures, tables, and other elements in their document.

The Issue

The issue at hand is that, with the update from TeXLive 2024 to 2025, cleveref no longer correctly references lines of algorithms when used in conjunction with algorithm and algcompatible. This regression is not specific to any particular algorithm or document, but rather appears to be a general issue with the interaction between these packages.

Example

To illustrate the issue, let's consider the following example:

\documentclass{article}
\usepackage{algorithm}
\usepackage{algcompatible}
\usepackage{cleveref}
\begin{document}
\beginalgorithm}
\caption{Example Algorithm}
\label{algexample
\begin{algorithmic}[1]
\STATE  $x \leftarrow 0$ 
\STATE  $y \leftarrow 1$ 
\STATE  $x \leftarrow x + y$ 
\STATE  $y \leftarrow y + x$ 
\end{algorithmic}
\end{algorithm}
The algorithm \crefalgexample has the following lines:
\beginitemize}
\item Line 1 \cref{alg:example:1
\item Line 2: \crefalgexample:2
\item Line 3: \crefalgexample:3
\item Line 4: \crefalgexample:4
\end{itemize}
\end{document}

In this example, we define an algorithm with four lines, and then attempt to reference each line using cleveref. However, when compiling the document, we find that the references are not correctly generated.

Possible Solutions

There are several possible solutions to this issue, including:

Update to the latest version of cleveref: It is possible that the regression is due to a bug in the cleveref package that has been fixed in a later version. Users can try updating to the latest version of cleveref to see if the issue is resolved.
Use a different algorithm package: If the issue is specific to the algorithm package, users can try using a different algorithm package, such as algorithm2e or algpseudocode, to see if the issue is resolved.
Use a different reference generation package: If the issue is specific to the cleveref package, users can try using a different reference generation package, such as ref or hyperref, to see if the issue is resolved.
Submit a bug report: If none of the above solutions work, users can submit a bug report to the package maintainers, providing a minimal example that reproduces the issue.

Conclusion

In conclusion, the regression in cleveref when referencing lines of algorithms with the combination of algorithm and algcompatible is a significant issue that affects many users. While there are several possible solutions to this issue, including updating to the latest version of cleveref, using a different algorithm package, using a different reference generation package, and submitting a bug report, the root cause of the issue remains unclear. Further investigation and collaboration between package maintainers and users are necessary to resolve this issue and ensure that cleveref continues to work correctly with algorithm and algcompatible.

Future Work

To address this issue, the following future work is proposed:

Investigate the root cause of the issue: Further investigation is necessary to determine the root cause of the regression in cleveref.
Collaborate with package maintainers: Collaboration with the maintainers of cleveref, algorithm, and algcompatible is necessary to resolve this issue and ensure that these packages continue to work correctly together.
Develop a patch or workaround: A patch or workaround may be necessary to resolve this issue until a permanent fix is implemented.

Introduction

In our previous article, we discussed the apparent regression in cleveref when referencing lines of algorithms with the combination of algorithm and algcompatible after the update from TeXLive 2024 to 2025. In this article, we will provide a Q&A section to address some of the common questions and concerns related to this issue.

Q: What is the root cause of the regression in `cleveref`?

A: The root cause of the regression in cleveref is still unclear. However, it is believed to be related to a change in the way that algorithm and algcompatible interact with cleveref. Further investigation is necessary to determine the root cause of the issue.

Q: How can I update to the latest version of `cleveref`?

A: To update to the latest version of cleveref, you can use the following command:

sudo texliveonload -u cleveref

This will update the cleveref package to the latest version.

Q: What are some alternative algorithm packages that I can use?

A: Some alternative algorithm packages that you can use include:

algorithm2e: This package provides a similar interface to algorithm but with some additional features.
algpseudocode: This package provides a way to typeset pseudocode in a clear and readable format.
listings: This package provides a way to typeset code listings in a clear and readable format.

Q: What are some alternative reference generation packages that I can use?

A: Some alternative reference generation packages that you can use include:

ref: This package provides a simple way to create references to equations, figures, tables, and other elements in your document.
hyperref: This package provides a way to create hyperlinks to equations, figures, tables, and other elements in your document.

Q: How can I submit a bug report to the package maintainers?

A: To submit a bug report to the package maintainers, you can use the following steps:

Go to the package maintainer's website and look for a contact form or email address.
Fill out the contact form or write an email to the package maintainer.
Provide a minimal example that reproduces the issue.
Describe the issue and any relevant details.

Q: What is the current status of the issue?

A: The current status of the issue is that it is still being investigated by the package maintainers. Further updates will be provided as more information becomes available.

Q: How can I stay up-to-date with the latest developments on this issue?

A: To stay up-to-date with the latest developments on this issue, you can:

Follow the package maintainers on social media.
Subscribe to the package maintainer's newsletter.
Check the package maintainer's website regularly for updates.