Struktogramme mit LaTeX: Unterschied zwischen den Versionen
Henn (Diskussion | Beiträge) |
Henn (Diskussion | Beiträge) |
||
(37 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt) | |||
Zeile 1: | Zeile 1: | ||
== Benötigte Programme == | |||
Auch wenn wir in unserem Fachbereich LaTeX nur selten kompiliert nutzen, kann es bei diesem Thema sinnvoll sein, sich eine funktionsfähige Kompilierumgebung einzurichten. Für Windows kann wahlweise die MikTeX oder TexLive Distribution genutzt werden, welche heruntergeladen und installiert werden muss. Als Editor nutze ich selbst gerne den TeX-Maker, welcher auch mit Screenreader gut nutzbar ist (zumindest JAWS und NVDA). Einrückungen werden auf der Zeile angezeigt und über das Menü Benutzer/Wortvervollständigung lassen sich leicht neue Befehle mit Autovervollständigung hinzufügen. | |||
Das Kompilieren in PDF erfolgt über einen Befehlsaufruf und eine sehende Assistenz kann in einem zweiten Fenster direkt das Ergebnis überprüfen. | |||
In der Präambel muss das Paket struktex eingebunden werden. Dazu einfach nach dem Festlegen der Dokumentklasse \usepackage{struktex} hinzufügen. Im Beispiel am Seitenende ist dies genauer zu sehen. | |||
== Aufbau == | |||
Die Struktur ist recht einfach gehalten. Umschlossen wird das Programm stets durch | |||
\begin{struktogramm}(Breite(in mm),Höhe(in mm))[Überschrift] | |||
und | |||
\end{struktogramm} | |||
Die Zahlenangaben in der runden Klammer gibt die Breite und die Höhe der Grafik in Millimetern an. Um sicher zu gehen, dass alles hineinpasst lässt sich hier auch immer mit großzügigen Angaben arbeiten, '''150,150''' ist für die meisten mehr als ausreichend. Die Überschrift in eckigen Klammern ist optional und muss nicht angegeben werden. | |||
=== Kasten für Operationsbeschreibungen === | |||
Mit assign wird ein einfacher Kasten erzeugt. Der Text darin wird linksbündig gesetzt. Möchte man eine zentrierte Ausrichtung, so kann man dies mit der Ergänzung \mbox{}\hfil erreichen. | |||
\assign{Inhalt} | |||
==== Variablendeklarationen ==== | |||
Variablendeklinationen lassen sich mit in einen Kasten einfügen: | |||
\assign{ | |||
\begin{declaration} | |||
\description{Variablenname}{Variablenbeschreibung} | |||
\description{Variablenname}{Variablenbeschreibung} | |||
\end{declaration} | |||
} | |||
[[Datei:Variablendeklaration.png|alternativtext=Variablendeklaration|rahmenlos|360x360px]] | |||
Eine weitere Spezifiziertung ist möglich (Parameter, lokale Variablen und globale Variablen), wer mehr dazu wissen möchte, kann dies in der Dokumentation [https://tug.ctan.org/macros/latex/contrib/struktex/struktex.de.pdf Dokumentation des Paketes] ab Seite 13 nachlesen. | |||
[[Datei:VariablenDeklarationGenauer.png|alternativtext=Variablen Deklaration mit Parametern, lokalen Variablen....|rahmenlos|331x331px]] | |||
=== Unterprogrammsprung === | |||
\sub{Inhalt} | |||
[[Datei:Unterprogramm.png|alternativtext=Unterprogrammkasten (zusätzliche kleine Rechtecke links und rechts)|rahmenlos|497x497px]] | |||
=== Aussprung aus dem Programm === | |||
\return{Inhalt} | |||
Hier ein Beispiel: | |||
\begin{struktogramm}(95,20) | |||
\sub{Liste sortieren} | |||
\return{Listenkopf zurückgeben} | |||
\end{struktogramm} | |||
[[Datei:SubandReturn.png|alternativtext=Sub und Return hintereinander, return hat innerhalb des Kastens links und rechts jeweils eine spitze Klammer|rahmenlos|475x475px]] | |||
=== While, Until und Forever - Schleifen === | |||
\while{Bedingung} | |||
\assign{Schleifeninhalt} | |||
\whileend | |||
[[Datei:Strukto while.png|alternativtext=While Schleife Struktogramm|rahmenlos|628x628px]] | |||
\until{Bedingung} | |||
\assign{Schleifeninhalt} | |||
\untilend | |||
[[Datei:Strukto until.png|alternativtext=Until Schleife Struktogramm|rahmenlos|632x632px]] | |||
\forever | |||
\assign{Schleifeninhalt} | |||
\exit{Exit} | |||
\foreverend | |||
[[Datei:Strukto foreverexit.png|alternativtext=Forever Schleife mit Exit Struktogramm|rahmenlos|600x600px]] | |||
\forallin{$\forall l \in L$} | |||
\assign{gib l) aus} | |||
\forallinend | |||
[[Datei:Forall Strukto.png|alternativtext=For all Schleife|rahmenlos|600x600px]] | |||
=== If-Schleifen === | |||
\ifthenelse[30]{1}{1}{Wahrheitsprüfung}{\sTrue}{\sFalse} | |||
\assign{Wenn ja...} | |||
\change | |||
\assign{Wenn falsch, dann...} | |||
\ifend | |||
[[Datei:If Strukto.png|alternativtext=If-Schleife Struktogramm|rahmenlos|600x600px]] | |||
Bei If-Schleifen ist der Wert in den eckigen Klammern hinter \ifthenelse etwas davon abhängig, wie viel Text in der Bedingung steckt. Hier wird ggf. visuelle Kontrolle benötigt. Die Angaben in den geschweiften Klammern bezeichnen das Verhältnis des Wahr und Falsch Dreiecks - hier wurde ein 1:1-Verhältnis gewählt, möchte man in einem der Bereiche noch weitere Subs oder ähnliches einfügen, kann eine Anpassung sinnvoll sein. | |||
=== Case-Konstrukt === | |||
\begin{struktogramm}(95,50) | |||
\case{5}{3}{Fallprüfung}{0} | |||
\assign{Ausgabe: Fall 0} | |||
\switch{1} | |||
\assign{Ausgabe: Fall 1} | |||
\switch{2} | |||
\assign{Ausgabe: Fall 2} | |||
\caseend | |||
\end{struktogramm} | |||
Hier ist nur der Fall dargestellt, dass eine Diagonale über die unterschiedlichen Fälle gezeichnet wird. Dabei bedeutet: | |||
\case{Höhe}{Anzahl der Fälle}{Bedingung}{Text des 1. Falles} | |||
\switch{Text des 2. Falles} Unterstruktogramm | |||
... | |||
[[Datei:Strukto Case.png|alternativtext=Darstellung Fallunterscheidung (3 Fälle)|rahmenlos|573x573px]] | |||
=== Parallele Algorithmen === | |||
Der Makro \inparallel und die zugehörigen Makros \task und \inparallelend ermöglichen die Darstellung paralleler Verarbeitung in einem Programm. Die Syntax lautet: | |||
\inparallel{Anzahl paralleler Tasks}{Beschreibung 1. Task} | |||
\task{Beschreibung 2. Task} | |||
... | |||
\task{Beschreibung n. Task} | |||
\inparallelend | |||
[[Datei:Strukto parallel.png|rahmenlos|393x393px]] | |||
=== Beispiel === | |||
Dieses Struktogramm | |||
[[Datei:Strukto Bsp.png|alternativtext=Beispieldarstellung eines Programmes mittels eines Struktorgramms|rahmenlos|519x519px]] | |||
sieht dann im Quelltext aus wie folgt: | |||
\documentclass{article} | |||
\usepackage{struktex} | |||
\begin{document} | |||
\begin{struktogramm}(100,50) | \begin{struktogramm}(100,50) | ||
\while{for i := n down to 2} | \while{for i:= n down to 2} | ||
\while{for j := 2 up to i} | \while{for j:= 2 up to i} | ||
\ifthenelse[15]{2}{2}{$(A[j-1] \geq A[j]$}{yes}{no} | \ifthenelse[15]{2}{2}{$(A[j-1] \geq A[j]$}{yes}{no} | ||
\assign{ | \assign{tausche \(A[j-1]\) mit \(A[j]\)} | ||
\change | \change | ||
\ifend | \ifend | ||
\assign{\mbox{}\hfil print (A)} | |||
\whileend | \whileend | ||
\whileend | \whileend | ||
\end{struktogramm} | \end{struktogramm} | ||
\end{document} |
Aktuelle Version vom 9. Januar 2023, 13:17 Uhr
Benötigte Programme
Auch wenn wir in unserem Fachbereich LaTeX nur selten kompiliert nutzen, kann es bei diesem Thema sinnvoll sein, sich eine funktionsfähige Kompilierumgebung einzurichten. Für Windows kann wahlweise die MikTeX oder TexLive Distribution genutzt werden, welche heruntergeladen und installiert werden muss. Als Editor nutze ich selbst gerne den TeX-Maker, welcher auch mit Screenreader gut nutzbar ist (zumindest JAWS und NVDA). Einrückungen werden auf der Zeile angezeigt und über das Menü Benutzer/Wortvervollständigung lassen sich leicht neue Befehle mit Autovervollständigung hinzufügen.
Das Kompilieren in PDF erfolgt über einen Befehlsaufruf und eine sehende Assistenz kann in einem zweiten Fenster direkt das Ergebnis überprüfen.
In der Präambel muss das Paket struktex eingebunden werden. Dazu einfach nach dem Festlegen der Dokumentklasse \usepackage{struktex} hinzufügen. Im Beispiel am Seitenende ist dies genauer zu sehen.
Aufbau
Die Struktur ist recht einfach gehalten. Umschlossen wird das Programm stets durch
\begin{struktogramm}(Breite(in mm),Höhe(in mm))[Überschrift]
und
\end{struktogramm}
Die Zahlenangaben in der runden Klammer gibt die Breite und die Höhe der Grafik in Millimetern an. Um sicher zu gehen, dass alles hineinpasst lässt sich hier auch immer mit großzügigen Angaben arbeiten, 150,150 ist für die meisten mehr als ausreichend. Die Überschrift in eckigen Klammern ist optional und muss nicht angegeben werden.
Kasten für Operationsbeschreibungen
Mit assign wird ein einfacher Kasten erzeugt. Der Text darin wird linksbündig gesetzt. Möchte man eine zentrierte Ausrichtung, so kann man dies mit der Ergänzung \mbox{}\hfil erreichen.
\assign{Inhalt}
Variablendeklarationen
Variablendeklinationen lassen sich mit in einen Kasten einfügen:
\assign{ \begin{declaration} \description{Variablenname}{Variablenbeschreibung} \description{Variablenname}{Variablenbeschreibung} \end{declaration} }
Eine weitere Spezifiziertung ist möglich (Parameter, lokale Variablen und globale Variablen), wer mehr dazu wissen möchte, kann dies in der Dokumentation Dokumentation des Paketes ab Seite 13 nachlesen.
Unterprogrammsprung
\sub{Inhalt}
Aussprung aus dem Programm
\return{Inhalt}
Hier ein Beispiel:
\begin{struktogramm}(95,20) \sub{Liste sortieren} \return{Listenkopf zurückgeben} \end{struktogramm}
While, Until und Forever - Schleifen
\while{Bedingung} \assign{Schleifeninhalt} \whileend
\until{Bedingung} \assign{Schleifeninhalt} \untilend
\forever \assign{Schleifeninhalt} \exit{Exit} \foreverend
\forallin{$\forall l \in L$} \assign{gib l) aus} \forallinend
If-Schleifen
\ifthenelse[30]{1}{1}{Wahrheitsprüfung}{\sTrue}{\sFalse} \assign{Wenn ja...} \change \assign{Wenn falsch, dann...} \ifend
Bei If-Schleifen ist der Wert in den eckigen Klammern hinter \ifthenelse etwas davon abhängig, wie viel Text in der Bedingung steckt. Hier wird ggf. visuelle Kontrolle benötigt. Die Angaben in den geschweiften Klammern bezeichnen das Verhältnis des Wahr und Falsch Dreiecks - hier wurde ein 1:1-Verhältnis gewählt, möchte man in einem der Bereiche noch weitere Subs oder ähnliches einfügen, kann eine Anpassung sinnvoll sein.
Case-Konstrukt
\begin{struktogramm}(95,50) \case{5}{3}{Fallprüfung}{0} \assign{Ausgabe: Fall 0} \switch{1} \assign{Ausgabe: Fall 1} \switch{2} \assign{Ausgabe: Fall 2} \caseend \end{struktogramm}
Hier ist nur der Fall dargestellt, dass eine Diagonale über die unterschiedlichen Fälle gezeichnet wird. Dabei bedeutet:
\case{Höhe}{Anzahl der Fälle}{Bedingung}{Text des 1. Falles} \switch{Text des 2. Falles} Unterstruktogramm ...
Parallele Algorithmen
Der Makro \inparallel und die zugehörigen Makros \task und \inparallelend ermöglichen die Darstellung paralleler Verarbeitung in einem Programm. Die Syntax lautet:
\inparallel{Anzahl paralleler Tasks}{Beschreibung 1. Task} \task{Beschreibung 2. Task} ... \task{Beschreibung n. Task} \inparallelend
Beispiel
Dieses Struktogramm
sieht dann im Quelltext aus wie folgt:
\documentclass{article} \usepackage{struktex} \begin{document} \begin{struktogramm}(100,50) \while{for i:= n down to 2} \while{for j:= 2 up to i} \ifthenelse[15]{2}{2}{$(A[j-1] \geq A[j]$}{yes}{no} \assign{tausche \(A[j-1]\) mit \(A[j]\)} \change \ifend \assign{\mbox{}\hfil print (A)} \whileend \whileend \end{struktogramm} \end{document}