fix(ai): add tests to catchthecat assignment

tolstenko · tolstenko · commit 383ba04e4078 · 2023-09-14T12:43:19.000-04:00
diff --git a/courses/artificialintelligence/assignments/catchthecat/CMakeLists.txt b/courses/artificialintelligence/assignments/catchthecat/CMakeLists.txt
@@ -1,4 +1,4 @@
-add_executable(ai-catchthecat simulator.cpp Catcher.h Cat.h)
+add_executable(ai-catchthecat simulator.cpp)
 
 file(GLOB TEST_INPUT_FILES ${CMAKE_CURRENT_SOURCE_DIR}/tests/*.in)
 file(GLOB TEST_OUTPUT_FILES ${CMAKE_CURRENT_SOURCE_DIR}/tests/*.out)
diff --git a/courses/artificialintelligence/assignments/catchthecat/Cat.h b/courses/artificialintelligence/assignments/catchthecat/Cat.h
@@ -1,8 +1,10 @@
-#pragma once
+#ifndef CAT_h
+#define CAT_h
 #include "IAgent.h"
 
 struct Cat : public IAgent {
   std::pair<int,int> move(const std::vector<bool>& world, std::pair<int,int> catPos, int sideSize ) override{
     return {0,0}; // todo: change this
   }
-};
+};
+#endif
diff --git a/courses/artificialintelligence/assignments/catchthecat/Catcher.h b/courses/artificialintelligence/assignments/catchthecat/Catcher.h
@@ -1,8 +1,10 @@
-#pragma once
+#ifndef CATCHER_H
+#define CATCHER_H
 #include "IAgent.h"
 
 struct Catcher : public IAgent {
   std::pair<int,int> move(const std::vector<bool>& world, std::pair<int,int> catPos, int sideSize ) override{
     return {0,0}; // todo: change this
   }
-};
+};
+#endif
diff --git a/courses/artificialintelligence/assignments/catchthecat/IAgent.h b/courses/artificialintelligence/assignments/catchthecat/IAgent.h
@@ -1,4 +1,5 @@
-#pragma once
+#ifndef IAgent_h
+#define IAgent_h
 #include <vector>
 #include <utility>
 #include <string>
@@ -16,4 +17,5 @@ struct IAgent {
      * @return the position to move to {x,y}. relative to the center of the world.
    */
   virtual std::pair<int,int> move(const std::vector<bool>& world, std::pair<int,int> catPos, int sideSize ) = 0;
-};
+};
+#endif
diff --git a/courses/artificialintelligence/assignments/catchthecat/README.md b/courses/artificialintelligence/assignments/catchthecat/README.md
@@ -60,13 +60,13 @@ The points will be counted as how many moves each one does;
 
 If Cat Wins:
 
-- CatPoints: SideSize * SideSize - CatMoves - K * CPU time;
-- CatcherPoints: CatcherMoves - K * CPU time;
+- CatPoints: SideSize * SideSize/2 - CatMoves - K*CpuCatTime;
+- CatcherPoints: CatcherMoves - K*CpuCatcherTime;
 
 If Catcher Wins:
 
-- CatPoints: CatMoves - K * CPU time;
-- CatcherPoints: SideSize * SideSize - CatcherMoves - K * CPU time;
+- CatPoints: CatMoves - K*CpuCatTime;
+- CatcherPoints: SideSize * SideSize/2 - CatcherMoves - K*CpuCatherTime;
 
 ## How to participate:
 
@@ -136,4 +136,4 @@ public:
      */
     virtual std::pair<int,int> move(const std::vector<bool>& world, std::pair<int,int> catPos, int sideSize ) = 0;
 };
-```
+```
diff --git a/courses/artificialintelligence/assignments/catchthecat/simulator.cpp b/courses/artificialintelligence/assignments/catchthecat/simulator.cpp
@@ -6,7 +6,7 @@
 #include "Cat.h"
 #include "Catcher.h"
 
