DIGITAL
Auf diesem Übungsblatt möchten wir uns weitere möglichkeiten Ansehen mehr Struktur in Code zu bringen. Als erstes schauen wir uns dazu das Decorator-Pattern am Beispiel von Streams an, das uns ermöglicht beliebig komplexe Klassen durch Verschachtelung zu generieren. Im zweiten Teil des Blattes schauen wir uns an, wie funktionale(re)r Code mittels C++ realisiert werden kann.
Änderungshistorie:
include <string>
hat in der main.cpp
gefehltBasicStream
hatte den falschen DestruktorBasicStream
sitzt natürlich zwischen den Basisklassen und dem Hauptinterface Stream
, nicht zwischen den Basisklassen (was so nicht definiert werden könnte).StreamDecorator
dekoriert formell beliebige Stream
-Klassen, kann aber nicht mit beliebigen Streamklassen konstruiert werden.Auf den vergangenen Blättern wurde bereits mit std::cin
, std::cout
und Dateistreams gearbeitet. In dieser Aufgabe sehen wir uns an, wie man die Funktionalität dieser Objekte erweitern kann. Dazu definieren wir als erstes ein Interface (Stream
), das am Ende alle Klassen implementieren werden.
Da es leider nicht so einfach ist, C++-Streams objektorientiert direkt zu erweitern, geben wir für diese Aufgabe einen einfachen Wrapper (BasicStreamWrapper
) für std::ostream
vor. Nun, mit einer eigenen C++-Implementierung können wir eigene Klassen definieren, die davon ableiten: Wir implementieren drei sogenannte Dekoratoren, die das Verhalten des Streams im Gegensatz zum Wrapper auch tatsächlich verändern.
Interface:
Als Basis definieren wir die abstrakte Klasse Stream
, die das Interface eines Streams festlegt: Jeder Stream stellt eine Methode print
bereit, mit der Daten in den Stream geschrieben werden können. Wohin die Daten dann tatsächlich geschrieben werden, ist durch dieses Interface noch nicht festgelegt (theoretisch darf ein Stream auch Daten wegwerfen).
class Stream {
public:
virtual void print(const std::string&) = 0;
virtual ~Stream() = default;
};
Wrapper für std::ostream
:
Wir nutzen nun das Interface Stream
, um eine konkrete Implementierung eines Streams vorzugeben. Die unterhalb definierte Klasse BasicStreamWrapper
gibt den übergebenen String auf einem C++-kompatiblen Output-Stream (etwa std::cout
) aus und wrappt damit wie die Verwendung von C++-Streams. (Eine mögliche Verwendung wird weiter unten in einem Beispielcodeschnipsel vorgeführt).
// .h
class BasicStreamWrapper : public Stream {
private:
std::ostream& stream;
public:
explicit BasicStreamWrapper(std::ostream& s): stream(s) {};
void print(const std::string&) override;
~BasicStreamWrapper() override = default;
};
// .cpp
void BasicStreamWrapper::print(const std::string& string) {
stream << string;
}
Dekoratoren: Wir können jetzt Modifikationen implementieren, die den auszugebenen String mit Zeilennummern versehen (CountDecorator
), ein Trennzeichen hinten anfügen (PostfixDecorator
) oder sogar den eigentlichen Inhalt des Strings überschreiben (CaesarDecorator
). Um solche Modifikatoren nach einem Baukasten-System zusammensetzen zu können, bedienen wir uns des Decorator-Patterns: Wir leiten für jede Modifikation einen weiteren Stream ab, der in seiner print
-Methode die gewünschten Änderungen am String durchführt, dann aber das Ergebnis nicht sofort ausgibt, sondern an einen anderen Stream weitergibt. Der "Dekorator"-Stream hat also dasselbe Interface wie ein normaler Stream, verhält sich aber anders.
class StreamDecorator : public Stream {
protected:
Stream* stream;
public:
explicit StreamDecorator(Stream* s) : stream(s) {};
~StreamDecorator() override = default;
};
Die Klasse StreamDecorator
ist unser Ausgangspunkt für diese Implementierung. StreamDecorator
leitet zwar von Stream
ab, überschreibt aber nicht die pure virtuelle Methode print
und ist daher selbst eine abstrakte Klasse, kann also nicht instanziiert werden. Jeder StreamDecorator
führt einen Zeiger auf den Stream mit, auf den letztendlich geschrieben werden soll.
Beispielverwendung:
Wenn Sie alles implementiert haben, sollte das folgende Codebeispiel funktionieren:
#include <ostream>
#include <string>
// Ihre selbst definierten Header kommen hierher.
void do_something(Stream &stream) {
stream.print("Hello World");
stream.print("Second Line");
}
int main() {
std::ostream& out = std::cout;
BasicStreamWrapper cout(out);
PostfixDecorator postfix(&cout, ".\n");
CountDecorator count(&postfix);
CaesarDecorator caesar(&count, 7);
do_something(count);
do_something(caesar);
}
Die Ausgabe ist dann
[0] Hello World.
[1] Second Line.
[2] Olssv Dvysk.
[3] Zljvuk Spul.
StreamDecorator
erben: CountDecorator
, der vor jede Ausgabe eine automatisch inkrementierende Ausgabennummer anhängt. class CountDecorator : public StreamDecorator {
uint64_t counter;
public:
explicit CountDecorator(Stream* s, uint64_t initial_counter = 0);
void print(const std::string&) override;
~CountDecorator() override = default;
};
CountDecorator
vor. Die Syntax ... : StreamDecorator(s) ...
ruft den Konstruktor der Basisklasse StreamDecorator
mit dem gewrappten Stream auf.CountDecorator::CountDecorator(Stream *s, uint64_t initial_counter) : StreamDecorator(s), counter(initial_counter) {}
PostfixDecorator
. Dieser soll einen vorher definierten String an jeden String anhängen, der print
übergeben wird. class PostfixDecorator : public StreamDecorator {
private:
std::string postfix_string;
public:
explicit PostfixDecorator(Stream* s, const std::string& postfix_string = "\n");;
void print(const std::string&) override;
~PostfixDecorator() override = default;
};
CaesarDecorator
. Ein CaesarDecorator
soll jeden String, der an print
übergeben wird, nach dem Caesar-Chiffre verschlüsseln. Das Caesar-Chiffre ist eine sehr einfache Verschlüsselung, bei der alle Buchstaben einfach verschoben werden. Andere Zeichen bleiben unverändert. Die Zeichen der oberen Reihe werden in das jeweilige Zeichen der unteren Reihe übersetzt. Hier ein Beispiel für eine Verschiebung um 5 Buchstaben: Klar: a b c d e f g h i j k l m n o p q r s t u v w x y z
Geheim: f g h i j k l m n o p q r s t u v w x y z a b c d e
Die Buchstabenverschiebung wird Ihrer Klasse als Konstruktorparameter übergeben.class CaesarDecorator : public StreamDecorator {
private:
int32_t shift;
public:
explicit CaesarDecorator(Stream* s, int32_t shift = 0);
void print(const std::string&) override;
~CaesarDecorator() override = default;
};
StreamDecorator
eine beliebige Klasse vom Typ Stream
erwartet können wir auch andere Basisobjekte vom Typ Stream
dekorieren ohne unseren Klassen vom Typ StreamDecorator
umschreiben zu müssen. Wir tun dies, indem wir eine Klasse StreamPrintWrapper
definieren, die statt einem std::ostream
die Methode printf
(Link zur Dokumentation) wrappt. Implementieren Sie also class StreamPrintWrapper : public Stream { ... }
als zweite Basisklasse.BasicStream
als Interface, das zwischen den Basisklassen (also StreamPrintWrapper
und BasicStreamWrapper
) und Stream
sitzt. Die beiden Basisklassen implementieren nun BasicStream
statt Stream
class BasicStream : public Stream {
public:
virtual void print(const std::string&) = 0;
virtual ~BasicStream() = default;
};
StreamDecoratorLevelOne
so, dass zwar einen allgemeinen Stream*
dekoriert, aber nicht mit beliebigen Streams konstruiert werden darf, sondern nur anderen StreamDecoratorLevelOne
(also der selbe Typ wie der Decorator selbst) oder anderen Basisklassen (BasicStream
): class StreamDecoratorLevelOne : public Stream {
protected:
Stream* stream;
public:
// man beachte hier die zwei Konstruktoren, die keine beliebigen Stream-Objekte zulassen, aber weiterhin beliebige Stream* speichern.
explicit StreamDecoratorLevelOne(StreamDecoratorLevelOne* s) : stream(s) {};
explicit StreamDecoratorLevelOne(BasicStream* s) : stream(s) {};
~StreamDecoratorLevelOne() override = default;
};
CaesarDecorator
, PostfixDecorator
und CountDecorator
so ab, dass die Verslüsselung stets nur den eigentlich auszugebenden Text verschlüsselt, nicht aber eventuelle Postfixes oder Prefixes (wie beim CountDecorator
). PostfixDecorator(CaesarDecorator(Stream *))
aufzurufen.Änderungen:
std::numeric
und std::algorithm
verwenden. (Link zu std::algorithm
)
In der Vorlesung haben wir das Konzept der funktionalen Programmierung kennen gelernt. Funktionszeiger sind eine Möglichkeit, Funktionen an andere Funktionen als Argument zu übergeben. In vielen Fällen ist es jedoch unnötig globale Funktionen zu definieren, die dann per Funktionszeiger an etwa nur einer Stelle eingebunden werden. An dieser Stelle kommen Lambda-Funktionen ins Spiel, die Sie eventuell bereits aus Python kennen.
In C++ sehen Lambda-Funktionen folgendermaßen aus:
[](int a, int b) -> int {return a+b;}
Dabei bezeichnet []
die „Capture-List“, ()
die Argumentliste, der Teil nach ->
den Rückgabetypen und {}
umfasst den Funktionsrumpf.
Alle Variablen in der Capture-List werden aus dem umgebenden Scope "eingefangen" und stehen der Lambda-Funktion je nach Deklaration als Kopie oder per Referenz zur Verfügung. Beispielsweise für die Variable a
wird die Variable mittels
[a]
als Wert (Kopie)[&a]
als Referenzübergeben. Es ist auch möglich, mehrere Variablen anzugeben, etwa durch [x, &y]
. Genauso können alle Variablen der umgebenden Scopes eingefangen werden, und zwar durch
[=]
als Werte (Kopie)[&]
als Referenz.Hier gilt außerdem:
return
-Statements geschlossen. Obiger Lambda-Ausdruck lässt sich also auch schreiben als [a](int32_t b) {return a + b;}
.[...](...) mutable {...}
sorgt dafür, dass die Call-by-Value-Variablen der Capture-List auch in der Lambda-Funktion verändert werden können.auto
(siehe unten) oder Templates gesetzt werden.Beispiel:
auto sum = [](int32_t a, int32_t b){return a + b;}
int32_t c = sum(5, 6);
int32_t d = sum(4, 8);
Lambdas in Variablen zu speichern und dann damit zu arbeiten ist noch nicht sehr spannend. Interessant wird es aber vor allem dann, wenn wir Funktionen definieren wollen, die selbst wieder Funktionen generieren und/oder Funktionen als Argument(e) erhalten, Higher-Order-Functions (siehe Vorlesung).
Beispiel:
#include <cmath>
#include <iostream>
#include <functional> // benötigt für den abstrakten Typ std::function
// Diese Funktion wendet f auf das größere der beiden int32_t-Argumente an.
// Dabei bildet f von einem int32_t auf ein double ab, was in Code nur implizit steht.
// std::function<double(int)> steht hierbei für eine Funktion, die ein int auf ein double Abbildet.
// (In der Klammer können auch mehrere durch Kommata getrennte Argumente stehen).
double transform_max(int a, int b, std::function<double(int)> f) {
return a > b ? f(a) : f(b);
}
// Alternativ können Lambdas auch mithilfe von Templates einer Funktion übergebenen werden
// Das Ganze sieht dann folgendermaßen aus:
template <typename Func>
double transform_max_tl(int32_t a, int32_t b, Func f) {
return a > b ? f(a) : f(b);
}
// Diese Funktion generiert einne Funktion, die prüft, ob eine Zahl < max ist.
// bool ist hierbei die Ausgabe aus der Eingabe int
std::function<bool(int)> make_less_predicate(int max) {
return [max](int val) -> bool {
return val < max;
};
}
auto make_less_predicate_tl(int32_t max) {
return [max](int32_t val) -> bool {
return val < max;
};
}
int main() {
// Lambdas können auch direkt übergeben werden, ohne erst in einer Variable
// gespeichert zu werden. (Insbesondere, wenn man sie nur einmal verwendet)
double t = transform_max(89, 123, [](int32_t c) -> double {
return std::sqrt(c);
});
// Hinweis: Bei der templatisierten Version wird das Templateargument automatisch ermittelt.
double t2 = transform_max_tl(89, 123, [](int32_t c) -> double {
return std::sqrt(c);
});
auto less42 = make_less_predicate(42);
auto less5 = make_less_predicate(5);
std::cout << "Test: " << less5(8) << " " << less5(48) << std::endl;
std::cout << "Test: " << less42(8) << " " << less42(48) << std::endl;
}
Übrigens: Ein Prädikat ist dabei im Allgemeinen der Teil einer atomaren Aussage, der wahrheitsfunktional ist (Quelle: Wikipedia). In unseren Beispielen sind dies also Funktionen, die für beliebige Eingabe entweder wahr (true
) bzw falsch (false
) zurückgeben.
Implementieren Sie die folgenden Higher-Order Functions und zeigen Sie ihre Verwendung an mindestens einem Beispiel.
void for_each(std::vector<float> &v, std::function<void(float)> f)
void(float)
für jedes Element aus. float find_if(std::vector<float> &v, std::function<bool(float)> f)
bool(float)
) erfüllt.float count_if(std::vector<float> &v, std::function<bool(float)> f)
bool(float)
) erfüllen.void transform(std::vector<float> &v, std::function<float(float)> f)
f
(Typ float(float)
) transformierten Element.float accumulate(std::vector<float> &v, std::function<float(float,float)> f, float start = 0.0)
float(float,float)
) auf.accumulate(v,f,0) = f(...(f(f(start,v[0]),v[1]),...),v[n])
.void partition(std::vector<float> &v, std::function<bool(float)> f)
bool(float)
) erfüllen an den Anfang der Liste und alle, die das Prädikat nicht erfüllen ans Ende der Liste. template <typename Func1, typename Func2> auto compose(Func1 f1, Func2 f2)
f1
und f2
und gibt die Funktion zurück, die das Ergebnis von f2
in f1
einsetzt. float(float)
; template <typename Func> auto partial(Func f, float val)
f1
mit zwei Argumenten (z.B. Typ float(float,float)
) und soll eine Funktion zurückgeben, die das zweite Argument von f
festsetzt. float(float)
. Mathematisch ausgedrückt suchen wir die Funktion \[
f_a: x \mapsto f(x,a).
\]find_if
, count_if
könnten auch Funktionen wie etwa any_of
, all_of
, none_of
implementiert werden. Diese sollen die Frage beantworten, ob ein Prädikat für irgendein/kein/alle Elemente gilt.partition
kann auch ein sort
implementiert werden, dass basierend auf einem Comparator-Prädikat vom Typ bool(float,float)
(also zwei Eingaben) die Liste sortiert — true
entspricht dabei der Aussage, dass die linke Eingabe kleiner ist als die zweite Eingabe.Implementieren Sie die Möglickeit weiter Spielfelder mit einander zu verbinden.
Alle Spielfelder sollen durch „Tunnel“ mit einander verbunden werden; bewegt sich ein Objekt in den Tunnel, soll es ganz einfach von einem Spielfeld auf das andere Gesetzt werden, das der Tunnel verbunden hat.
Wichtig Erweitern Sie den Code durch eine Tunnel-Klasse! Sinn dieser Aufgabe ist es, beliebige viele Tunnel einzubinden zu können.
┌─┬─┬─┬─┬─┬─┬─┬─┐
│ │ │♘│ │ │ │ │ │
├─┼─┼─┼─┼─┼─┼─┼─┼─┬─┐
│ │ │ │ │ │ │ │ │ │ │ tunnel
├─┼─┼─┼─┼─┼─┼─┼─┼─┴─┘
│ │ │ │ │ │ │ │ │
├─┼─┼─┼─┼─┼─┼─┼─┤
│ │ │ │ │ │ │ │♞│
├─┼─┼─┼─┼─┼─┼─┼─┤
│ │ │ │ │ │ │ │♚│
├─┼─┼─┼─┼─┼─┼─┼─┤ ┌─┬─┬─┬─┬─┬─┬─┬─┐
│ │♔│ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
├─┼─┼─┼─┼─┼─┼─┼─┤ ├─┼─┼─┼─┼─┼─┼─┼─┤
│ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │♚│ │
├─┼─┼─┼─┼─┼─┼─┼─┤ ├─┼─┼─┼─┼─┼─┼─┼─┤
│♘│ │ │ │ │♞│ │ │ │ │ │ │ │ │ │ │ │
└─┴─┴─┴─┴─┴─┴─┴─┘ ├─┼─┼─┼─┼─┼─┼─┼─┤
│ │ │♘│ │ │ │ │ │
├─┼─┼─┼─┼─┼─┼─┼─┤
│ │ │ │ │ │ │ │ │
┌─┬─┼─┼─┼─┼─┼─┼─┼─┼─┤
tunnel │ │ │ │ │ │ │ │ │ │ │
└─┴─┴─┴─┴─┴─┴─┴─┴─┴─┘
+---------------------------------------+
| v<<<.<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< |
| v --^ --- -- -- -- -- -- -- - ^ |
| .>>>.>>>>>>>>>>>>>>>>>>>>>>>>>>>v ^ |
| v | ^ +-----------------------+ v | ^ |
| v ^ | | v ^ |
| v | ^ | | v | ^ |
| v ^ | | v ^ |
| v | ^ | | v | ^ |
| v ^ +-----------------------+ v ^ |
| v ^<<<<<<<<<<<<<<<<<<<<<<<<<<<.<<<. |
| v-- --- -- -- -- -- -- - v T ^ |
| >>>>>>>>>>>>>>>>>>.>>>.>>>>>>>>>>>>>^ |
+-----------------| v ^ |-------------+
| v | ^ |
| v ^ |
| v | ^ |
|_-----_|
/ \
tunnel
+------------------------------------------------------------------------------------+
| v<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< |
| v -- -- -- -- -- -- -- -- -- -- -- -- --- -- -- -- -- -- -- - ^ |
| v | >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>.>>>.>>>>>>>>>>>>>>>>>>>>>>>>>>>v ^ |
| v ^ +------------------------------------+ v | ^ +-----------------------+ v | ^ |
| v | ^ | | v ^ | | v ^ |
| v ^ | | v | ^ | | v | ^ |
| v | ^ | | v ^ | | v ^ |
| v ^ | | v | ^ | | v | ^ |
| v | ^ | +---------------------+ v ^ +-----------------------+ v ^ |
| v ^ | | v<<<<<<<<<<<<<<<<<<<<<<<<<.<<<<<<<<<<<<<<<<<<<<<<<<<<<.<<<^ |
| v | ^ | | v -- -- -- -- -- -- --- -- -- -- -- -- - v T ^ |
| v ^ | | v | >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>.>>>^ |
| v | ^ | | v ^ +---------------------------------------------+ v ^ |
| v ^ | | v | ^ | tunnel | v | ^ |
| v | ^ +--------------+ v ^ | _________ | v ^ |
| v ^<<<<<<<<<<<<<<<<<<.<<<. | | _-----_ | | v | ^ |
| v | ^ -- -- -- -- v ^ | |/ v ^ \| | v ^ |
| .>>>.>>>>>>>>>>>>>>>>>>.>>>^ | | v | ^ | | v | ^ |
| v | ^ +--------------+ v ^ | | v ^ | | v ^ |
| v ^ | | v | ^ | | v | ^ | | v | ^ |
| v | ^ | | v ^ | | v ^ | | v ^ |
| v ^ +--------------+ v | ^ +-------------+ v | ^ +-----------------------+ v | ^ |
| v | ^<<<<<<<<<<<<<<<<<<.<<<.<<<<<<<<<<<<<<<<<<<<<.<<<<<<<<<<<<<<<<<<<<<<<<<<<< ^ |
| v -- -- -- -- -- v T ^ -- -- -- -- -- --- -- ^-- -- -- -- -- - ^ |
| >>>>>>>>>>>>>>>>>>>>>>>.>>>.>>>>>>>>>>>>>>>>>>>>>>>>>>>.>>>.>>>>>>>>>>>>>>>>>>>>>^ |
+----------------------+ v | ^ +-----------------------+ v ^ +---------------------+
| v ^ | | v | ^ |
| v | ^ | | v ^ |
| v ^ | | v | ^ |
| v | ^ | | v ^ |
| v ^ +-----------------------+ v | ^ |
| v | ^<<<<<<<<<<<<<<<<<<<<<<<<<<<< ^ |
| v -- -- -- -- -- -- -- -- - ^ |
| >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>^ |
+---------------------------------------+