☰

Проблема с отступом в цикле doWhile

tag-icon • tag-icon typography algorithms
Проблема с отступом в цикле doWhile

Я пытался написать несколько операторов цикла, используя циклы do-while для блок-схемы, показанной в [1]. Однако управление отступами оказалось сложным. Может ли кто-нибудь помочь с этой проблемой?

\documentclass{article}
\usepackage{algorithmicx}
\usepackage{algpseudocode}

\algdef{SE}[DOWHILE]{Do}{doWhile}{\algorithmicdo}[1]{\algorithmicwhile\ #1}%

\begin{document}
\begin{algorithmic}
  \Do
    \State a,b,c,d,e,m,n
  \doWhile{$!f$} % <--- use \doWhile for the "while" at the end
  
  $g$
  
    \Do
    \State abc
    \doWhile{$!h$}
    
    $i$
    \Do
    \State Pv
    \doWhile{$!j$}
    
    $r s t $
  %  \doWhile{$!$}
  %   \State l
\end{algorithmic}
\end{document}

Проблема в отступах.

решение1

Хотя пробелы в тексте программы обычно игнорируются языками программирования, согласно общепринятой практике, отступы используются в программах, чтобы сделать их более читабельными. Для достижения этой цели отступы должны, как правило, следовать некоторому стилю последовательным образом, который отражает структуру программы.

В коде, который у вас есть, я не могу проследить структуру вашей программы. К сожалению, пакет algorithmicx(см.его документация) также не соответствует вашей структуре и делает отступы в коде не такими, как вы ожидаете.

В частности, я (а algorithmicxтакже) не вижу:

  1. Что $g$есть. Если это какое-то абстрактное утверждение, то его следует писать как, \State $g$чтобы был правильный отступ. То же самое относится к $i$и $r s t$.

  2. Почему вы ожидаете, что строки ниже $g$будут отступом не прямо снизу $g$, а больше справа. Это можно объяснить только если $g$обозначает некоторую форму блочного оператора (например, a while), тело которого распространяется на строки ниже.

Полученный результат (после добавления недостающих \Stateмакросов и некоторых \medskipдля добавления вертикального пространства) отражает структуру программы, как algorithmicxона ее воспринимает:

результат 1

С другой стороны, если вы действительно хотите ввести произвольный отступ после заголовка блока, вы можете определить новый тип блока для этой цели (я назвал его \Arbitrary{header} ... \endArbitrary):

\documentclass{article}
\usepackage{algorithmicx}
\usepackage{algpseudocode}

\algdef{SE}[DOWHILE]{Do}{doWhile}{\algorithmicdo}[1]{\algorithmicwhile\ #1}%
\algblockdefx[ARBITRARY]{Arbitrary}{endArbitrary}[1]{#1}

\begin{document}
\begin{algorithmic}
  \Do
    \State a,b,c,d,e,m,n
  \doWhile{$!f$} % <--- use \doWhile for the "while" at the end
  \medskip
  \Arbitrary{$g$}
    \medskip
    \Do
    \State abc
    \doWhile{$!h$}
    \medskip
    \State $i$
    \Do
    \State Pv
    \doWhile{$!j$}
    \medskip
    \State $r s t $
  \endArbitrary
\end{algorithmic}
\end{document}

Это приводит к:

результат 2

решение2

Ниже представлен псевдокод на основе Do-While, который я написал на LaTex. Кто-нибудь может проверить его и использовать для других, у кого в будущем может возникнуть та же проблема.

\documentclass[11pt]{article}
\usepackage[fleqn]{amsmath}
\usepackage[ruled,vlined]{algorithm2e}
\PassOptionsToPackage{noend}{algpseudocode}
\usepackage{algpseudocode}

    %%%%%%%%%%%%%%%%%%
    %% DoWhile algorithm macro definition 
    \makeatletter
    \newcommand*{\algrule}[1][\algorithmicindent]{\makebox[#1][l]{\hspace*{.5em}\vrule height .75\baselineskip depth .25\baselineskip}}
    
    \newcount\ALG@printindent@tempcnta
    \def\ALG@printindent{%
        \ifnum \theALG@nested>0% is there anything to print
        \ifx\ALG@text\ALG@x@notext% is this an end group without any text?
        % do nothing
        \addvspace{-3pt}% FUDGE for cases where no text is shown, to make the rules line up
        \else
        \unskip
        % draw a rule for each indent level
        \ALG@printindent@tempcnta=1
        \loop
        \algrule[\csname ALG@ind@\the\ALG@printindent@tempcnta\endcsname]%
        \advance \ALG@printindent@tempcnta 1
        \ifnum \ALG@printindent@tempcnta<\numexpr\theALG@nested+1\relax% can't do <=, so add one to RHS and use < instead
        \repeat
        \fi
        \fi
    }
\usepackage{etoolbox}
% the following line injects our new indent handling code in place of the default spacing
\patchcmd{\ALG@doentity}{\noindent\hskip\ALG@tlm}{\ALG@printindent}{}{\errmessage{failed to patch}}
\makeatother
% end vertical rule patch for algorithmicx
\algdef{SE}[DOWHILE]{Do}{doWhile}{\algorithmicdo}[1]{\algorithmicwhile\ #1}%

\begin{algorithm}%\captionsetup{labelfont={sc,bf}, labelsep=newline}
    \caption{Workspace boundary determination}
    \label{alg:PoEG}    
    \begin{algorithmic}
        \State Input $z_0,~z_f,~n,~m$
        \State \quad \quad ~ $\Delta_z = \dfrac{z_0-z_f}{n}, \textit{tol}$
        \State \quad \quad ~ $\varepsilon_f= 2\pi~, \Delta\varepsilon = \dfrac{\varepsilon_f}{m}$
        \State \quad \quad ~ $k_{\textup{max}}, \Delta\alpha_0, i = j=1$
        \medskip
        \State Output $\boldsymbol{\theta}, \boldsymbol{\psi}, \boldsymbol{z} $
        \medskip
        \State initialize ~$z \gets z_0,~ \psi=\theta =\gets \emptyset$
        \Do
            \Do 
                \Do
                    \Do 
                        \State $\Delta\psi = \psi + \Delta\alpha c\varepsilon$
                        \State $\Delta\theta = \theta + \Delta\alpha s\varepsilon $ 
                        \State $\psi = \psi +\Delta\varepsilon$
                        \State $\theta = \psi + \Delta\varepsilon$ 
                        \State Compute $\boldsymbol{J}_{dh}$ 
                        \State $k = cond(\boldsymbol{J}_{dh})$
        
                    \doWhile{$k<k_{max}$}
        
                    \State $\psi = \psi -\Delta\varepsilon$
                    \State $\theta = \psi - \Delta\varepsilon$ 
        
                    \State $\Delta\alpha = \Delta\alpha/2$
        
                \doWhile{$\Delta\alpha > tol $}
                \State $\psi(i,j) = \psi $
                \State $\theta(i,j) = \theta $
        
                \State $ j =j+1$
                \State $\Delta\alpha = \Delta\alpha_0$
                \State $\varepsilon = \varepsilon + \Delta\varepsilon$
            \doWhile{$\varepsilon < 2\pi$}
        
            \State $ \theta =0$
            \State $\psi =0$
            \State $\varepsilon =0$
            \State $\Delta\alpha=\Delta\alpha_0$
            \State $i=i+1$
            \State $z_i=z+\Delta_z$

        \doWhile{$z<z_f$} \\ % <--- use \doWhile for the "while" at the end
        plot$(\boldsymbol{\psi},\boldsymbol{\theta},\boldsymbol{z})$\\ \medskip Note: $s$ and $c$ stands for sine and cosine, respectively.
        %\endArbitrary
    \end{algorithmic}
\end{algorithm}

\end{document}

Связанный контент