Moved nitpick and cases to test folder

Simplified nitpick related macros in CMakeLists.txt
Provided a README to test/cases

Author: lukas-valenta-tul

.gitignore

@@ -41,3 +41,5 @@ build/*
 .vs
 CMakeSettings.json
 
+# Autogenerated files
+test/cases/*_gen.hh

CMakeLists.txt

@@ -291,51 +291,34 @@ define_test(test_processor bparser) #is it broken? -LV
 define_test(test_speed bparser)  
 define_test(test_simd)
 
-macro(define_nit_gen make_name def_file gen_file)
-    set(src_name "nitpick_generate")
-    set(nit_source "${CMAKE_CURRENT_SOURCE_DIR}/nitpick/${src_name}.cc")
+macro(define_nit_target make_name def_file gen_file src_name)
+    set(nit_source "${CMAKE_CURRENT_SOURCE_DIR}/test/nitpick/${src_name}.cc")
     set(nit_name "${src_name}_${make_name}")
     set(nit_binary "${nit_name}_bin")
 
     add_executable(${nit_binary} EXCLUDE_FROM_ALL  ${nit_source} )
     add_dependencies(${nit_binary} bparser)
     target_link_libraries(${nit_binary} bparser)
-    #set_property(TARGET ${nit_binary} PROPERTY COMPILE_DEFINITIONS "DEF_FILE=$<PATH:NORMAL_PATH,\"${def_file}\">;GEN_FILE=$<PATH:NORMAL_PATH,\"${gen_file}\">")
     set_property(TARGET ${nit_binary} PROPERTY COMPILE_DEFINITIONS "DEF_FILE=\"${def_file}\";GEN_FILE=\"${gen_file}\"")
 
     add_custom_target(${nit_name}
     COMMAND "$<TARGET_FILE:${nit_binary}>"
     DEPENDS ${nit_binary}
-    WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/cases")
+    WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/test/cases")
 endmacro()
 
-macro(define_nit_run make_name def_file gen_file)
-    set(src_name "nitpick_run")
-    set(nit_source "${CMAKE_CURRENT_SOURCE_DIR}/nitpick/${src_name}.cc")
-    set(nit_name "${src_name}_${make_name}")
-    set(nit_binary "${nit_name}_bin")
-
-    add_executable(${nit_binary} EXCLUDE_FROM_ALL  ${nit_source} )
-    add_dependencies(${nit_binary} bparser)
-    target_link_libraries(${nit_binary} bparser)
-    #set_target_properties(${nit_binary} PROPERTIES COMPILE_DEFINITIONS "DEF_FILE=$<PATH:NORMAL_PATH,${def_file}>;GEN_FILE=$<PATH:NORMAL_PATH,${gen_file}>")
-    set_property(TARGET ${nit_binary} PROPERTY COMPILE_DEFINITIONS "DEF_FILE=\"${def_file}\";GEN_FILE=\"${gen_file}\"")
-
-    add_custom_target(${nit_name}
-    COMMAND "$<TARGET_FILE:${nit_binary}>"
-    DEPENDS ${nit_binary}
-    WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/cases")
-endmacro()
+macro(define_nit make_name)
+    set(nit_def_file "${make_name}_def.hh")
+    set(nit_gen_file "${make_name}_gen")
 
-macro(define_nit make_name def_file gen_file)
-    define_nit_gen(${make_name} ${def_file} ${gen_file})
+    define_nit_target(${make_name}          ${nit_def_file} "${nit_gen_file}.hh"         "nitpick_generate") #generate the _gen.hh file
 
-    define_nit_run(${make_name} ${def_file} ${gen_file})
+    define_nit_target(${make_name}          ${nit_def_file} "${nit_gen_file}_ref.hh"         "nitpick_run") #run the _gen_ref.hh file
+    define_nit_target("${make_name}_edit"   ${nit_def_file} "${nit_gen_file}_edit.hh"    "nitpick_run") #run the _gen_edit.hh file
 endmacro()
 
-define_nit(basic_expr basic_expr_def.hh basic_expr_gen.hh)
-define_nit(norm2 norm2_def.hh norm2_gen.hh)
-define_nit_run(norm2_mac norm2_def.hh norm2_gen_edit.hh)
+define_nit(basic_expr)
+define_nit(norm2)
 
 
 #set(src_name "nitpick_generate")

test/cases/README.md

@@ -0,0 +1,41 @@
+
+# Nitpick test cases
+The nitpick test cases allows developers to time and compare different Directed Acyclic Graphs (DAG) of ScalarNodes for various bparser expressions.
+
+## File structure
+
+There are 4 different files for each case:  
+* `<name>_def.hh` - Defines what the parser expression is, what are the variable shapes and names and the result shape
+* `<name>_gen.hh` - Autogenerated file containing a reconstruction of the parser's DAG. This file is in .gitignore
+* `<name>_gen_ref.hh` - The autogenerated file before being edited. 
+Most likely identical to `<name>_gen.hh` but the autogenerated file can look different now than how it would generate before.
+* `<name>_gen_edit.hh` - Former file, but edited. The DAG may be constructed more optimally or is using different ScalarNode operations
+
+## Adding a case
+
+1. Create a `<name>_def.hh` file.  
+    * This file must define the function `void def(ExprCase&)`
+	* You must call the `ExprCase::parse` method to set the bparser's expression.
+	* You must specify the result shape using the `ExprCase::set_result_shape` method.
+	* You may use the `ExprCase::set_variable` and `ExprCase::set_var_copy` methods. 
+	They are similar to `Parser::set_variable` and `Parser::set_var_copy`, except you don't need a double pointer.
+    * You may use `#ifndef NITPICK_IDE_IGNORE #endif` to trick the IDE into thinking something exists and/or is included. This block will not actually be compiled.
+2. Declare the case in CMakeLists.txt
+    * Add `define_nit(<name>)` near similar definitions
+3. Generate the file
+    * Make the `nitpick_generate_<name>` target
+4. Copy the autogenerated file
+    * First copy should have `_ref` at the end of the filename
+	* Second copy should have `_edit` at the end of the filename
+5. Run and compare
+    * Use the `nitpick_run_<name>` and `nitpick_run_<name>_edit` Make targets to run and time the original or edited file
+
+
+## Timing
+The nitpick_run.cc file will repeatedly:
+1. Allocate \<variable_size> × vec_size for each variable set in the ExprCase object where vec_size changes every iteration
+2. Run and time the autogenerated DAG for N ÷ vec_size times, where N is a very high constant integer
+    * This is to spend more time computing small vec_sizes
+3. Deallocate memory from step 1.
+
+This is done for every vec_size which is an array of integers set in the nitpick_run.cc file