Release version 1 (#11)

* Created JAR that is culmination of project for release.

* Updated REAMME.md to have the How To Use section complete.

* Added Drytron.txt as example

* Corrected spelling mistakes, though will not take affect until JAR is recompiled. Not going to bother for V1.

Author: Gabriel-T-Harris

Compiled Releases/Hand_Probability_Calculator_V1_GTH_2021.jar

@@ -0,0 +1,97 @@
+//--simulation_results_console --input "Input/Drytron.txt"
+deck list:
+{
+Diviner of the Herald;
+Diviner of the Herald;
+Diviner of the Herald;
+Herald of Orange Light;
+Herald of Orange Light;
+Herald of Orange Light;
+Drytron Delta Altais;
+Drytron Gamma Eltanin;
+Drytron Gamma Eltanin;
+Drytron Zeta Aldhibah;
+Drytron Zeta Aldhibah;
+Drytron Zeta Aldhibah;
+Drytron Alpha Thuban;
+Drytron Alpha Thuban;
+Drytron Alpha Thuban;
+Eva;
+Drytron Meteonis Draconids;
+Herald of Perfection;
+Cyber Angel Benten;
+Cyber Angel Idaten;
+Cyber Angel Natasha;
+Megalith Ophiel;
+Megalith Phul;
+Megalith Phul;
+Cyber Emergency;
+Cyber Emergency;
+Cyber Emergency;
+Terraforming;
+Ursarctic Drytron;
+Drytron Nova;
+Drytron Nova;
+Drytron Nova;
+Preparation of Rites;
+Preparation of Rites;
+Meteonis Drytron;
+Dawn of the Herald;
+Called by the Grave;
+Drytron Fafnir;
+Drytron Fafnir;
+Ursarctic Big Dipper;
+}
+
+//estimate
+scenarios:
+{
+    Effective Drytron Fafnir = {scenario = {[Drytron Fafnir] OR [Terraforming]};display = false;}
+
+    //without Cyber Emergency for Draconids
+    Effective Ritual = {scenario = {
+                                    [Diviner of the Herald] OR [Drytron Meteonis Draconids] OR [Herald of Perfection] OR
+                                    [Cyber Angel Benten] OR [Cyber Angel Idaten] OR [Cyber Angel Natasha] OR
+                                    [Megalith Ophiel] OR [Megalith Phul] OR [Preparation of Rites]
+                                   };display = false;}
+
+    //without Cyber Emergency nor Drytron Nova
+    Effective Drytron Monster = {scenario = {[Drytron Delta Altais] OR [Drytron Alpha Thuban] OR [Drytron Gamma Eltanin] OR [Drytron Zeta Aldhibah]};display = false;}
+
+    Alpha + Zeta = {scenario = {
+                                ([Drytron Alpha Thuban] AND [Drytron Zeta Aldhibah]) OR
+                                (([Drytron Alpha Thuban] OR [Drytron Zeta Aldhibah]) AND ([Cyber Emergency] OR <Effective Drytron Fafnir> OR [Drytron Nova])) OR
+                                ([Cyber Emergency] AND (<Effective Drytron Fafnir> OR [Drytron Nova]))
+                               };}
+
+    Mu-Beta = {scenario = {
+                           (([Drytron Nova] OR <Effective Drytron Fafnir> OR [Drytron Alpha Thuban]) AND ([Cyber Emergency] OR [Drytron Delta Altais] OR [Drytron Gamma Eltanin])) OR
+                           (([Drytron Nova] OR <Effective Drytron Fafnir> OR [Drytron Alpha Thuban] OR [Cyber Emergency]) AND ([Drytron Delta Altais] OR [Drytron Gamma Eltanin])) OR
+                           ([Drytron Gamma Eltanin] AND <Effective Ritual> AND ([Drytron Delta Altais] OR [Drytron Zeta Aldhibah]))
+                          };}
+
+    Beatrice =  {scenario = {
+                             ([Diviner of the Herald] AND ([Meteonis Drytron] OR [Herald of Perfection] OR [Cyber Angel Benten] OR [Cyber Angel Idaten] OR [Preparation of Rites]) AND ([Cyber Emergency] OR <Effective Drytron Monster> OR <Effective Drytron Fafnir> OR [Drytron Nova])) OR
+                             (([Cyber Angel Benten] OR [Preparation of Rites]) AND ([Cyber Emergency] OR <Effective Drytron Fafnir> OR [Drytron Nova] OR [Drytron Alpha Thuban] OR [Drytron Zeta Aldhibah]))
+                             /*
+                             Some other 4+ combos exist, but are not worth writing out due to being both being impractical and unlikely.
+                             -Phul, Level 6 Ritual, Meteonis, Alpha
+                             -Phul, Level 6 Ritual, Zeta, level >= 4
+                             -Phul, -Level 6 Ritual, Meteonis, Drytron, level >= 4
+                             */
+                            };}
+
+    //Could be expanded a bit
+    Protection = {scenario = {[Called By The Grave] OR ([Herald of Orange Light] AND ([Herald of Orange Light] OR [Eva] OR [Cyber Angel Natasha]))};}
+
+    Pre-BODE =  {scenario = {<Alpha + Zeta> OR <Mu-Beta> OR <Beatrice>};}
+
+    Ursatron = {scenario = {
+                            ([Ursarctic Drytron] AND [Ursarctic Big Dipper] AND ([Drytron Nova] OR (([Drytron  Alpha Thuban] OR [Cyber Emergency]) AND (<Effective Ritual> OR <Effective Drytron Monster>)))) OR
+                            (([Drytron Nova] OR [Ursarctic Drytron]) AND <Effective Drytron Fafnir>)
+                           };}
+
+    Post-BODE = {scenario = {<Pre-BODE> OR <Ursatron>};}
+
+    Protected Post-BODE = {scenario = {<Post-BODE> AND <Protection>};}
+}

Input/Drytron.txt

@@ -2,13 +2,25 @@
 
 ## Introduction
 
-This application calculates the chance of drawing a particular hand from a given finite deck. Both are defined at runtime. Obviously, hands are drawn without replacement. The calculation is performed through simulation (due to the mathematics being a bit too complex for the complicated expressions that a user may define).
+This application calculates the chance of drawing a particular hand from a given finite deck. Both are defined at runtime. Obviously, hands are drawn without replacement. The calculation is performed through simulation (due to the mathematics requiring a dynamic exponential equation to account for overlapping scenarios).
 
 Pull requests welcome.
 
 ## How To Use
 
-//TODO: complete when application is ready for deployment
+### Prerequisites
+
+Are simply at least Java 8 and a configuration file to read. In terms of hardware, the program is written to either run in sequential mode which uses the minimum about of resources or parallel mode. Parallel mode is written to automatically adjust its resource use based on available hardware.
+
+One can simply check that they have Java installed by running the command `java -version` in one's terminal. Of it says something like 1.8... (or higher) then it is probably installed properly. Otherwise go install it, is a rather simple process. 
+
+### How to Run
+
+Simply enter into a terminal `java -jar Hand_Probability_Calculator_V1_GTH_2021.jar`. The JAR can be run from anywhere, just specify its location.
+
+Typically one will also specify some additional arguments, such as both "--input" and "--simulation_results_console". An explanation on them can be found in the Command Line Arguments section.
+
+The format for running with arguments is `java -jar Hand_Probability_Calculator_V1_GTH_2021.jar --arguments -flags`. The combination of both flags and arguments, can be placed in any order.
 
 ## Command Line Arguments
 
@@ -21,7 +33,7 @@ The lack of any of the following will result in their corresponding default valu
 - --verbose: is for all files relating to error logs to be created. As well as for files that shows the progress of the program.
 - --scenario_output_flag: outputs all scenarios in dot file format. Be careful with using this, as it creates a lot of files, about equal to all the other output files that the other flags would create, combined.
 - --simulation_results_console: to have the simulation results be output to console instead of in a created file.
-- --force_sequential: to force the program to perform the simulation sequentially rather then allowing the program to pick sequential or parallel.
+- --force_sequential: to force the program to perform the simulation sequentially rather than allowing the program to pick sequential or parallel.
 
 ### Parameters
 

README.md

@@ -499,7 +499,7 @@ protected void modulate_parallelization()
                     //10 ensures that lowest possible argument will still result in a value greater than 1.
                     if (BLOCKING_QUEUE_SIZE > UPPER_THRESHOLD)
                     {
-                        this.partition_count *= Math.log10(10 + BLOCKING_QUEUE_SIZE - UPPER_THRESHOLD);
+                        this.partition_count *= Math.log10(10 - UPPER_THRESHOLD + BLOCKING_QUEUE_SIZE);
                         this.set_partition_count_related_values();
                     }
                     else if (LOWER_THRESHOLD > BLOCKING_QUEUE_SIZE)
@@ -542,12 +542,13 @@ protected void run_subroutine(final int START, final int END)
 
         synchronized (Simulation.PARALLEL_SIMULATION_LOCK)
         {
+            TASK_OVERSEER.prestartAllCoreThreads();
             START_TIME = System.currentTimeMillis();
             TASK_OVERSEER.execute(new Task_Manager(TASK_OVERSEER, HITS, this.DECK, this.FOREST));
 
             try
             {
-                final int MAX_DURATION = 15;
+                final int MAX_DURATION = 10;
                 final TimeUnit TEMPORAL_UNIT = TimeUnit.MINUTES;
                 final String TEMPORAL_UNIT_TEXT = TEMPORAL_UNIT.name().toLowerCase();
                 if (!TASK_OVERSEER.awaitTermination(MAX_DURATION, TEMPORAL_UNIT))

simulation/Simulation.java

@@ -112,7 +112,7 @@ public class Starting_Point
      * Name of the authors of this program and where it can be downloaded from
      */
     public final static String AUTHORS = "Created by both Gabriel Toban Harris and Alexander Oxorn. " +
-                                         "Most recent releases can be found at \"https://github.com/Gabriel-T-Harris/Hand_Probability_Calculator\".";
+                                         "Most recent release can be found at \"https://github.com/Gabriel-T-Harris/Hand_Probability_Calculator\".";
 
     /**
      * Simple pattern that matches using the predefined horizontal whitespace character. Equivalent to "[ \t\xA0\u1680\u180e\u2000-\u200a\u202f\u205f\u3000]".

starting_point/Starting_Point.java

@@ -57,7 +57,9 @@ interface RollbackCallback {
         TestResult call();
     }
 
-    //TODO: add javadoc
+    /**
+     * Essentially acts like ifdef for sections of code.
+     */
     public final static boolean debugMode = false;
 
     /**