-void print(const std::vector<bool>& state, int sideSize, std::pair<int,int> catPos, char turn) {
+void print(const std::vector<bool>& state, int sideSize, std::pair<int,int> catPos, const std::string& turn){
   std::cout << turn << " " << sideSize << " " << catPos.first << " " << catPos.second << std::endl;
   catPos.first += sideSize/2;
   catPos.second += sideSize/2;
@@ -47,20 +47,21 @@ std::vector<bool> readBoard(int sideSize) {
 }
 
 int main() {
-  char turn;
+  std::string turn;
   int sideSize;
   int catX, catY;
   std::vector<bool> blocked;
   std::cin >> turn >> sideSize >> catX >> catY;
   blocked = readBoard(sideSize);
-  if(turn == 'C'){
+  // while(not win){ simulate; } // todo: create your own logic to test and simulate, check for win conditions etc.
+  if(turn == "CAT"){
     Cat cat;
     auto catMove = cat.move(blocked, {catX, catY}, sideSize);
-    print(blocked, sideSize, {catMove.first, catMove.second}, 'T');
-  } else {
+    print(blocked, sideSize, {catMove.first, catMove.second}, "CATCHER");
+  } else if (turn == "CATCHER") {
     Catcher catcher;
     auto catcherMove = catcher.move(blocked, {catX, catY}, sideSize);
     blocked[(catcherMove.second + sideSize/2) * sideSize + catcherMove.first+sideSize/2] = true;
-    print(blocked, sideSize, {catX, catY}, 'C');
+    print(blocked, sideSize, {catX, catY}, "CATCHER");
   }
 }
diff --git a/courses/artificialintelligence/assignments/catchthecat/tests/test-a.in b/courses/artificialintelligence/assignments/catchthecat/tests/test-a.in
diff --git a/courses/artificialintelligence/assignments/catchthecat/tests/test-a.out b/courses/artificialintelligence/assignments/catchthecat/tests/test-a.out
diff --git a/courses/artificialintelligence/assignments/catchthecat/tests/test-aa.in b/courses/artificialintelligence/assignments/catchthecat/tests/test-aa.in
@@ -0,0 +1,6 @@
+CAT 5 0 0
+. . . . .
+ . # # . .
+. # C . .
+ . # # . .
+. . . . .
diff --git a/courses/artificialintelligence/assignments/catchthecat/tests/test-aa.out b/courses/artificialintelligence/assignments/catchthecat/tests/test-aa.out
@@ -0,0 +1,6 @@
+CATCHER 5 1 0
+. . . . .
+ . # # . .
+. # . C .
+ . # # . .
+. . . . .
diff --git a/courses/artificialintelligence/assignments/catchthecat/tests/test-ab.in b/courses/artificialintelligence/assignments/catchthecat/tests/test-ab.in
@@ -0,0 +1,6 @@
+CAT 5 0 0
+. . . . .
+ . # # . .
+. # C # .
+ . # . . .
+. . . . .
diff --git a/courses/artificialintelligence/assignments/catchthecat/tests/test-ab.out b/courses/artificialintelligence/assignments/catchthecat/tests/test-ab.out
@@ -0,0 +1,6 @@
+CATCHER 5 0 1
+. . . . .
+ . # # . .
+. # . # .
+ . # C . .
+. . . . .
diff --git a/courses/artificialintelligence/assignments/catchthecat/tests/test-ac.in b/courses/artificialintelligence/assignments/catchthecat/tests/test-ac.in
@@ -0,0 +1,6 @@
+CAT 5 0 0
+. . . . .
+ . # # . .
+. # C # .
+ . . # . .
+. . . . .
diff --git a/courses/artificialintelligence/assignments/catchthecat/tests/test-ac.out b/courses/artificialintelligence/assignments/catchthecat/tests/test-ac.out
@@ -0,0 +1,6 @@
+CATCHER 5 -1 1
+. . . . .
+ . # # . .
+. # . # .
+ . C # . .
+. . . . .
diff --git a/courses/artificialintelligence/assignments/catchthecat/tests/test-ad.in b/courses/artificialintelligence/assignments/catchthecat/tests/test-ad.in
@@ -0,0 +1,6 @@
+CAT 5 0 0
+. . . . .
+ . # # . .
+. . C # .
+ . # # . .
+. . . . .
diff --git a/courses/artificialintelligence/assignments/catchthecat/tests/test-ad.out b/courses/artificialintelligence/assignments/catchthecat/tests/test-ad.out
@@ -0,0 +1,6 @@
+CATCHER 5 -1 0
+. . . . .
+ . # # . .
+. C . # .
+ . # # . .
+. . . . .
diff --git a/courses/artificialintelligence/assignments/catchthecat/tests/test-ae.in b/courses/artificialintelligence/assignments/catchthecat/tests/test-ae.in
@@ -0,0 +1,6 @@
+CAT 5 0 0
+. . . . .
+ . # # . .
+. . C # .
+ . # # . .
+. . . . .
diff --git a/courses/artificialintelligence/assignments/catchthecat/tests/test-ae.out b/courses/artificialintelligence/assignments/catchthecat/tests/test-ae.out
@@ -0,0 +1,6 @@
+CATCHER 5 -1 0
+. . . . .
+ . # # . .
+. C . # .
+ . # # . .
+. . . . .
diff --git a/courses/artificialintelligence/assignments/catchthecat/tests/test-af.in b/courses/artificialintelligence/assignments/catchthecat/tests/test-af.in
@@ -0,0 +1,6 @@
+CAT 5 0 0
+. . . . .
+ . . # . .
+. # C # .
+ . # # . .
+. . . . .
diff --git a/courses/artificialintelligence/assignments/catchthecat/tests/test-af.out b/courses/artificialintelligence/assignments/catchthecat/tests/test-af.out
@@ -0,0 +1,6 @@
+CATCHER 5 -1 -1
+. . . . .
+ . C # . .
+. # . # .
+ . # # . .
+. . . . .
diff --git a/courses/intro/03-datatypes/README.md b/courses/intro/03-datatypes/README.md
@@ -148,7 +148,7 @@ Here, the underlying type of the enumeration is `char`, so the constants `Red`,
 // You can make the value of the constants
 // explicit to make your debugging easier:
 enum class Color : char {
-  Red = 'r', //  
+  Red = 'r',
   Green = 'g',
   Blue = 'b'
 };
diff --git a/courses/intro/04-conditionals/README.md b/courses/intro/04-conditionals/README.md
@@ -301,7 +301,52 @@ In this example, the output would be "x is 2" and "x is 3", as the break stateme
 
 It is generally considered good practice to include a `break` statement at the end of each case in a `switch` statement to avoid unintended fallthrough. However, there may be cases where a fallthrough is desired behavior. In such cases, it is important to document the intended fallthrough in the code to make it clear to other programmers.
 
-# Homework
+### Issues with switch and enums
+
+A nice usecase for `switch`es is to be used to select between possible choices and `enum`s are one of the best ways of expressing choices. So it seems natural to combine both, right? Well, not so fast. There are some issues with this combination that you might be aware of.
+
+The main issue with this approach relies on the `switch`'s `default` behavior. If you use `deafult` on `swich`es in conjunction with stringly typed `enum`s (`enum class` or `enum struct`), the compiler won't be able to warn you about missing cases. This is because the `default` case will be triggered for any value that is not explicitly handled by the `switch`. This is a problem because it is very easy to forget to add a new case when a new value is added to the `enum` and the compiler won't warn you about it. Example:
+
+```c++ title="ColorEnum.h"
+enum class Color { Red, Green };
+```
+
+```c++ title="UseCaseX.cpp"
+// this code goes inside some function that uses Color c
+switch(c){
+  case Color::Red:
+    // do something
+    break;
+  default: // covers Color::Green and any other value
+    // do something else
+    break;
+}
+```
+
+But you just remembered that now you should cover the `Blue` state. So you add it to the `enum`:
+
+```c++ title="ColorEnum.h"
+enum class Color { Red, Green, Blue };
+```
+
+But you might forget to add the coverage for the new case to the `switch`, it will fall into the `default` case without warnings.
+
+So the best combination is to use `switch`es with `enum class`es and **do not** use `default` cases. This way, the compiler will warn you about missing cases. So if you add a new `enum` value had this code instead, you will be warned about missing cases.
+
+```c++ title="UseCaseX.cpp"
+// this code goes inside some function that uses Color c
+switch(c){
+  case Color::Red:
+    // do something
+    break;
+  case Color::Green:
+    // do something else
+    break;
+}
+// this code will throw a warning if you forget to add a case for the new enum value
+```
+
+## Homework
 
 - Do all exercises up to this topic [here](https://www.w3schools.com/cpp/exercise.asp).
 

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-add_executable(ai-catchthecat simulator.cpp Catcher.h Cat.h)`
	`1`	`+add_executable(ai-catchthecat simulator.cpp)`
`2`	`2`
`3`	`3`	`file(GLOB TEST_INPUT_FILES ${CMAKE_CURRENT_SOURCE_DIR}/tests/*.in)`
`4`	`4`	`file(GLOB TEST_OUTPUT_FILES ${CMAKE_CURRENT_SOURCE_DIR}/tests/*.out)`