All Classes

Class	Description
Benchmarker	Used to time the execution duration of a run.
ByteArray	A tester class that uses bytes instead of longs to store vectors of 8-bits.
Code	The definition of a mathematical linear code.
CodeDisplayParameters	A wrapper class containing the information of what should be displayed on console as output.
CodeExporter	Exports the code found to file as a persistent object, \(\LaTeX\) and Matlab files.
CodeExporterParameters	Stores the options of a code when being exported.
CodeObjectIO	Exports the code found to file as a persistent object (.bin file).
CodeOperations	The operations a mathematical linear code.
CodeParameters	Stores the parameters of a code when being created.
CodeStatistics	The code statistics is responsible for benchmarking the statistics run of a code.
CodeValidator	The code validator that will ensure the code that was obtained is valid by checking that the generator matrix, orthogonal linear combinations, minimum distance etc.
CodeValidatorParameters	Stores the options of a code \(\mathsf{C}\) when being validated to ensure the generator matrix \(G\) does satisfy the necessary requirements of the \(\left[n, \, k, \, d\right]_{base}\) code found.
ComplexExecutor	A complete execution class that initializes all possible parameters in this program from the \(n\), \(k\), \(d\) values to the code parameters, code validator parameters, code export parameters and code display parameters.
DirectoryCreator	The creation of directories and files is taken care of here.
Functions	A class contains static variables and methods to be used globally across the classes in this program.
GF4Operations	A way to perform mathematical operations in \(\mathbb{F}_4\).
HammingWeight	A way to find the Hamming weight for vectors in base \(2\) or \(4\).
HammingWeightTester	Ensures the optimal Hamming weight approach used in this program matched the expected result.
InvalidBaseException	An exception that can be thrown when an invalid base is trying to be used.
InvalidCodeParameters	An exception that can be thrown when an invalid code parameters (\(n\) and/or \(k\)) of a code \(\mathsf{C}\) is trying to be used.
InvalidColIndexException	An exception that can be thrown when an invalid column index in some matrix is trying to be accessed.
InvalidColumnDimensionToSetException	An exception that can be thrown when trying to override a specific column in the matrix with a column vector that doesn't match the matrix's dimension.
InvalidColumnVectorDimensionException	An exception that can be thrown when the number of rows in a column vector exceeds the allowable limit.
InvalidDigitException	An exception that can be thrown when an invalid digit is being used in the code.
InvalidIdentityRowIndexException	An exception that can be thrown when an invalid row index is specified in the identity submatrix of the generator matrix \(G\).
InvalidMatricesBases	An exception that can be thrown when the bases of two matrices don't match.
InvalidMatrixDimensionsException	An exception that can be thrown when the dimensions of two matrices don't match for multiplication.
InvalidMinimumDistanceException	An exception that can be thrown when the minimum distance specified is less than \(3\).
InvalidRowIndexException	An exception that can be thrown when an invalid row index in some matrix is trying to be accessed.
LatexMatrixWriter	Exports the generator matrix \(G\) of the code \(\mathsf{C}\) as a .tex file.
LatexWeightEnumeratorWriter	Exports the weight enumerator of some code \(\mathsf{C}\) as a .tex file.
ListExecutor	Runs the list of parameters and test all the parameters read (parameters with \(d \ge 3\)).
LongArray	A structure for storing the linear combinations of the code.
MatlabCodeWriter	Exports the code found to file as a Matlab .m file.
MatlabDeterminantTester	Creates a Matlab file to ensure the correctness of the Bareiss Algorithm implemented in this program for finding the determinant of quaternary square matrices.
MatlabMatrixTester	Creates a Matlab file to test the logic of transposing a matrix, finding the Hermitian transpose of a matrix and matrix multiplication.
MatlabScriptCreator	Creates the main Matlab script to run all the file(s) generated based on the number of run specified in the Tester classes.
Matrix	Defines a matrix as a 1-D array where there are 62 columns.
MatrixCellAccessorTester	Tests the logic of getting and setting cells in the matrix.
MatrixOperations	Defines the operations of a matrix.
MatrixPrinter	Prints a matrix nicely on console.
ParametersLoader	A way to load a list of parameters of quaternary codes from a .txt file.
Paths	A class contains the paths of reading/writing from/to directories and files.
QuaternaryVectorMultiplicationTester	Test the multiplication logic of two rows vectors being multiplied by each other.
RandomMatrixGenerator	Generates a random matrix based on the parameters specified.
RandomVectorGenerator	Creates a random long value based on the specified n and base values in the constructor.
SegmentSplitter	Uses a 1-D array of ints to mimic the splitting of segments.
SimpleExecutor	A simple execution class that will search for the \(n\), \(k\), \(d\) and base values assigned/hardcoded in the constructor.
Style	An enum for choosing how should a matrix in the program be displayed.
TesterParameters	A wrapper class containing the parameters needed to write a Matlab script for testing the program.
TestParameter	Starts the execution of finding if the parameters specified of a code are valid automatically once a constructor is called.
VectorGenerator	The generator of potential codewords in a sequential order.
WeightEnumerator	Creates the weight enumerator of the codewords in the code in the form of: \(\operatorname{w}(x)_{\mathsf{C}} = A_{0} + A_{1}x + A_{2}x^2 + \ldots + A_{n- 2}x^{n-2} + A_{n - 1}x^{n-1} + A_nx^n\), where \(A_{i}\) is the number of codewords in \(\mathsf{C}\) whose Hamming weight is \(i\).