RC: part A

.gitignore

@@ -1,6 +1,5 @@
 bin/
 doc/
 out/
-deliverable/
 .classpath
 .project

report/.gitignore

@@ -2,3 +2,5 @@
 *.log
 *.out
 *.gz
+*.svg
+*.xcf

report/report.tex

@@ -8,8 +8,8 @@
 
 % Document configuration
 \newcommand{\ClassName}{Δομές δεδομένων}
-\newcommand{\DocTitle}{Λαβύρινθος: Ο Θησέας και ο Μινώταυρος}
-\newcommand{\InstructorName}{Σιάχαλου Σταυρούλα}
+\newcommand{\DocTitle}{Λαβύρινθος: Ο Θησέας και ο Μινώταυρος 1}
+\newcommand{\InstructorName}{Σταυρούλα Σιάχαλου}
 \newcommand{\InstructorMail}{ssiachal@auth.gr}
 \newcommand{\CurrentDate}{\today}
 
@@ -21,6 +21,7 @@
 
 \setFancyHeadLR{\ClassName}{\DocTitle}
 %\setFancyHeadLERO{\ClassName}{\DocTitle}
+%\BottomTitleSpace{8em}
 
 % Document
 % =================
@@ -32,7 +33,306 @@
 %\listoffigures
 %\listoftables
 
