diff --git a/Readme.md b/Readme.md new file mode 100644 index 0000000..bb821b4 --- /dev/null +++ b/Readme.md @@ -0,0 +1,35 @@ +# Ballpit + +> Version: 1.0.19362.1 + +> Created By: Jali + +> Last Modified By: + +## Overview + +The ```ballpit``` program is a small command line tool written in [Rust](https://www.rust-lang.org). +It shows the princible of sorting balls, randomly picked from a ball pit, by their colour. + +The algorithm used here, is implemented in a naïve way, to make it as easy as possible for a layman's audience +to understand how it works. + +## Usage + +The program is run from the command line. It only takes one option ```-n``` or ```--no-of-balls``` which is followed +by the number of balls to generate inside the pit: + +```bash +./ballpit -n 10000 +``` + +Runs the program for a pit with 10000 balls. + +## The algorithm + +The algorithm itself is a very simple and naïve implementation, and it is not a traditional sorting algorithm +either. It simply picks a ball from the pit at random, and packs it into one of four buckets, depending on the +colour. + +![Flussdiagram](./doc/algorithm.png) + diff --git a/doc/BaelleSortieren.xml b/doc/BaelleSortieren.xml new file mode 100644 index 0000000..c08c1f3 --- /dev/null +++ b/doc/BaelleSortieren.xml @@ -0,0 +1 @@ +5VvbcqM4EP0aP04KcRHmMfYke09tlbdqdx5lo2DVYnBhPHHm67fFxYBaJAwD2Os8GRpJiNN9ulsteWYtd6efErbf/hH7PJyZhn+aWZ9npkkMy4QfKXnNJeZ8buSSIBF+0aoSrMQ3XnYtpEfh80OjYRrHYSr2TeEmjiK+SRsyliTxS7PZcxw237pnAUeC1YaFWPq38NNtLp2bbiX/mYtgW76ZUC9/smNl4+JLDlvmxy81kfUws5ZJHKf51e605KFEr8Ql7/fY8vQ8sYRHaZcOlpP3+MrCY/FxM5OG0HexhcFoIK8Ws6U1u7dD+HzTWMVJKjiMX7aDwaumpXBfCp6Y+MoT6HcfBnEi0u3ueIC7407qX8gBG6OLXUOyZj7cR2yzhZ9Hlqzla41vR4lcOY+72kT21TwydNPXUmUpP2Ufle5CEBC4PKRJ/C9fxmGcgCSKI2i5eBZhqIgOe7YRUQACp7r7K96D4BOgay1etiLlK5DLV72AyYMsho9+DjPNboXvw7StRRIfI59L4I3zDKEZzKxVeeRsEkAmHu94mrxCk1OTDgWNPpmWUUheKqskXiHb1i2ybMgKJgTnwStjgYvCXlpsh7bazrrUwyplSVpT0LpVQRU6pAXTmu4GAM8yVfTIXIOeqUGPDgGei8B7Ejtp/SIJOCAhoszWFyzrxjLW+FxDj1Yc22xzZByJZ06J41xjhAokAOe99PpwtwnZ4SA2TRT4SaT/SMDunOLuS+3J51OBZXbzWt5EMNFaJ3n7pf6s6pbdlf3yyXEfBRgFb+ngjsmGN6kGbAp40czy9Hqpoe5oQC9lCQ9ZCr65GRw1mije8GcsYIKV2i2VPoarqDP/gKJfPQapQ83RUKpl5N+NhsqM4/zp3ezFQ/ayEpHfIQ5Zj5hr23i3BmZOwzOnDfA6z4jO25MBiGYbAxKtRrOKdO8RrUGzinXDEs3DRLNbFDMN0dQgT87J8vfyjCBPbaqG0cIzUCp7rTXbywaHN+aMnQNx3p6b2oMomStc5LPoS3ybaOxXyVYeIHL+P5IVcjavKYKsbSLsniBBQbD0T7JZKIJIug0ABJYL1kLCJWDFdV882EEWLV+jBXvwzBqn1oaN8bY1cJtDwG0N6GqvN6fRuNo8K76Uq3Wwr1XXSV19rUPRUM5oOY1tI3v55ZBm64WkWkIksqZw4RwGefm5pXFjhkbF3hC80hU7JuBVT364mB+5pi/FD9tW1UfV6NKVH7anDuV2zEX68AMXKn7nAc8IUltjy4BWSIAr2e9vLEljHOemXmM7BuJNkU9NE/5xraI3b8jsWlP/0os2+EYvyjdiqXyz+/KNoqFUjzog33BN5leGLOZmkkXbUlbmwM4Jk0Vc0LhFcmoKYM78kuSktnun6t0lyjBd6Uk9zWBUGWw4gpYQvJ0wBomsfy2W0fWljVRXqh8rbXRw5eCd9OGM3HUnEZROmEQ4uIZwg36qZFbDT120foiTCFslRf8kwlHzkQF9FC6CfKwk4ry2miCJcDpVENYhO15fLHA0ydZ4sQCXEN6JBRK06w4DtjdlGNAdGri9MKBZS+amcz1hwFIdR/8wYKlbvwOGAVx7+Fhh4BytpwgDXQ5ThKHYH9oAqWmAHfb52btncZIQDQEPRWV1t1o51QAq98obADkDANRlsX1dANXWqRMARPHKsrd7b5bYjW7unUzi3ufYvV/2OI6uGoF2nH6kGuGpO2EDHRWgrhJM1KMCP7zxT/Hy/ftNsmf20CdT6WmS5TnoesZxUZNEm6mkb8KBfBoZL9+gA5YpejkwZe+djOPANHvvFy6nztH6t2+ZwkU5lDtemYIOcVZjdN1fj1eg6CST3ffcKHXVoRzVw4wVpM6THixI4QLMQG7nmo786LZYHWN2QXPEUaq328Fhaky3g+tQt30iD9f9XM3RobEWxnTAqtX10lO7eXHRE0cmOnGEXHxneqITR86IWaTm3z0fjJ6O5t8Jo9HzYx04wWB74+0VwW31d9ScCtW/eq2H/wA= \ No newline at end of file diff --git a/doc/algorithm.png b/doc/algorithm.png new file mode 100644 index 0000000..f778e9a Binary files /dev/null and b/doc/algorithm.png differ