Package hlcd.run

Class ListExecutor

java.lang.Object
hlcd.run.ListExecutor
public class ListExecutor extends Object
Runs the list of parameters and test all the parameters read (parameters with \(d \ge 3\)). It has the ability to increase or decrease the minimum distance read by some offset. The offset is used when the minimum distance needs to be incremented/decremented, otherwise, keep offset as 0 to find the true minimum distance specified in the file. The offset is used when checking if there exists a more optimal value than the current optimal value found or a suboptimal value that is less than the best minimum distance found. It will run each parameter read and use the default properties that can be found in the TestParameter class. There will a .txt file summary generated stating whether a code is valid or not for each parameter. A typical list that can be read is found in the documentation of ParametersLoader. 
 //minimal example to execute this class:
 public static void main(String[] args) {
     System.out.println("Running ListExecutor...");
     String savePath = Paths.DEFAULT_PATH;
     String parametersPath = Paths.PARAMETERS_PATH;
     byte offset = 0;
     boolean beep = true;
     ListExecutor pes = new ListExecutor(
         savePath, parametersPath, offset, beep
     );
     System.out.println("ListExecutor completed.");
 }
Since:
1.8
Version:
1.0 (February 19th, 2022)
Author:
Maysara Al Jumaily
See Also:
TestParameter

  • Constructor Details

    • ListExecutor

      public ListExecutor​(String savePath, String parameterPath, byte offset, boolean beep)
      Initializes the test of running optimal parameters read from a file.
      Parameters:
      savePath - the path to save the summary of the run as well as the data that will be exported
      parameterPath - the path of the parameters file
      offset - the value for incrementing/decrementing the optimal distance found. Keep it as 0 if the true optimal distance needs to be tested
      beep - plays a beep sound to alter a single test has completed

  • Method Details

    • main

      public static void main​(String[] args)
      Executes the program.
      Parameters:
      args - the arguments specified but will be ignored