[Tex/LaTex] Putting pseudocode in a framed box

framedpseudocode

I added some pseudocode to my document in this style:

\usepackage{algpseudocode}

\begin{algorithmic}[1]
\If {$i\geq maxval$}
\State $i\gets 0$
\Else
\If {$i+k\leq maxval$}
    \State $i\gets i+k$
\EndIf
\EndIf
\end{algorithmic}

I want my pseudocode to appear in a box, i.e. framed.

I tried

\framebox{ 
    \begin{algorithmic}[1] ...     
    \end{algorithmic} 
}

but that gave me tons of errors and didn't divide the code on multiple lines.

How can I frame my pseudocode?

Best Answer

Using \varwidth you can set an upper limit as the width of the line minus the space taken up by the box margins, but allow it to shrink if possible to the longest line of the display

enter image description here

\documentclass{article}
\usepackage{varwidth}

\usepackage{algpseudocode}

\begin{document}
\noindent\fbox{%
\begin{varwidth}{\dimexpr\linewidth-2\fboxsep-2\fboxrule\relax}
\begin{algorithmic}[1]
\If {$i\geq maxval$}
\State $i\gets 0$
\Else
\If {$i+k\leq maxval$}
    \State $i\gets i+k$
\EndIf
\EndIf
\end{algorithmic}
\end{varwidth}% 
}

\end{document}

Related Solutions

Pseudocode – Self-defined Width of the Pseudocode Box with Algorithmicx

You can place the algorithmic environment inside a minipage of desired width (for example, 1.5\columnwidth):

enter image description here

\documentclass{IEEEtran}
\usepackage{algpseudocode}% http://ctan.org/pkg/algorithmicx
\usepackage{lipsum}% http://ctan.org/pkg/lipsum
\usepackage{float}% http://ctan.org/pkg/float
\floatstyle{boxed} % Box...
\restylefloat{figure}% ...figure environment contents.
\begin{document}
\section{A section}
\begin{figure*}
  \centering
  \caption{Euclid’s algorithm}\label{euclid}
  \begin{minipage}{1.5\columnwidth}
  \begin{algorithmic}[1]
    \Procedure{Euclid}{$a,b$}\Comment{The g.c.d. of a and b}
      \State $r\gets a\bmod b$
      \While{$r\not=0$}\Comment{We have the answer if r is 0}
        \State $a\gets b$
        \State $b\gets r$
        \State $r\gets a\bmod b$
      \EndWhile\label{euclidendwhile}
      \State \textbf{return} $b$\Comment{The gcd is b}
    \EndProcedure
  \end{algorithmic}
  \end{minipage}
\end{figure*}

\lipsum[1-15]% dummy text
\end{document}

To reduce the box size itself, it is far more convenient to remove the boxed float style, and mere wrap the minipaged algorithmic environment inside an \fbox:

enter image description here

\documentclass{IEEEtran}
\usepackage{algpseudocode}% http://ctan.org/pkg/algorithmicx
\usepackage{lipsum}% http://ctan.org/pkg/lipsum
\usepackage{float}% http://ctan.org/pkg/float
%\floatstyle{boxed} % Box...
\restylefloat{figure}% ...figure environment contents.
\begin{document}
\section{A section}
\begin{figure*}
  \centering
  \caption{Euclid’s algorithm}\label{euclid}
  \fbox{\begin{minipage}{1.5\columnwidth}
  \begin{algorithmic}[1]
    \Procedure{Euclid}{$a,b$}\Comment{The g.c.d. of a and b}
      \State $r\gets a\bmod b$
      \While{$r\not=0$}\Comment{We have the answer if r is 0}
        \State $a\gets b$
        \State $b\gets r$
        \State $r\gets a\bmod b$
      \EndWhile\label{euclidendwhile}
      \State \textbf{return} $b$\Comment{The gcd is b}
    \EndProcedure
  \end{algorithmic}
  \end{minipage}}
\end{figure*}

\lipsum[1-15]% dummy text
\end{document}

[Tex/LaTex] Framed box with border inside margin

[Edit I mentioned in my first solution that there is a fancier way to do this, so here it is.]

I am assuming that by "the verticals borders are fully within the margins and the position and width of the actual content is unchanged" you mean that the nested boxes should have the same width as the outer boxes. If this is not the case then you just need to change the values of

leftmargin, rightmargin, innerleftmargin, innerrightmargin

in the code below. Modulo my awful choice of colours, I think that you are trying to achieve something like the following:

enter image description here

This was done using the mdframed package and the following code:

\documentclass{article}
\usepackage{mdframed}
\usepackage{xcolor}
\newcounter{FramedDepth}
\setcounter{FramedDepth}{-1}
\mdfdefinestyle{Framed}{linecolor=black,linewidth=0pt,leftmargin=0pt,rightmargin=0pt,
                        innerleftmargin=0pt,innerrightmargin=0pt}
\newenvironment{Framed}{%
  \addtocounter{FramedDepth}{1}
  \ifcase\theFramedDepth\def\FrameColour{blue!50}%
    \or\def\FrameColour{green!50}%
    \or\def\FrameColour{red!50}%
    \or\def\FrameColour{orange!50}%
    \fi%
  \begin{mdframed}[style=Framed,backgroundcolor=\FrameColour]%
}{\end{mdframed}\addtocounter{FramedDepth}{-1}}

\begin{document}

\begin{Framed}
  Some interesting text.
\end{Framed}

\begin{Framed}
  This is even more interesting.

    \begin{Framed}
      ...and this is beyond mentioning
    \end{Framed}
     Some more text
     \begin{Framed}
       Another level down
     \end{Framed}
  \end{Framed}
\end{Framed}

\end{document}

Personally, I prefer to have the nested boxes slightly indented. For example with

\mdfdefinestyle{Framed}{linecolor=black,linewidth=1pt}

you obtain:

enter image description here

Best Answer

Related Solutions

Pseudocode – Self-defined Width of the Pseudocode Box with Algorithmicx

[Tex/LaTex] Framed box with border inside margin

Related Question