-\section{Εισαγωγή} 
+\section{Εισαγωγή}
+Η παρούσα εργασία αφορά τη δημιουργία ενός παιχνιδιού λαβυρίνθου με θέμα \textit{“Μια νύχτα στο μουσείο”}.
+Στο συγκεκριμένο παιχνίδι καλούμαστε να δημιουργήσουμε ένα λαβύρινθο μέσα στον οποίο κινούνται με τυχαίο τρόπο δύο παίχτες, ο Θησέας και ο Μινώταυρος.
+Στόχος του Μινώταυρου είναι να “πιάσει” τον Θησέα και στόχος του Θησέα είναι να βρει όλα τα εφόδια που είναι τυχαία κατανεμημένα στο ταμπλό, πριν ξημερώσει και πριν τον πιάσει ο Μινώταυρος.
+Στο παιχνίδι αυτό υπάρχουν δύο βασικά προβλήματα τα οποία χρειάζεται να λύσουμε.
+Το πρόβλημα της δημιουργίας του λαβύρινθου και το πρόβλημα της λειτουργίας των παιχτών και του υπόλοιπου παιχνιδιού.
+
+\par Κατά την άποψή μας, σε αυτό το πρώτο μέρος της εργασίας, η δημιουργία του ταμπλό είναι το κυριότερο από τα δύο προβλήματα.
+Το ταμπλό αποτελείται από πλακίδια και τοίχους.
+Τα πλακίδια είναι διατεταγμένα σε τετραγωνικό σχήμα και ανάμεσά τους τοποθετούνται οι τοίχοι.
+Το πρόβλημα έγκειται στην επιλογή και τοποθέτηση τοίχων με τέτοιο τρόπο ώστε να πληρούνται οι προδιαγραφές του παιχνιδιού όπως πχ κάθε πλακίδιο να έχει το πολύ δύο τοίχους ή τα εξωτερικά πλακίδια να έχουν τοίχο από την έξω μεριά.
+Μετά από μια πιο λεπτομερή ανάλυση του προβλήματος, διαπιστώσαμε πως οι δοθείσες προδιαγραφές δεν αποτρέπουν τη δημιουργία κλειστών δωματίων, κάτι που θεωρήσαμε άδικο, με αποτέλεσμα, όπως περιγράφουμε και αναλυτικά παρακάτω, \textbf{να προσθέσουμε έναν ακόμη περιορισμό}.
+\textbf{Την αποτροπή κλειστών δωματίων στο ταμπλό}.
+
+\par Το πρόβλημα της λειτουργίας του υπόλοιπου παιχνιδιού έχει να κάνει με τη δημιουργία των παιχτών καθώς και τις κινήσεις τους.
+Οι προδιαγραφές αφορούν περιορισμούς στην κίνηση των παιχτών και τον τρόπο με τον οποίο λειτουργεί το παιχνίδι.
+Για παράδειγμα οι παίχτες δεν μπορούν να περάσουν μέσα από τοίχους, ή οι παίχτες κινούνται κατά ένα πλακίδιο τη φορά κλτ.
+Σε αντίθεση με το πρόβλημα του ταμπλό εδώ η λύση ήταν τετριμμένη.
+
+\section{Παραδοτέα}
+Τα επισυναπτόμενα παραδοτέα αποτελούνται από:
+\begin{itemize}
+    \item Τον \eng{\textbf{root}}κατάλογο στον οποίο υπάρχει και το \eng{project}του\eng{eclipse.}
+    \item Ένας υποκατάλογος \eng{\textbf{src/}}με τον κώδικα της \eng{java,}αποτελούμενο από ένα αριθμό αντικειμένων ενσωματωμένο στο πακέτο \eng{host.labyrinth.}
+    \item Ένας υποκατάλογος \eng{\textbf{out/}} που περιέχει το παραγόμενο \eng{command line jar}του παιχνιδιού.
+    \item Ένας υποκατάλογος \eng{\textbf{doc/}}με την τεκμηρίωση του κώδικα όπως αυτή έχει παραχθεί από τα σχόλια, με το εργαλείο \eng{doxygen.}
+    Το αρχείο ρυθμίσεων του \eng{doxygen}είναι στον \eng{root} με το όνομα \eng{Doxyfile.}
+    Η πλοήγηση στην τεκμηρίωση μπορεί να γίνει ανοίγοντας το αρχείο \eng{doc/index.html}
+    \item Ένας υποκατάλογος \eng{\textbf{report/}} που περιέχει την \textbf{παρούσα αναφορά}. 
+\end{itemize}
+Εκτός από τα επισυναπτόμενα αρχεία διαθέσιμο υπάρχει και το \textbf{\eng{git}αποθετήριο} ολόκληρης της εργασίας \href{https://git.hoo2.net/hoo2/Labyrinth}{εδώ}.
+Αυτό περιέχει τόσο τον κώδικα της εφαρμογής όσο και τον κώδικα της αναφοράς.
+
+\section{Σχεδιαστικές επιλογές}
+Πριν ασχοληθούμε όμως με τα ζητηθέντα αντικείμενα του προγράμματος, θα πρέπει να αναφερθούμε σε ορισμένες δομές που προστέθηκαν, αλλά και κάποιες σχεδιαστικές επιλογές που έγιναν για να απλοποιήσουν τον κώδικα.
+
+\subsection{\eng{Accessor - mutator idiom}}
+Στις προδιαγραφές της εργασίας αφήνεται να εννοηθεί πως ζητείται η χρήση του \eng{\textit{accessor - mutator idiom.}}
+Θα πρέπει να παραδεχτούμε όμως, πως \textbf{θεωρούμε το συγκεκριμένο ιδίωμα ιδιαίτερα προβληματικό}.
+Ο κύριος λόγος είναι πως παραβιάζει θεμελιακά τις αφαιρέσεις προδίδοντας τον εσωτερικό σχεδιασμό του αντικειμένου.
+Ακόμα δίνει πρόσβαση στην εσωτερική δομή του “πίσω από την πλάτη” του αντικειμένου.
+Εν αντιθέτως με το ιδίωμα αυτό, \textbf{τα αντικείμενα που υλοποιούνται ως αφαιρέσεις μπορούν να προσφέρουν μεθόδους που εκτελούν κάποια λειτουργία, κρύβοντας τελείως τις εσωτερικές λεπτομέρειες της υλοποίησης}.
+Αυτός είναι και ο δρόμος που διαλέξαμε για το σχεδιασμό του προγράμματος.
+Η κάθε τάξη του προγράμματός μας προσφέρει δημόσια ένα αριθμό από μεθόδους που είναι απαραίτητες για την εκάστοτε απαιτούμενη λειτουργικότητα και κρύβει όσο καλύτερα γίνεται την εσωτερική υλοποίηση.
+Ενώ λοιπόν υλοποιήσαμε το ζητηθέν \eng{get-set}ζευγάρι για την κάθε μεταβλητή των τάξεων, δεν το χρησιμοποιήσαμε πουθενά μέσα στο πρόγραμμα.
+
+\subsection{Ενοποιημένο σύστημα συντεταγμένων}
+Στις προδιαγραφές της εργασίας περιγράφεται επίσης ένα διπλό σύστημα συντεταγμένων, τόσο για τα πλακίδια όσο και για τα εφόδια.
+Ένα καρτεσιανό που διευθυνσιοδοτεί ως προς δύο άξονες και περιέχει ένα ζευγάρι γραμμής και στήλης και ένα μονοδιάστατο που αποτελείται από τον γραμμικό συνδυασμό των προηγουμένων.
+Το μονοδιάστατο αντικατοπτρίζει και την απεικόνιση στη μνήμη ενός πίνακα 2 διαστάσεων σε \eng{row major order.}
+
+\par Γενικά θεωρούμε πως κάτι τέτοιο δημιουργεί πλεονασμό δεδομένων και επομένως είναι κακή πρακτική.
+Αυτό γιατί μεταξύ άλλων μειονεκτημάτων, που κυρίως αφορά τον πολυνηματικό  προγραμματισμό, οδηγεί και σε προγραμματιστικά λάθη που πιθανώς θα αφήνουν τα δύο συστήματα ασυγχρόνιστα.
+Για να λύσουμε αυτό το πρόβλημα \textbf{δημιουργήσαμε την τάξη \eng{Position,}}στην οποία εσωτερικά χρησιμοποιούμε μόνο το ένα από τα δύο συστήματα, για την ακρίβεια το μονοδιάστατο και ταυτόχρονα παρέχουμε μεθόδους για την πρόσβαση στη θέση και από τα δύο συστήματα.
+Η τάξη μεταξύ άλλων προσφέρει και \textbf{στατικές μεθόδους για τις μετατροπές} προσφέροντας έτσι μια είδους εργαλειοθήκη για την εφαρμογή.
+Για την παρούσα εργασία χρησιμοποιήσαμε την \eng{Position}όπου ήταν δυνατό.
+
+\subsection{Αναβάθμιση της τάξης \eng{Tile}}
+Κατά τον προγραμματισμό του παιχνιδιού παρατηρήσαμε πως τόσο η τάξη \eng{Tile}όσο και η \eng{Supply}έχουν πληροφορίες για τη θέση τους στο ταμπλό.
+Αυτό σημαίνει πως τόσο τα πλακίδια όσο και τα εφόδια ανήκουν στο ταμπλό.
+Ακόμα σημαίνει πως δημιουργούν επιπλέον πλεονασμό σε δεδομένα, καθώς απαιτείται οι συντεταγμένες των εφοδίων να επαναληφθούν μέσα στην \eng{Supply.}
+Κάτι τέτοιο γίνεται αντιληπτό και από τις προδιαγραφές της \eng{Board}η οποία είναι αυτή που περιέχει τους πίνακες αναφορών τόσο των πλακιδίων όσο και των εφοδίων.
+\textbf{Μια πιο διαισθητική προσέγγιση βέβαια θα ήθελε τα εφόδια να ανήκουν στα πλακίδια} και όχι στο ταμπλό.
+Με αυτό τον τρόπο η τάξη \eng{Supply}δεν θα είχε τις επαναλαμβανόμενες πληροφορίες θέσης, αλλά αντίθετα η τάξη \eng{Tile}θα είχε μια επιπρόσθετη πληροφορία για το αν υπάρχει εφόδιο ή όχι.
+
+\par Όπως είναι φυσικό θελήσαμε να υλοποιήσουμε αυτή την προσέγγιση.
+Αν όμως μετακινούσαμε τις αναφορές των εφοδίων στην \eng{Tile}θα αλλοιώναμε τις προδιαγραφές της εκφώνησης.
+Επομένως επιλέξαμε μια μέση οδό.
+Εμπλουτίσαμε την \eng{Tile}με μεθόδους που αφορούν τα εφόδια.
+Αυτές είναι οι:
+\begin{itemize}
+    \item \eng{\textbf{\textit{int hasSupply (Supply[] supplies)}}}\\
+    που δίνει την δυνατότητα να ελέγξουμε αν ένα πλακίδιο έχει κάποιο ενεργό εφόδιο. Και
+    \item \eng{\textbf{\textit{void pickSupply (Supply[] supplies, int supplyId)}}}\\
+    που δίνει την δυνατότητα σε κάποιο παίκτη να “σηκώσει” το εφόδιο.
+\end{itemize}
+Έτσι έχουμε ομοιομορφία με τις αντίστοιχες μεθόδους \eng{\textit{boolean hasWall(int direction)}}και \eng{\textit{int hasWalls()}}της \eng{Tile.}
+\par Ένας παρατηρητικός αναγνώστης θα διαπιστώσει πως οι συναρτήσεις για τα εφόδια είναι αναγκασμένες να πάρουν τον πίνακα αναφορών στα εφόδια ως όρισμα.
+Αυτό είναι το τίμημα που πρέπει να πληρώσουμε προωθώντας τις μεθόδους αυτές στην \eng{Tile.}
+
+
+\section{\eng{Concepts}}
+Η δημιουργία της \eng{Board}αποτέλεσε τον μεγαλύτερο όγκο του κώδικα της παρούσας εργασίας.
+Για να κάνουμε τον κώδικα καθαρότερο αλλά και ευκολότερο στην κατανόηση επινοήσαμε κάποια \eng{\textbf{concepts}.}
+Η ιδέα των \eng{concepts}προέρχεται από την \eng{C++}όπου τα \eng{concepts}είναι ένα είδους \eng{compile time predicate}και εφαρμόζεται στους τύπους δεδομένων.
+Εμείς για την εργασία υλοποιήσαμε κάποια \eng{concepts} σε μορφή συναρτήσεων κατά την εκτέλεση του προγράμματος.
+Τα \eng{concepts}αυτά αφορούν έννοιες σχετικές με την εφαρμογή και έχουν την μορφή \eng{predicate.}
+Μας δίνεται έτσι η δυνατότητα να ελέγχουμε αν κάποια είσοδός ενός \eng{concept}πληροί τις προδιαγραφές του ή όχι.
+Στο σχήμα \ref{fig:concepts} φαίνεται μια οπτικοποιημένη έκδοση τους.
+
+\subsection{Πλακίδιο φρουρός - \textit{\eng{isSentinel()}}}
+\WrapFigure{0.45}{r}{fig:concepts}{images/concepts.png}{
+    Οπτική αναπαράσταση των \eng{concepts}που χρησιμοποιούμε σε ένα ταμπλό $7x7$.
+    Με πράσινο αναπαρίστανται όσα πληρούν κάποιο \eng{concept}και με κόκκινο όσα όχι.
+    Τα πλακίδια με το γκρι χρώμα, είναι τα πλακίδια φρουροί.
+}
+Πρόκειται για \eng{concept}που μας επιτρέπει να ελέγξουμε αν το πλακίδιο είναι \textit{”πλακίδιο φρουρός”}.
+Αν δηλαδή βρίσκεται στα εξωτερικά άκρα του ταμπλό.
+Η υλοποίηση αυτού του \eng{concept}γίνεται μέσω τεσσάρων συναρτήσεων που ελέγχουν χωριστά τις τέσσερεις διευθύνσεις του ταμπλό.
+
+\par Για την παράδειγμα η \eng{\textit{boolean isLeftSentinel (int tileId)}}μας δίνει την δυνατότητα να ελέγξουμε αν το πλακίδιο είναι \textit{πλακίδιο φρουρού} αριστερά του ταμπλό.
+Αυτό είναι χρήσιμο για λειτουργίες όπως για παράδειγμα αν θέλουμε να δούμε μήπως χρειάζεται να τοποθετηθεί εξωτερικός τοίχος αριστερά του πλακιδίου.
+Αντίστοιχα υπάρχουν και οι υπόλοιπες συναρτήσεις για τις υπόλοιπες διευθύνσεις.
+
+\subsection{Διασχίσιμη διεύθυνση - \textit{\eng{isWalkable()}}}
+Πρόκειται για \eng{predicate}που μας επιτρέπει να ελέγξουμε αν μια διεύθυνση σε κάποιο πλακίδιο είναι \textit{”διασχίσημη διεύθυνση”}.
+Αν δηλαδή κάποιος παίκτης μπορεί να κινηθεί σε αυτή.
+Για να ισχύει κάτι τέτοιο θα πρέπει:
+\begin{itemize}
+    \item Η διεύθυνση να μην έχει τοίχο.
+    \item Η διεύθυνση να μην είναι η “Κάτω” διεύθυνση του πλακιδίου εισόδου στο λαβύρινθο.
+\end{itemize}
+
+\subsection{Χτίσιμη διεύθυνση - \textit{\eng{isWallableDir()}}}
+Πρόκειται για \eng{predicate}που μας επιτρέπει να ελέγξουμε αν μια διεύθυνση κάποιου πλακιδίου είναι \textit{”χτίσιμη διεύθυνση”}.
+Αν δηλαδή μπορούμε να τοποθετήσουμε τοίχο στη διεύθυνση αυτή.
+Για να είναι μια διεύθυνση χτίσιμη θα πρέπει:
+\begin{itemize}
+    \item Η διεύθυνση να είναι \textit{διασχίσιμη}.
+    \item Το γειτονικό πλακίδιο σε αυτή τη διεύθυνση να μην περιέχει ήδη τον μέγιστο επιτρεπτό αριθμό τοίχων.
+    \item Ο τοίχος να μην δημιουργεί κάποιο κλειστό δωμάτιο.\\
+\end{itemize}
+Αυτή η τελευταία \textbf{απαίτηση δεν υπάρχει στις προδιαγραφές} και την παίρνουμε υπόψιν μόνο αν ο χρήστης την έχει ζητήσει από την γραμμή εντολών.
+Ο λόγος είναι γιατί ο υπολογισμός της κοστίζει και αυτό μπορεί να μην παίζει ρόλο για ταμπλό μεγέθους $15x15$, αλλά αν ζητηθεί κάποιο πολύ μεγαλύτερο τότε ο χρόνος είναι υπολογίσιμος.
+Φυσικά στον κώδικα κάνουμε χρήση αυτού του \eng{concept}μόνο κατά τη δημιουργία του ταμπλό, με αποτέλεσμα να μην επιβαρύνεται καθόλου η λειτουργία του προγράμματος κατά τη διάρκεια του παιχνιδιού.
+Αναφερόμαστε αναλυτικά σε αυτό τον αλγόριθμο στην ενότητα \ref{sec:isRoomCreator}
+
+\subsection{Χτίσιμο πλακίδιο - \textit{\eng{isWallable()}}}
+Πρόκειται για \eng{predicate}που μας επιτρέπει να ελέγξουμε αν κάποιο πλακίδιο είναι \textit{”χτίσιμo πλακίδιο”}.
+Αν δηλαδή υπάρχει κάποια πλευρά του πλακιδίου στην οποία μπορούμε να τοποθετήσουμε τοίχο.
+Για να ισχύει αυτό θα πρέπει:
+\begin{itemize}
+    \item Το πλακίδιο να μην έχει ήδη τον μέγιστο επιτρεπτό αριθμό τοίχων.
+    \item Να υπάρχει τουλάχιστον μία \textit{χτίσιμη διεύθυνση} στο πλακίδιο.
+\end{itemize}
+
+\subsection{Δημιουργός κλειστού δωματίου - \textit{\eng{isRoomCreator()}}} \label{sec:isRoomCreator}
+Όπως αναφέραμε και παραπάνω οι προδιαγραφές της εργασίας δεν αποτρέπουν τη δημιουργία κλειστών δωματίων.
+Για το λόγο αυτό υλοποιήσαμε ένα αλγόριθμο που ανιχνεύει την πιθανότητα δημιουργίας κλειστών δωματίων του οποίου η ενεργοποίηση γίνεται κατόπιν επιλογής του χρήστη από τη γραμμή εντολών.
+
+\par Ένας αλγόριθμος για να είναι λειτουργικός χρειάζεται δεδομένα.
+Στη δική μας περίπτωση τα δεδομένα είναι οι τοίχοι.
+Θέλαμε λοιπόν ένα τρόπο αναπαράστασης των τοίχων που να βολεύει για το συγκεκριμένο πρόβλημα.
+Η λύση που χρησιμοποιήσαμε συνοψίζεται στα εξής:
+\begin{itemize}
+    \item Οι γωνίες των πλακιδίων ονομάζονται κόμβοι και η θέση τους αναπαρίστανται μονοδιάστατα σαν διεύθυνση σε \eng{row major order.}
+    \item Ο κάθε κόμβος αποτελεί τον κόμβο-γωνία \eng{(vertex)}ενός γράφου.
+    \item Ο κάθε τοίχος αναπαρίσταται ως ακμή στον γράφο.
+\end{itemize}
+Για παράδειγμα στο σχήμα \ref{fig:graph}, που φαίνεται και ένα παράδειγμα αναπαράστασης, ο τοίχος αριστερά του πλακιδίου `3` αναπαρίσταται ως η ακμή `(4,8)`.
+\InsertFigure{0.6}{fig:graph}{images/graph.png}{
+    \\(α) Διευθυνσιοδότηση πλακιδίων(τετραγωνάκια) και κόμβων(σφαίρες) ενός ταμπλό $3x3$.\\
+    (β) Ένας συνεκτικός γράφος που προκύπτει από το (α) ξεκινώντας από τον τοίχο (7, 11).
+    Ο τοίχος είναι αυτός για τον οποίο θέλουμε να διαπιστώσουμε αν δημιουργεί κλειστό δωμάτιο.
+}
+
+\par Για τον αλγόριθμο υλοποιήσαμε δύο τάξεις.
+Την \eng{\textbf{Edge}}που δημιουργεί ζευγάρια κόμβων ώστε να μπορεί να αποθηκεύσει τον κάθε τοίχο(ακμή) και την \eng{\textbf{Graph}}που προσφέρει λειτουργίες δημιουργίας συνεκτικού γράφου λαμβάνοντας ως είσοδο τοίχους(ακμές).
+
+\par Η λειτουργία του είναι απλή.
+Κάθε φορά που ελέγχουμε αν μία διεύθυνση πλακιδίου είναι \textit{χτίσιμη}, \textbf{δημιουργούμε το μεγαλύτερο δυνατό συνεκτικό γράφο που περιέχει τον εν λόγο τοίχο} και όλους τους ήδη τοποθετημένους τοίχους.
+Αν στον γράφο που προκύπτει υπάρχει κάποιος κόμβος περισσότερες από μία φορές, δηλαδή ο γράφος δεν είναι απλός, τότε αυτό σημαίνει πως στον εν λόγο κόμβο μπορούμε να πάμε ακολουθώντας τοίχους από τουλάχιστον δύο κατευθύνσεις.
+Άρα το ταμπλό περιέχει κάποιο κλειστό δωμάτιο.
+Αφού τον αλγόριθμο τον εκτελούμε για κάθε πιθανή \textit{χτίσιμη διεύθυνση}, τότε ο τοίχος που προκαλεί το κλειστό δωμάτιο είναι αυτός που ελέγχουμε την εκάστοτε στιγμή.
+
+\par Για την λειτουργία του αλγόριθμου χρειαζόμαστε όλους τους τοίχους που είναι ήδη τοποθετημένοι στο ταμπλό στη μορφή \eng{Edge.}
+Γιαυτό προσθέσαμε στην τάξη \eng{Board} μια λίστα αναφορών \eng{(ArrayList)} και σε αυτήν αποθηκεύουμε κάθε τοίχο που δημιουργούμε.
+Τον αλγόριθμο μπορούμε να τον ενεργοποιήσουμε αν περάσουμε στο πρόγραμμα ως επιλογή το όρισμα \eng{\texttt{-{}-norooms}} από τη γραμμή εντολών.
+
+\par Δυστυχώς η κωδικοποίηση που χρησιμοποιούμε εδώ δεν ταιριάζει με αυτή της υπόλοιπης εφαρμογής.
+Αυτό έχει σαν αποτέλεσμα να πρέπει να δημιουργούμε τον γράφο κάθε φορά.
+Αυτό έχει κόστος σε χρόνο.
+Για την ακρίβεια $O(N^{2}logN)$, όπου $Ν$, ο συνολικός αριθμός πλακιδίων του ταμπλό.
+Αυτό το κόστος αφορά τον έλεγχο του κάθε πλακιδίου.
+Για όλο το ταμπλό το κόστος είναι $O(N^{4}logN)$.
+Φυσικά θα μπορούσαμε να χρησιμοποιήσουμε υπομνηματισμό και να αποθηκεύουμε τους γράφους
+Όμως λόγο του ότι η επιβάρυνση λαμβάνει χώρα μόνο μία φορά κατά την εκκίνηση, σε συνδυασμό με το μικρό μέγεθος του ταμπλό, αποφασίσαμε να μην προχωρήσουμε σε περαιτέρω βελτιστοποίηση.
+
+
+\section{Υλοποίηση}
+Για την μεταγλώττιση της εφαρμογής, απαιτείται \eng{java} έκδοση 8 ή και μεταγενέστερη καθώς έχουμε κάνει χρήση \eng{lambdas.}
+Όσο αφορά την υλοποίηση, εκτός από τα ζητηθέντα αντικείμενα υλοποιήσαμε και τα παρακάτω.
+\begin{itemize}
+    \item \eng{\textbf{Const}}\\
+    Το αντικείμενο αυτό περιέχει σταθερές για όλη την εφαρμογή.
+    \item \eng{\textbf{Session}}\\
+    Το αντικείμενο αυτό περιέχει όλες τις τιμές της εφαρμογής που αποτελούν ρυθμίσεις ή επιλογές, όπως πχ το μέγεθος του ταμπλό, τον αριθμό των εφοδίων κτλ.
+    \item \eng{\textbf{Direction}}\\
+    Το αντικείμενο αυτό λειτουργεί σαν \eng{C++ enumerator}και παρέχει ονοματολογία στις διευθύνσεις που χρησιμοποιούμε στην εφαρμογή.
+    \item \eng{\textbf{DirRange}}\\
+    Ομοίως ένα βοηθητικό αντικείμενο αυτή τη φορά για την αυτόματη δημιουργία διευθύνσεων σε βρόχους επανάληψης.
+    \item \eng{\textbf{Edge}}\\
+    Το αντικείμενο αυτό όπως είδαμε και στην ενότητα \ref{sec:isRoomCreator}, λειτουργεί ως αναπαράσταση των τοίχων με τη μορφή ακμών ενός γράφου.
+    Προσφέρει \eng{constructor} που δέχεται για ορίσματα συντεταγμένες από πλακίδια και διευθύνσεις.
+    Με αυτό τον τρόπο λειτουργεί ως διεπαφή ανάμεσα στην κωδικοποίηση που χρησιμοποιείται στην υπόλοιπη εφαρμογή και στην κωδικοποίηση που χρησιμοποιείται για την εύρεση κλειστών δωματίων.
+    \item \eng{\textbf{Graph}}\\
+    Το αντικείμενο αυτό υλοποιεί λειτουργίες ενός συνεκτικού γράφου.
+    Ο \eng{constructor}της τάξης δέχεται ως όρισμα μια ακμή και στην ουσία δημιουργεί τους 2 πρώτους κόμβους.
+    Οι βασικές λειτουργίες είναι η \eng{\textit{attach()}}η οποία δέχεται μια ακμή και αν κάποιος κόμβος της ακμής ανήκει ήδη στο γράφο τότε τοποθετεί και τον άλλο.
+    Και η \eng{\textit{count()}}η οποία δέχεται ένα κόμβο και μετράει πόσες φορές ο κόμβος αυτός περιέχεται στον γράφο.
+    \item \eng{\textbf{Position}}\\
+    Το αντικείμενο αυτό χρησιμοποιείται ως ένα κοινό σύστημα συντεταγμένων για την εφαρμογή.
+    \item \eng{\textbf{Range}}\\
+    Το αντικείμενο χρησιμοποιείται για να δημιουργεί εύρη τιμών.
+    Για παράδειγμα ο κώδικας παρακάτω δημιουργεί ένα \eng{range} με όλες τις διευθύνσεις.
+    \selectlanguage{english}
+    \begin{verbatim}
+    Range dirs = new Range(DirRange.Begin, DirRange.End, DirRange.Step);
+    for (int dir = dirs.get() ; dir != Const.EOR ; dir = dirs.get()) {
+        // use dir
+    }
+    \end{verbatim}
+    \selectlanguage{greek}
+    \item \eng{\textbf{ShuffledRange}}\\
+    Το αντικείμενο αυτό χρησιμοποιείται για να δημιουργεί “τυχαίως ανακατεμένα” εύρη τιμών.
+    Η τάξη αυτή κληρονομεί την \eng{Range}και προσθέτει τη λειτουργία του τυχαίου ανακατέματος των τιμών.
+    Για παράδειγμα παρακάτω δημιουργούμε μια τυχαία σειρά από όλα τα πλακίδια του ταμπλό.
+    \selectlanguage{english} \begin{verbatim}
+    ShuffledRange rand = new ShuffledRange(0, N*N);
+    for (int tileId =rand.get(); tileId!=Const.EOR ; tileId=rand.get()){
+        // use tileId
+     }
+    \end{verbatim} \selectlanguage{greek}
+\end{itemize}
+Τόσο η \eng{Range}όσο και η \eng{ShuffledRange}έχουν μια μέθοδο \eng{\textit{get()}}η οποία επιστρέφει και αφαιρεί το πρώτο στοιχείο από το \eng{range}.
+Όταν το \eng{range}είναι άδειο τότε επιστρέφει την τιμή φρουρό \eng{EOR - End of Range.}
+
+\par Τα υπόλοιπα αντικείμενα είναι τα ζητηθέντα.
+Σε αυτά δεν έχουμε αλλάξει τις προδιαγραφές με εξαίρεση τις μεθόδους \eng{\textit{createBoard()}}και \eng{\textit{createSupply()}}στις οποίες προσθέσαμε σαν ορίσματα τα πλακίδια του Θησέα και του Μινώταυρου.
+Ο λόγος είναι γιατί για τα εφόδια, θέλουμε να γνωρίζουμε σε ποια πλακίδια είναι οι παίχτες, ώστε να μην τοποθετήσουμε εκεί κάποιο εφόδιο.
+Δε για το ταμπλό, γιατί θέλουμε να ξέρουμε σε ποια πλακίδια θα τοποθετήσουμε τους παίχτες.
+
+
+\section{Εκτελέσιμο}
+Όπως αναφέραμε και στην παράγραφο με τα παραδοτέα, σε αυτά υπάρχει και το παραγόμενο εκτελέσιμο για την γραμμή εντολών.
+Πρόκειται για ένα \eng{jar}αρχείο το οποίο μπορεί κάποιος να εκτελέσει σε ένα τερματικό, μέσω της εντολής \eng{\texttt{java -jar labyrinth}}.
+\InsertFigure{0.5}{fig:executable}{images/screenshot.png}{
+    Στιγμιότυπο από την εκτέλεση του προγράμματος σε \eng{interactive mode}και με αποφυγή κλειστών δωματίων.
+    Η εντολή που χρησιμοποιήθηκε είναι \eng{\texttt{java -jar labyrinth -i -{}-norooms}}
+}
+Στον κώδικά μας χρησιμοποιούμε \eng{asserions}ώστε να ελέγξουμε την είσοδο και τις επιλογές του χρήστη.
+Επομένως αν κάποιος θέλει να πειραματιστεί με τις επιλογές καλό θα ήταν να τα ενεργοποιήσει στην \eng{VM}της \eng{java}με την παράμετρο \eng{\texttt{-ea}.}
+Σε αυτή την περίπτωση θα μπορούσε να εκτελέσει \eng{\texttt{java -ea -jar labyrinth -i --norooms ...etc}}
+
+\par Το παραγόμενο \eng{jar}παρέχει ένα αριθμό από επιλογές-ορίσματα τα οποία ελέγχουν την λειτουργία του παιχνιδιού.
+Τις επιλογές αυτές μπορούμε να δούμε και από την γραμμή εντολών απλώς εκτελώντας την εντολή \eng{\texttt{java -jar labyrinth -h}}.
+Στο σχήμα \ref{fig:executable_help} μπορούμε να δούμε ένα στιγμιότυπο με τις διαθέσιμες επιλογές-ορίσματα.
+Αναλυτικά, εκτός από την \eng{\texttt{-h}}αυτές είναι:
+\begin{itemize}
+    \item \eng{\textbf{-i}}ή \eng{\textbf{-{}-interactive}}\\
+    Αυτό το όρισμα ενεργοποιεί το \eng{\textit{“interactive mode”.}}
+    Πρόκειται για λειτουργία κατά την οποία το παιχνίδι μετά από κάθε γύρο σταματά και περιμένει είσοδο από τον χρήστη για να προχωρήσει στον επόμενο.
+    Αν αυτή η λειτουργία δεν είναι ενεργοποιημένη, τότε το παιχνίδι εκτελείται μονομιάς και στην έξοδο εκτυπώνονται όλοι οι γύροι αμέσως μετά την είσοδο της εντολής.
+    \textit{Αυτή η επιλογή είναι απενεργοποιημένη ως προεπιλογή}.
+    
+    \item \eng{\textbf{-{}-norooms}}\\
+    Αυτό το όρισμα ενεργοποιεί την λειτουργία της εύρεσης και αποτροπής των κλειστών δωματίων.
+    Αν δεν γίνει χρήση αυτή της επιλογής, τότε η λειτουργία αυτή είναι απενεργοποιημένη ως προεπιλογή\footnote{Συνίσταται ανεπιφύλακτα η χρήση αυτής της επιλογής}.
+    \InsertFigure{0.9}{fig:executable_help}{images/screenshot_help.png}{
+        Οι διαθέσιμες επιλογές και οι τρόποι με τους οποίους μπορούμε να εκτελέσουμε το παιχνίδι
+    }
+    
+    \item \eng{\textbf{-b}}ή \eng{\textbf{-{}-board}}\\
+    Αυτό το όρισμα απαιτείται να ακολουθηθεί από ένα θετικό ακέραιο που περιγράφει το επιθυμητό μέγεθος της πλευράς του ταμπλό.
+    Πχ:\\[1.2ex]
+    \eng{\texttt{java -jar labyrinth -b 11}}\\[1.2ex]
+    Αν ο χρήστης δεν χρησιμοποιήσει την επιλογή τότε το προεπιλεγμένο μέγεθος είναι 15.
+    
+    \item \eng{\textbf{-s}}ή \eng{\textbf{-{}-supplies}}\\
+    Αυτό το όρισμα απαιτείται να ακολουθηθεί από ένα θετικό ακέραιο που περιγράφει τον επιθυμητό αριθμό των εφοδίων για το παιχνίδι.
+    Πχ:\\[1.2ex]
+    \eng{\texttt{java -jar labyrinth -b 11 -s 7}}\\[1.2ex]
+    Αν ο χρήστης δεν χρησιμοποιήσει την επιλογή τότε ο προεπιλεγμένος αριθμός είναι 4.
+    
+    \item \eng{\textbf{-r}}ή \eng{\textbf{-{}-rounds}}\\
+    Αυτό το όρισμα απαιτείται να ακολουθηθεί από ένα θετικό ακέραιο που περιγράφει τον επιθυμητό αριθμό γύρων μέχρι να ολοκληρωθεί το παιχνίδι.
+    Πχ:\\[1.2ex]
+    \eng{\texttt{java -jar labyrinth -r 200 -s 7}}\\[1.2ex]
+    Αν ο χρήστης δεν χρησιμοποιήσει την επιλογή τότε ο προεπιλεγμένος αριθμός είναι 100.
+\end{itemize}
+
+
+\section{Παρατηρήσεις}
+Σε αυτό το σημείο θα θέλαμε να παρατηρήσουμε και μια σχεδιαστική αβλεψία.
+Το κομμάτι του κώδικα που δημιουργεί χρήστες καθώς και ορισμένες επιλογές που τους αφορούν, όπως η θέση τους στο ταμπλό, οι κινήσεις κ.α., δεν είναι υλοποιημένο με τον καλύτερο δυνατό τρόπο.
+Θα θέλαμε να ήταν πιο γενικό και παραμετροποιήσιμο.
+Ο λόγος που δεν είναι, έχει να κάνει αρκετά και με την υποψία μας, πως αυτό το υποσύστημα θα χρειαστεί να αλλάξει αρκετά στις επόμενες εργασίες.
+Αν εκτιμήσαμε λανθασμένα, τότε είναι απλώς κρίμα.
+
+\par Μια τεχνική που δεν χρησιμοποιήσαμε αλλά μας προβλημάτισε αν θα το κάναμε ή όχι ήταν τα \eng{generics.}
+Η αρχική μας σκέψη, καθώς ήμαστε επηρεασμένοι ξεκάθαρα από την \eng{C++,}ήταν οι τάξεις \eng{Edge, Graph, Range}και \eng{ShuffledRange}να είναι \eng{generics.}
+Το γεγονός όμως ότι τα αντικείμενα αυτά θα τα χρησιμοποιούσαμε μονάχα σε αυτή την εργασία, μας απέτρεψε.
+Μια απλή υλοποίηση μόνο για \eng{int}ήταν αρκετή και κάτι διαφορετικό θα εισήγαγε περιττή πολυπλοκότητα.
+
+\par Κλείνοντας θα θέλαμε να παρατηρήσουμε πως η παρούσα υλοποίηση θεωρούμε ότι ήταν μια προσπάθεια να ισορροπήσουμε μεταξύ των ζητηθέντων και μεταξύ πρακτικών που ίσως μας βοηθήσουν στη συνέχεια για συγγραφή ευκολότερου και καθαρότερου κώδικα.
+Γενικά πιστεύουμε πως \textbf{αν ο χρήστης μιας βάσης κώδικα έχει τη δυνατότητα να χρησιμοποιήσει λανθασμένα τον κώδικα, κάποια στιγμή θα το κάνει.}
+Ακόμα και αν ο χρήστης είναι ο ίδιος ο αρχικός συντάκτης του κώδικα.
+Για το λόγο αυτό προσπαθήσαμε να περιορίσουμε, όπου αυτό δεν ήταν αντίθετο με τα ζητούμενα, την δυνατότητα της λανθασμένης χρήσης εισάγοντας αρκετά επιπλέον αντικείμενα και δομές ως εργαλεία για την εφαρμογή.
+Τέτοια για παράδειγμα είναι η τάξη \eng{Position}ή η αποφυγή των \eng{setters}κτλ.
+Ελπίζουμε να μην θεωρηθούν υπερβολικά.
 
 % References
 % ============================

src/host/labyrinth/Board.java

@@ -1,11 +1,13 @@
 /**
  * @file Board.java
  *
- * @author Christos Choutouridis AEM:8997
- * @email  cchoutou@ece.auth.gr
+ * @author
+ *    Christos Choutouridis
+ *    <cchoutou@ece.auth.gr>
+ *    AEM:8997
  */
 
-package net.hoo2.auth.labyrinth;
+package host.labyrinth;
 
 import java.util.ArrayList;
 import java.util.function.IntFunction;
@@ -40,6 +42,7 @@ class Board {
     */
    Board(int N, int S) {
       assert (N%2 != 0) : "Board's size has to be an odd number.";
+      assert (S <= (N*N-2)) : "At least 2 tiles has to be without supplies.";
       this.N   = Session.boardSize = N;
       this.S   = S;
       this.W   = 0;
@@ -131,7 +134,14 @@ class Board {
    }
 
    /**
-    * Predicate to check if a direction is Walkable
+    * Predicate to check if a direction is Walkable.
+    * 
+    * A `walkable` direction is a tile direction where:
+    * <ul>
+    * <li>The wall is not the DOWN wall from tile (0, 0).
+    * <li>There is not already a wall in the desired direction. (Implies no sentinel tile).
+    * </ul>
+    *
     * @param tileId     The starting tileId.
     * @param direction  The desired direction.
     * @return           True if it is walkable.
@@ -142,9 +152,16 @@ class Board {
    }
 
    /**
-    * Predicate to check if a direction is Walkable
+    * Predicate to check if a direction is Walkable.
+    *
+    * A `walkable` direction is a tile direction where:
+    * <ul>
+    * <li>The wall is not the DOWN wall from tile (0, 0).
+    * <li>There is not already a wall in the desired direction. (Implies no sentinel tile).
+    * </ul>
+    *
     * @param row        Row position of the starting tile.
-    * @param column     Column position of the starting tile.
+    * @param col        Column position of the starting tile.
     * @param direction  The desired direction.
     * @return           True if it is walkable.
     */
@@ -175,7 +192,7 @@ class Board {
     * @return  A random direction;
     */
    int dice () {
-      ShuffledRange d = new ShuffledRange(Direction.Begin, Direction.End, Direction.Step);
+      ShuffledRange d = new ShuffledRange(DirRange.Begin, DirRange.End, DirRange.Step);
       return d.get();
    }
 
@@ -205,6 +222,13 @@ class Board {
     */
    Supply[] getSupplies() { return supplies; }
 
+   /**
+    * @note Use it with care. Any use of this function results to what Sean Parent calls "incidental data-structure".
+    * <a href="https://github.com/sean-parent/sean-parent.github.io/blob/master/better-code/03-data-structures.md"> see also here</a>
+    * @return  Reference to inner walls array.
+    */
+   ArrayList<Edge> getWalls() { return walls; }
+
    void setN(int N)  { this.N = N; }
    void setS(int S)  { this.S = S; }
    void setW(int W)  { this.W = W; }
@@ -221,6 +245,14 @@ class Board {
     * Any call to this function will probably add memory for the garbage collector.
     */
    void setSupplies(Supply[] supplies)   { this.supplies= supplies; }
+
+   /**
+    * @param walls   Reference to walls that we want to act as replacement for the inner walls vector.
+    * @note    Use with care.
+    * Any call to this function will probably add memory for the garbage collector.
+    */
+   void setWalls (ArrayList<Edge> walls) { this.walls= walls; }
+
    /** @} */
 
 
@@ -269,33 +301,32 @@ class Board {
    /**
     * Predicate to check if a wall creates a closed room.
     *
-    * This algorithm has a complexity of O(N^2logN) where N represents the total
+    * This algorithm has a complexity of @f$ O(N^2logN) @f$ where N represents the total
     * number of tiles.
     * It should be used with care.
     *
-    * @param tileId     The tileId of the wall where the wall is.
-    * @param direction  The wall's relative direction from the tile. 
+    * @param tileId     The tileId of the wall.
+    * @param direction  The wall's relative direction. 
     * @return           True if the wall creates a closed room, false otherwise.
     */
-   private boolean makesClosedRoom (int tileId, int direction) {
-      // Get a snapshot list of all the walls (all the walls on the board)
+   private boolean isRoomCreator (int tileId, int direction) {
+      // Clone the list of all the walls locally.
       ArrayList<Edge> w = new ArrayList<Edge>();
       for (Edge it : walls)
          w.add(new Edge(it));
-      // Create a graph from the current wall(edge)
-      // and populate the graph with all the edges we can attach.
+      // Create the largest possible coherent graph from the list of walls(edges)
       Graph g = new Graph(new Edge(tileId, direction));
       int size;
       do {
          size = w.size();                       // mark the size (before the pass)
-         for (int i =0, S=w.size() ; i<S ; ++i)
-            if (g.attach(w.get(i))) {           // Can we attach the edge(wall) to the graph ?
-               w.remove(i);                     // If yes remove it from the wall list
+         for (int i =0, S=w.size() ; i<S ; ++i) // for each edge(wall) on the local wall list
+            if (g.attach(w.get(i))) {           // can we attach the edge(wall) to the graph ?
+               w.remove(i);                     // if yes remove it from the local wall list
                --i; --S;                        // decrease iterator and size to match ArrayList's new values
             }
       } while (size != w.size());               // If the size hasn't change(no new graph leafs) exit
 
-      // Search if a vertex is attached more than once.
+      // Search if a vertex is attached to the graph more than once.
       // This means that there is at least 2 links to the same node
       // so the graph has a closed loop
       for (Edge it : walls) {
@@ -325,9 +356,7 @@ class Board {
     */
    private boolean isWallableDir (int tileId, int direction) {
       // Check list
-      if (tileId == 0 && direction == Direction.DOWN)
-         return false;
-      if (tiles[tileId].hasWall(direction))
+      if (!isWalkable(tileId, direction))
          return false;
       switch (direction) {
          case Direction.UP:
@@ -343,7 +372,7 @@ class Board {
             if (tiles[rightTileId.apply(tileId)].hasWalls() >= Const.maxTileWalls)  return false;
             break;
       }
-      if (Session.loopGuard && makesClosedRoom(tileId, direction))
+      if (Session.loopGuard && isRoomCreator(tileId, direction))
          return false;
       return true;
    }
@@ -365,8 +394,8 @@ class Board {
          return false;
       if (tiles[tileId].hasWalls() >= Const.maxTileWalls)
          return false;
-      Range dirs = new Range(Direction.Begin, Direction.End, Direction.Step);
-      for (int dir ; (dir = dirs.get()) != Const.noTileId ; )
+      Range dirs = new Range(DirRange.Begin, DirRange.End, DirRange.Step);
+      for (int dir = dirs.get() ; dir != Const.EOR ; dir = dirs.get())
          if (isWallableDir(tileId, dir))
             return true;
       return false;
@@ -388,6 +417,7 @@ class Board {
          boolean right = isRightSentinel(i);
          wallCount += ((up?1:0) + (down?1:0) + (left?1:0) + (right?1:0));
          tiles[i] = new Tile (i, up, down, left, right);
+         // If we have loopGuard enable we populate walls also.
          if (Session.loopGuard) {
             if (up)     walls.add(new Edge(i, Direction.UP));
             if (down)   walls.add(new Edge(i, Direction.DOWN));
@@ -404,14 +434,16 @@ class Board {
     */
    private void createInnerWall(int tileId) {
       // Randomly pick a wallable direction in that tile.
-      ShuffledRange randDirections = new ShuffledRange(Direction.Begin, Direction.End, Direction.Step);
+      ShuffledRange randDirections = new ShuffledRange(DirRange.Begin, DirRange.End, DirRange.Step);
       int dir;
       do
          dir = randDirections.get();
       while (!isWallableDir(tileId, dir));
+      // Add wall to tileId and the adjacent tileId
       Position neighbor = new Position(Position.toRow(tileId), Position.toCol(tileId), dir);
       tiles[tileId].setWall(dir);
       tiles[neighbor.getId()].setWall(Direction.opposite(dir));
+      // If we have loopGuard enable we populate walls also.
       if (Session.loopGuard)
          walls.add(new Edge(tileId, dir));
    }
@@ -419,7 +451,6 @@ class Board {
    /**
     * This utility creates the inner walls of the board.
     *
-    * @param walls   The number of walls to create   
     * @return        The number of walls failed to create.
     */
    private int createInnerWalls () {
@@ -427,7 +458,7 @@ class Board {
       for (int tileId, i =0, walls =0, shuffleMark =0 ; true ; ) {
          // randomly pick a wallable tile.
          do {
-            if ((tileId = randTiles.get())== Const.noTileId) {
+            if ((tileId = randTiles.get())== Const.EOR) {
                if (i == shuffleMark)   // Wallable tiles exhausted.
                   return walls;
                else {                  // Re-shuffle and continue.

src/host/labyrinth/Common.java

@@ -1,10 +1,12 @@
 /**
  * @file Common.java
  *
- * @author Christos Choutouridis AEM:8997
- * @email  cchoutou@ece.auth.gr
+ * @author
+ *    Christos Choutouridis
+ *    <cchoutou@ece.auth.gr>
+ *    AEM:8997
  */
-package net.hoo2.auth.labyrinth;
+package host.labyrinth;
 
 import java.util.ArrayList;
 import java.util.Collections;
@@ -16,6 +18,7 @@ class Const {
    static final int maxTileWalls = 2;  /**< Number of maximum walls for each tile on the board */
    static final int noSupply =-1;      /**< Number to indicate the absent of supply */
    static final int noTileId =-1;      /**< Number to indicate wrong tileId */
+   static final int EOR =-1;           /**< Number to indicate the End Of Range */
 }
 /**
  * Application wide object to hold settings like values for the session.
@@ -36,16 +39,31 @@ class Direction {
    static final int  RIGHT =3;   /**< East direction */
    static final int  DOWN  =5;   /**< South direction */
    static final int  LEFT  =7;   /**< West direction */
-   static final int  Begin =1;   /**< Iterator style begin of range direction (starting north) */
-   static final int  End   =8;   /**< Iterator style end of range direction (one place after the last) */
-   static final int  Step  =2;   /**< Step for iterator style direction */
 
    /**
-    * Utility to get the opposite 
+    * Utility to get the opposite direction.
     * @param direction  Input direction
     * @return           The opposite direction
     */
-   static int opposite (int direction) { return (direction+4)%End; }
+   static int opposite (int direction) { return (direction+4)%DirRange.End; }
+}
+
+/**
+ * Helper C++ like enumerator class for direction ranged loops.
+ *
+ * We can make use of this in loops like:
+ * <pre>
+ * for (int i=DirRange.Begin ; i<DirRange.End ; i += DirRange.Step) { }
+ * 
+ * or
+ * 
+ * Range directions = new Range(DirRange.Begin, DirRange.End, DirRange.Step);
+ * </pre>
+ */
+class DirRange {
+   static final int  Begin =1;   /**< Iterator style begin of range direction (starting north) */
+   static final int  End   =8;   /**< Iterator style end of range direction (one place after the last) */
+   static final int  Step  =2;   /**< Step for iterator style direction */
 }
 
 /**
@@ -55,7 +73,7 @@ class Direction {
  * Position is a helper class to enable us cope with the redundant position data (id and coordinates).
  * This class provide both static conversion functionalities between id and coordinates
  * and data representation in the coordinates system.
- * For clarity we adopt a row-column naming convention.
+ * For clarity we adopt a tileId convention.
  */
 class Position {
 
@@ -176,7 +194,7 @@ class Range {
    int get () {
       if (!numbers.isEmpty())
          return numbers.remove(0);
-      return Const.noTileId;
+      return Const.EOR;
    }
 
    /** @name protected data types */
@@ -219,18 +237,21 @@ class ShuffledRange extends Range {
  * This class is the wall representation we use in the room preventing algorithm.
  * In this algorithm we represent the crosses between tiles as nodes (V) of a graph and the
  * walls as edges. So for example:
- * 
- *                  _ V = 15 
- *                 /
- *    +---+---+---+     We have a 4x4=16 vertices board(nodes) and 14 edges(walls).
- *    |           |     To represent the vertices on the board we use the
- *    +   +---+   +     same trick as the tileId.
- *    |       |   |     The edges are represented as vertices pairs.
- *    +   +   +   + <.
- *    |   |       |   \_ V = 7
- *    +   +---+---+
- *    ^           ^
- *   V = 0      V = 3
+ * <pre>
+ *   12--13--14---15
+ *    |           |
+ *    8   9--10   11
+ *    |       |   |
+ *    4   5   6   7
+ *    |   |       |
+ *    0   1---2---3
+ * </pre>
+ * In this example we have a 4x4=16 vertices board(nodes) and 14 edges(walls).
+ * To represent the vertices on the board we use the same trick as the tileId
+ *
+ * V = Row*(N+1) + Column, where N is the board's tile size.
+ *
+ * The edges are represented as vertices pairs. For example (0, 4) or (13, 14).
  *
  * @note
  *    Beside the fact that we prefer this kind of representation of the walls in
@@ -242,7 +263,7 @@ class ShuffledRange extends Range {
  */
 class Edge {
    /**
-    * This constructor as as the interface between the application's wall
+    * This constructor acts as the interface between the application's wall
     * representation and the one based on graph.
     * @param tileId     The tile id of the wall.
     * @param direction  The direction of the tile where the wall should be.
@@ -286,13 +307,15 @@ class Edge {
  * @brief
  *    Provides a graph functionality for the room preventing algorithm.
  * We use a graph to represent the wall structure of the walls. This way
- * is easy to find any closed loops. Using graph we transform the problem
- * of the closed room in the problem of finding a non simple graph.
+ * its easy to find any closed loops. Using graph we transform the problem
+ * of the closed room into the problem of finding a non simple graph.
  *
- * If the board has non connected wall structure then we need more than
- * one graph to represent it.
+ * If the board has non connected wall structure then we would need a non
+ * coherent graph to represent it. This class provides constroctors and
+ * methods to create coherent graphs
  * 
- * An example graph from a board, starting from V=1 is:
+ * An example of the biggest coherent graph we can create from the board bellow,
+ * starting from V=1 is:
  * <pre>
  *    6---7   8                (1)
  *    |       |               /  \
@@ -327,7 +350,7 @@ class Graph {
 
    /**
     * Attach an edge into a graph IFF the graph already has a vertex
-    * with the same value of one of the vertices of the edge.
+    * with the same value as one of the vertices of the edge.
     * @param e    The edge to attach.
     * @return     The status of the operation.
     *    @arg     True on success
@@ -348,17 +371,18 @@ class Graph {
 
    /**
     * Recursive algorithm that tries to attach an edge into a graph
-    * IFF the graph already has a vertex.
-    * with the same value of one of the vertices of the edge.
+    * IFF the graph already has a vertex with the same value as one
+    * of the vertices of the edge.
+    *
     * @param e       The edge to attach.
-    * @param count   An initial count value to feed to the algorithm.
+    * @param count   An initial count value to feed the algorithm.
     * @return     The status of the operation.
     *    @arg     True on success
     *    @arg     False on failure
     */
    private int tryAttach (Edge e, int count) {
       for (Graph n: E)
-         count += n.tryAttach (e, count);
+         count = n.tryAttach (e, count);
       if (V == e.getV1()) {
          E.add(new Graph(e.getV2()));
          ++count;
@@ -372,7 +396,8 @@ class Graph {
 
    /**
     * Recursive algorithm that tries to count the number of vertices
-    * on the graph with the value of `v`
+    * on the graph with the same value as `v`.
+    *
     * @param v       The vertex to count
     * @param count   An initial count value to feed to the algorithm.
     * @return     The number of vertices with value `v`
@@ -384,6 +409,7 @@ class Graph {
          return ++count;
       return count;
    }
+
    private int V;                /**< The value of the current vertex/node */
    private ArrayList<Graph> E;   /**< A list of all the child nodes */
 }

src/host/labyrinth/Game.java

@@ -1,11 +1,40 @@
 /**
  * @file Game.java
  *
- * @author Christos Choutouridis AEM:8997
- * @email  cchoutou@ece.auth.gr
+ * @author
+ *    Christos Choutouridis
+ *    <cchoutou@ece.auth.gr>
+ *    AEM:8997
  */
 
-package net.hoo2.auth.labyrinth;
+/** 
+ * @mainpage A labyrinth board game
+ *
+ * This is a console game, played by 2 players. The Theseus and Minotaur.
+ * The Minotaur goal is to capture Theseus. The Theseus's goal is to collect
+ * all the supplies of the board before Minotaur catches him and before the
+ * game ends.
+ * 
+ * In this first assignment we deal with the board's creation and a basic
+ * player-game logic. The game is build around a number of classes:
+ *  - \ref Tile
+ *  - Supply
+ *  - Board
+ *  - Player
+ *  - Game
+ *  
+ * Which are the requested classes. We also provide some extra functionalities in:
+ *  - Const
+ *  - Session
+ *  - Direction
+ *  - DirRange
+ *  - Edge
+ *  - Graph
+ *  - Position
+ *  - Range
+ *  - ShuffledRange
+ */
+package host.labyrinth;
 
 import java.util.Scanner;
 
@@ -28,8 +57,8 @@ public class Game {
    int nextRound()   { return ++round; }
 
    /**
-    *  Utility to hold the execution of the program waiting for user input.
-    *  This is true only if the user passed the interactive flag.
+    * Utility to hold the execution of the program waiting for user input.
+    * This is true only if the user passed the interactive flag.
     */
    void waitUser () {
       if(Session.interactive) {
@@ -69,7 +98,7 @@ public class Game {
                break;
 
             case "-s":
-            case "--suplies":
+            case "--supplies":
                if (i+1 < args.length)
                   Session.supplySize = Integer.parseInt(args[++i]);
                break;

src/host/labyrinth/Player.java

@@ -1,5 +1,13 @@
-package net.hoo2.auth.labyrinth;
+/**
+ * @file Player.java
+ *
+ * @author
+ *    Christos Choutouridis
+ *    <cchoutou@ece.auth.gr>
+ *    AEM:8997
+ */
 
+package host.labyrinth;
 
 /**
  * @brief
@@ -11,9 +19,12 @@ class Player {
 
    /**
     * Create a new player and put him at the row-column coordinates 
-    * @param id      The id of the player
-    * @param name    The name of the player
-    * @param board   Reference to the board of the game
+    * @param id         The id of the player
+    * @param name       The name of the player
+    * @param champion   Flag to indicate if a player is a `champion`
+    * @param board      Reference to the board of the game
+    * @param row        The row coordinate of initial player position
+    * @param column     The column coordinate of initial player's position
     */
    Player(int id, String name, boolean champion, Board board, int row, int column) {
       this.playerId  = id;
@@ -27,9 +38,11 @@ class Player {
 
    /**
     * Create a new player and put him at the row-column coordinates 
-    * @param id      The id of the player
-    * @param name    The name of the player
-    * @param board   Reference to the board of the game
+    * @param id         The id of the player
+    * @param name       The name of the player
+    * @param champion   Flag to indicate if a player is a `champion`
+    * @param board      Reference to the board of the game
+    * @param tileId     The tileId coordinate of player's initial position
     */
    Player(int id, String name, boolean champion, Board board, int tileId) {
       this.playerId  = id;
@@ -105,6 +118,7 @@ class Player {
    int getScore ()      { return score; }
    int getX()           { return x; }
    int getY()           { return y; }
+   boolean getChampion(){ return champion; }
 
    void setPlayerId(int id)   { playerId = id; }
    void setName(String name)  { this.name = name; }
@@ -118,6 +132,10 @@ class Player {
       assert (y >= 0 && y< Session.boardSize) : "Y(row) coordinate must be in the range [0, Session.boardSize)";
       this.y = y;
    }
+   void setChampion (boolean champion) {
+      this.champion = champion;
+   }
+
    /** @} */
    
    /** @name Class data */

src/host/labyrinth/Supply.java

@@ -1,11 +1,13 @@
 /**
  * @file Supply.java
  *
- * @author Christos Choutouridis AEM:8997
- * @email  cchoutou@ece.auth.gr
+ * @author
+ *    Christos Choutouridis
+ *    <cchoutou@ece.auth.gr>
+ *    AEM:8997
  */
 
-package net.hoo2.auth.labyrinth;
+package host.labyrinth;
 
 /**
  * @brief
@@ -76,7 +78,7 @@ class Supply {
    int supplyId ()        { return supplyId; }
    /**
     * Set the supplyId
-    * @param   sId   The Id to set
+    * @param   sID   The Id to set
     * @return  The supplyId
     * @note    This function also returns the supplyId to help in chained expressions.
     */

src/host/labyrinth/Tile.java

@@ -1,11 +1,13 @@
 /**
  * @file Tile.java
  *
- * @author Christos Choutouridis AEM:8997
- * @email  cchoutou@ece.auth.gr
+ * @author
+ *    Christos Choutouridis
+ *    <cchoutou@ece.auth.gr>
+ *    AEM:8997
  */
 
-package net.hoo2.auth.labyrinth;
+package host.labyrinth;
 
 /**
  * @brief
@@ -132,7 +134,7 @@ class Tile {
 
    /**
     * Sets the tile's wall in the requested direction.
-    * @param up      The direction for the wall.
+    * @param direction  The direction for the wall.
     */
    void setWall (int direction) {
       switch (direction) {
@@ -145,7 +147,7 @@ class Tile {
 
    /**
     * Clears the tile's wall in the requested direction.
-    * @param up      The direction for the wall 
+    * @param direction  The direction for the wall 
     */
    void clearWall (int direction) {
       switch (direction) {