lukasmartinelli-alt/kwic

The Key Word in Context (KWIC) creates all possible mutations of an ordered set of words.

KWIC - Keyword in Context

⚠️ This repository is no longer maintained by Lukas Martinelli.

The KWIC index system accepts an ordered set of lines, each line is an ordered set of words, and each word is an ordered set of characters. Any line may be "circularly shifted" by repeatedly removing the first word and appending it at the end of the line. The KWIC index system outputs a listing of all circular shifts of all lines in alphabetical order.

Project Setup for Cevelop

1. Install Cevelop
2. Open the repository as a workspace
3. Import as existing projects into workspace

Build Project

You can use Eclipse to build the project or the provided makefile.

make

Run Tests

We use CUTE for our unit tests. To run the tests you need to compile the tests and then simply run the executable. This will output the test results to the console and a XML file.

make test

Example:

Input:

this is a test
this is another test

Result:

a test this is
another test this is
is a test this
is another test this
test this is a
test this is another
this is a test
this is another test

kwic's Issues

Review by lecturer

main.cpp

• vorbildlich, permuteLines schlechter Funktionsname!

kwic.cpp

• operator>> << im namespace kwic werden ggf. nicht gefunden, weil keiner der Parametertypen in diesem Namespace definiert ist (ADL-Problem)
• permuteLines/permuteWords/permutations -> schlechter Name, es werden nur Rotationen keine Permutationen erzeugt

kwic.h

• <vector> fehlt hier (wird von word.h unnötigerweise mitgebracht)
• warum operator>> ? in dem namespace wird er nicht gesucht bei der Anwendung

word.cpp

• Vergleichsoperatoren zum Teil falsch implementiert (operator> nutzt nicht operator< der Word Klasse, sondern von std::string
• operator== und damit auch != ineffizient implementiert
• Schematisch Vergleichsoperatoren inline im Header realisieren.
• Wo sind die Lesefunktionen/Print? Die gehören aufgrund Ihrer Komplexität in das .cpp file, sonst wird der header von zu vielen Dingen abhängig

word.h

• warum namespace kwic? Word Klasse sollte nicht von Kwic Anwendung abhängig sein!
• public member Variable führt Prüfung der Klasseninvariante ad absurdum! Ganz mieses Design
• Implementierung der shift-operatoren ändert direkt member-Variable! Schlecht!
• Logik war vorgegeben in read()/print() member funktionen
• default ctor hätte auch mit Word(std::string value="") erreicht werden können.
• viel zu starke dependencies im header (<istream> und <ostream> (auch wenn indirekt)
• wozu braucht es <vector>?

Test.cpp

• Arrange/Act/Assert braucht man nicht zu kommentieren, einfach machen!
• eigene header zuerst
• testWordsAreDelimitedByNonAlphanumericCharacters -> nicht Vorgabe getestet, umständlich (Schleife) und EOF Verhalten nicht geprüft
• testPermuteSingleLineReturnsAllMutationsSorted umständlich implementiert! Man kann mit ASSERT_EQUAL auch vectors vergleichen!
  • const auto mit =Word ist eher ungeschickt, besser Word const word{"this"};
  • Wenn man den Typ sowieso konkret hinschreibt, ist auto schlecht!
• keine Tests für mehr Zeilen als die Vorlage, schade
• testWordRightShiftPutsWordsIntoSentenceUntilEndOfLine prüft nicht, ob wirklich EOF erreicht wurde!