Change Readme to describe every test

Author: trcrsired

CMakeLists.txt

@@ -28,13 +28,13 @@ add_executable(ibuf_white_hole_engine src/0007.random/ibuf_white_hole_engine.cc)
 
 add_test(NAME 10mint COMMAND ${CMAKE_CROSSCOMPILING_EMULATOR} $<TARGET_FILE:iobuf_file>)
 add_test(NAME leb128 COMMAND ${CMAKE_CROSSCOMPILING_EMULATOR} $<TARGET_FILE:iobuf_file_leb128>)
-add_test(NAME concat_string COMMAND ${CMAKE_CROSSCOMPILING_EMULATOR} $<TARGET_FILE:concat_string>)
+add_test(NAME concat_str COMMAND ${CMAKE_CROSSCOMPILING_EMULATOR} $<TARGET_FILE:concat_string>)
 add_test(NAME list_sort COMMAND ${CMAKE_CROSSCOMPILING_EMULATOR} $<TARGET_FILE:list_sort>)
-add_test(NAME generate_graph COMMAND ${CMAKE_CROSSCOMPILING_EMULATOR} $<TARGET_FILE:generate_graph>)
+add_test(NAME gengraph COMMAND ${CMAKE_CROSSCOMPILING_EMULATOR} $<TARGET_FILE:generate_graph>)
 add_test(NAME dijkstra COMMAND ${CMAKE_CROSSCOMPILING_EMULATOR} $<TARGET_FILE:dijkstra_optimize_fastio>)
 add_test(NAME dijkstra_unchecked COMMAND ${CMAKE_CROSSCOMPILING_EMULATOR} $<TARGET_FILE:dijkstra_optimize_fastio_unchecked>)
-set_tests_properties(dijkstra PROPERTIES DEPENDS "generate_graph")
-set_tests_properties(dijkstra_unchecked PROPERTIES DEPENDS "generate_graph")
+set_tests_properties(dijkstra PROPERTIES DEPENDS "gengraph")
+set_tests_properties(dijkstra_unchecked PROPERTIES DEPENDS "gengraph")
 add_test(NAME sha512 COMMAND ${CMAKE_CROSSCOMPILING_EMULATOR} $<TARGET_FILE:sha512>)
 add_test(NAME vec_push_back COMMAND ${CMAKE_CROSSCOMPILING_EMULATOR} $<TARGET_FILE:vector_push_back>)
 add_test(NAME randpass COMMAND ${CMAKE_CROSSCOMPILING_EMULATOR} $<TARGET_FILE:ibuf_white_hole_engine>)

README.md

@@ -6,13 +6,54 @@ This set of microbenchmarks adheres to the C++ standard and is designed to execu
 # fastiobench
 This benchmark includes 10 standard benchmarks:
 
-print/scan 10 million integers
-concat string
-vector push_back
-dijkstra
-spfa
-topsort
-tarjan
-gabow
-list sort
-sha512
+1.10mint: print/scan 10 million integers
+2.leb128: print/scan 10 million integers with leb128
+3.concatstr: concat std::string
+4.gengraph: generate a graph for dijkstra and dijkstra unchecked
+5.dijkstra
+6.dijkstra_unchecked
+7.list sort
+8.sha512
+9.vec_push_back:vector push_back
+10.randpass
+
+# Tests Explainations
+
+## 1.10mint
+This benchmark generates 10 million integers and writes them to a file, then reads them back. It is designed to evaluate the performance of formatted input/output operations, crucial for tasks such as logging, serializing text (e.g., JSON), or handling vast amounts of text input/output in ACM/ICPC or Computing Olympiad competitions.
+
+## 2.leb128
+
+This benchmark generates 10 million integers, writes them to a file using the integers' LEB128 encoding, and then reads them back. It focuses on evaluating the performance of binary serialization.
+
+## 3.concatstr
+
+This benchmark assesses the performance of concatenating ```std::string``` objects, a common operation in C++ code where string concatenation using ```std::string``` is ubiquitous and performance is critical. It primarily evaluates the performance of heap allocation.
+
+## 4.gengraph
+
+It produces a directed graph test intended for consumption by the 5.dijkstra and 6.dijkstra_unchecked algorithms. The benchmark evaluates the input/output and random number generation performance on your system.
+
+## 5.dijkstra
+
+Dijkstra is a widely used algorithm for finding the shortest path. However, it employs various data structures and algorithms. It can serve as a benchmark for evaluating the performance of data structures and the efficiency of random access on contiguous ranges, such as vectors.
+
+## 6.dijkstra_unchecked
+
+This version is the unchecked variant of 5.dijkstra. While 5.dijkstra always verifies bounds to uphold memory safety, this one does not. Its purpose is to assess whether bounds checking leads to a performance decline on your system by comparing its results with those of 5.dijkstra.
+
+## 7.list sort
+
+This benchmark evaluates the performance of sorting a doubly-linked list, specifically focusing on the efficiency of pointer chasing, where cache misses are prevalent.
+
+## 8.sha512
+
+SHA512 is a widely used cryptographic hash algorithm known for its utility and security. This benchmark assesses the performance of a typical cryptographic algorithm.
+
+## 9.vec_push_Back
+
+vector.push_back is a frequently used operation in C++ due to the widespread adoption of the vector container as the default choice. The efficiency of push_back becomes paramount as it is executed frequently. This benchmark evaluates the performance of vector growth and the allocator's efficiency.
+
+## 10.randpass
+
+This generates 1 million passwords using the system's cryptographically secure random number generator. It assesses the performance of the random number generator, a task commonly encountered in various applications.