G-Index (HLCD Javadoc)

A B C D E F G H I J L M O P Q R S T V W
All Classes|All Packages|Constant Field Values|Serialized Form

G

get(long) - Method in class hlcd.operations.LongArray: Returns a specific element in the combination array.
get(long) - Method in class hlcd.testing.arrayTester.ByteArray: Returns a specific element in the combination array.
getBase() - Method in class hlcd.linearCode.Code
getBase() - Method in interface hlcd.linearCode.CodeOperations: Returns the base of the \(\left[n, \, k, \, d\right]_{base}\) code.
getBase() - Method in class hlcd.operations.HammingWeight: Returns the base the Hamming weight calculator is operating in.
getBase() - Method in class hlcd.operations.Matrix
getBase() - Method in interface hlcd.operations.MatrixOperations: Returns the base of the current matrix which is equivalent to the base of the code \(\mathsf{C}\).
getBase() - Method in class hlcd.operations.RandomMatrixGenerator: Returns the base which could either be \(2\) or \(4\).
getBase() - Method in class hlcd.operations.VectorGenerator: Returns the base of the code which could either be \(2\) or \(4\).
getBase() - Method in class hlcd.parameters.CodeParameters: Returns the base of the \(\left[n, \, k, \, d\right]_{base}\) code.
getCell(byte, byte) - Method in class hlcd.operations.Matrix
getCell(byte, byte) - Method in interface hlcd.operations.MatrixOperations: Returns the value of a cell based on the row index and column index specified.
getCell(long[], byte, byte, byte, byte) - Method in class hlcd.operations.Matrix
getCell(long[], byte, byte, byte, byte) - Method in interface hlcd.operations.MatrixOperations: Returns the value of a cell based on the specified matrix array, row index and column index.
getCell(Matrix, byte, byte) - Method in class hlcd.operations.Matrix
getCell(Matrix, byte, byte) - Method in interface hlcd.operations.MatrixOperations: Returns the value of a cell based on the specified matrix, row index and column index.
getCode() - Method in class hlcd.run.TestParameter: Returns the code found.
getCodeParameters() - Method in class hlcd.linearCode.Code: Returns the code parameters of the code.
getCodeParameters() - Method in class hlcd.linearCode.CodeStatistics: Returns the code parameters associated with the code.
getCodeStatistics() - Method in class hlcd.linearCode.Code
getCodeStatistics() - Method in interface hlcd.linearCode.CodeOperations: Returns the code statistics which includes the total time taken, parameters of the code and parameters of the validator used.
getCodeValidatorParameters() - Method in class hlcd.linearCode.Code
getCodeValidatorParameters() - Method in interface hlcd.linearCode.CodeOperations: Returns the code validator parameters of the code.
getCodeValidatorParameters() - Method in class hlcd.linearCode.CodeStatistics: Returns the code validator parameters associated with the code.
getCodeWeightEnumerator() - Method in class hlcd.linearCode.Code: Returns the weight enumerator of the code.
getColumn(byte) - Method in class hlcd.operations.Matrix
getColumn(byte) - Method in interface hlcd.operations.MatrixOperations: Returns a column in the current matrix based on the index specified.
getColumn(long[], byte, byte, byte) - Method in class hlcd.operations.Matrix
getColumn(long[], byte, byte, byte) - Method in interface hlcd.operations.MatrixOperations: Returns a column in the matrix array specified based on the index specified.
getColumn(Matrix, byte) - Method in class hlcd.operations.Matrix
getColumn(Matrix, byte) - Method in interface hlcd.operations.MatrixOperations: Returns a column in the matrix specified based on the index specified.
getCombinations() - Method in class hlcd.linearCode.Code
getCombinations() - Method in interface hlcd.linearCode.CodeOperations: The linear combinations of the codewords in the code.
getCompletePath() - Method in class hlcd.exporter.CodeExporter: Returns the complete path of the directory to output to.
getCompletePath() - Method in class hlcd.operations.DirectoryCreator: Returns the complete path of the directory created.
getCurrentDateFormatted() - Static method in class hlcd.operations.Benchmarker: Returns the current time/date formatted in the following style: dd/MM/yyyy hh:mm:ss.SSS a.
getCurrentFullVector(byte) - Method in class hlcd.operations.VectorGenerator: Returns the current subvector with the identity row attached.
getCurrentSubvector() - Method in class hlcd.operations.VectorGenerator: returns the current subvector without the identity subvector.
getD() - Method in class hlcd.linearCode.Code
getD() - Method in interface hlcd.linearCode.CodeOperations: Returns the minimum distance of the \(\left[n, \, k, \, d\right]_{base}\) code.
getD() - Method in class hlcd.parameters.CodeParameters: Returns the minimum distance of the \(\left[n, \, k, \, d\right]_{base}\) code.
getDeterminant() - Method in class hlcd.operations.Matrix
getDeterminant() - Method in interface hlcd.operations.MatrixOperations: Uses Bareiss Algorithm to find the determinant of \(G^{\prime}\), which is \(G^{\kern0pt}_{k \times n} \overline{G}^{T}_{n \times k}\).
getDeterminant(Matrix) - Method in class hlcd.operations.Matrix
getDeterminant(Matrix) - Method in interface hlcd.operations.MatrixOperations: Uses Bareiss Algorithm to find the determinant of the matrix specified.
getDirectoryName() - Method in class hlcd.operations.DirectoryCreator: Returns the current directory name that was created.
getEndTime() - Method in class hlcd.linearCode.CodeStatistics: Returns the end time of the execution.
getExtension() - Method in class hlcd.testing.matlabChecker.TesterParameters: The extension of the files generated (which should be .m)
getGeneratorMatrix() - Method in class hlcd.linearCode.Code
getGeneratorMatrix() - Method in interface hlcd.linearCode.CodeOperations: Returns the generator matrix \(G\).
getGeneratorMatrixCopy() - Method in class hlcd.linearCode.Code
getGeneratorMatrixCopy() - Method in interface hlcd.linearCode.CodeOperations: Returns the matrix \(G\) as a brand-new copy (deep copy).
getGPrime() - Method in class hlcd.operations.Matrix
getGPrime() - Method in interface hlcd.operations.MatrixOperations: Returns the matrix \(G^{\prime}_{k \times k} = G^{\kern0pt}_{k \times n} \overline{G}^{T}_{n \times k}\) without altering the current matrix.
getGPrime(byte) - Method in class hlcd.operations.Matrix
getGPrime(byte) - Method in interface hlcd.operations.MatrixOperations: Returns the submatrix of \(G^{\prime}_{sub} = G^{\kern0pt}_{x \times n} \overline{G}^{T}_{n \times x}\), where \(x\) is the largest row index in \(G\) that is nonzero.
getHermitianVector(long) - Method in class hlcd.operations.GF4Operations: Returns the Hermitian equivalent of the vector passed.
getIterations() - Method in class hlcd.testing.matlabChecker.TesterParameters: Returns the number of iterations which is the number of tests in a single file.
getK() - Method in class hlcd.linearCode.Code
getK() - Method in interface hlcd.linearCode.CodeOperations: Returns the dimension of the \(\left[n, \, k, \, d\right]_{base}\) code.
getK() - Method in class hlcd.operations.Matrix
getK() - Method in interface hlcd.operations.MatrixOperations: Returns the number of rows in the current matrix which is equivalent to the dimension \(k\) of the code \(\mathsf{C}\).
getK() - Method in class hlcd.operations.RandomMatrixGenerator: Returns the number of row in the matrix array.
getK() - Method in class hlcd.parameters.CodeParameters: Returns the dimension of the \(\left[n, \, k, \, d\right]_{base}\) code.
getLapsedTime() - Method in class hlcd.linearCode.CodeStatistics: Returns the total time of the execution as a human-readable format.
getLapsedTime() - Method in class hlcd.operations.Benchmarker: Returns the time lapsed as a human-readable format.
getLapsedTime(long, long) - Static method in class hlcd.operations.Benchmarker: Returns the time lapsed as a human-readable format of the start and end time specified.
getMatrix() - Method in class hlcd.operations.Matrix
getMatrix() - Method in interface hlcd.operations.MatrixOperations: Returns the current matrix but not as a brand-new copy.
getMatrix() - Method in class hlcd.operations.RandomMatrixGenerator: Returns the current matrix array as a Matrix type.
getMatrixArray() - Method in class hlcd.operations.Matrix
getMatrixArray() - Method in interface hlcd.operations.MatrixOperations: Returns the current matrix array but not as a brand-new instance.
getMatrixArray() - Method in class hlcd.operations.RandomMatrixGenerator: Returns the current matrix array.
getMatrixArrayClone() - Method in class hlcd.operations.RandomMatrixGenerator: Returns a clone of the current matrix array.
getMatrixArrayCopy() - Method in class hlcd.operations.Matrix
getMatrixArrayCopy() - Method in interface hlcd.operations.MatrixOperations: Returns a brand-new copy of the current matrix array.
getMatrixArrayCopy(long[]) - Method in class hlcd.operations.Matrix
getMatrixArrayCopy(long[]) - Method in interface hlcd.operations.MatrixOperations: Returns a brand-new copy of the matrix array specified.
getMaxK() - Method in class hlcd.operations.RandomMatrixGenerator: Returns the maximum value of the \(k\) range.
getMaxK() - Method in class hlcd.testing.matlabChecker.TesterParameters: Returns the maximum value k can be.
getMaxN() - Method in class hlcd.operations.RandomMatrixGenerator: Returns the maximum value of the \(n\) range.
getMaxN() - Method in class hlcd.testing.matlabChecker.TesterParameters: Returns the maximum value n can be.
getMinimumRHSWeight() - Method in class hlcd.operations.VectorGenerator: Returns the minimum weight of the right-hand-side of a valid vector.
getMinK() - Method in class hlcd.operations.RandomMatrixGenerator: Returns the minimum value of the \(k\) range.
getMinK() - Method in class hlcd.testing.matlabChecker.TesterParameters: Returns the minimum value k can be.
getMinN() - Method in class hlcd.operations.RandomMatrixGenerator: Returns the minimum value of the \(n\) range.
getMinN() - Method in class hlcd.testing.matlabChecker.TesterParameters: Returns the minimum value n can be.
getN() - Method in class hlcd.linearCode.Code
getN() - Method in interface hlcd.linearCode.CodeOperations: Returns the length of each codeword in a \(\left[n, \, k, \, d\right]_{ base}\) code.
getN() - Method in class hlcd.operations.Matrix
getN() - Method in interface hlcd.operations.MatrixOperations: Returns the number of columns in the current matrix which is equivalent to the length \(n\) of the codeword in the code \(\mathsf{C}\).
getN() - Method in class hlcd.operations.RandomMatrixGenerator: Returns the number of columns in the matrix array.
getN() - Method in class hlcd.parameters.CodeParameters: Returns the length of each codeword in a \(\left[n, \, k, \, d\right]_{ base}\) code.
getNewCreatedFile(String, String, boolean) - Method in class hlcd.operations.DirectoryCreator: Creates a new file in the path specified based on the other data passed.
getNewCreatedFile(String, String, boolean, boolean) - Method in class hlcd.operations.DirectoryCreator: Creates a new file in the path specified based on the other data passed.
getNewCreatedFile(String, String, String, boolean, boolean) - Method in class hlcd.operations.DirectoryCreator: Creates a new file in the path specified based on the other data passed.
getNewDirectoryName() - Method in class hlcd.testing.matlabChecker.TesterParameters: Returns the directory name that will be created to store the files generated into.
getNextFullVector(byte) - Method in class hlcd.operations.VectorGenerator: Returns the next subvector with the identity row attached.
getNextSubVector() - Method in class hlcd.operations.VectorGenerator: Returns the next subvector that satisfy the weight RHS_WEIGHT, which is \(d - 1\).
getNumberOfRecursiveCalls() - Method in class hlcd.linearCode.Code: Returns the number of recursive calls required to arrive to the solution.
getParameters() - Method in class hlcd.run.ParametersLoader: Returns the parameters read from the file.
getPath() - Method in class hlcd.testing.matlabChecker.TesterParameters: Returns the path to write the files to without appending the directory name that will be used.
getRandomVector() - Method in class hlcd.testing.optimizationTester.RandomVectorGenerator: Returns a random vector based on n and base values specified in the constructor.
getRecursiveCallsCount() - Method in class hlcd.linearCode.CodeStatistics: Returns the number of recursive calls carried out during execution.
getResetPoint() - Method in class hlcd.operations.VectorGenerator: The current reset point which is a vector of Hamming weight of \(1\).
getRHSWeight() - Method in class hlcd.linearCode.Code
getRHSWeight() - Method in interface hlcd.linearCode.CodeOperations: Returns the minimum weight of the right-side of the generator matrix \(G\) that is in standard form, which is \(d - 1\).
getRHSWeight() - Method in class hlcd.parameters.CodeParameters: Returns the minimum weight of the right-side of the generator matrix \(G\) that is in standard form which should be \(d - 1\).
getRow(byte) - Method in class hlcd.operations.Matrix
getRow(byte) - Method in interface hlcd.operations.MatrixOperations: Returns a row in the current matrix based on the index specified.
getRow(long[], byte) - Method in class hlcd.operations.Matrix
getRow(long[], byte) - Method in interface hlcd.operations.MatrixOperations: Returns a row in the matrix array specified based on the index specified.
getRow(Matrix, byte) - Method in class hlcd.operations.Matrix
getRow(Matrix, byte) - Method in interface hlcd.operations.MatrixOperations: Returns a row in the matrix specified based on the index specified.
getRuns() - Method in class hlcd.testing.matlabChecker.TesterParameters: Returns the number of runs which is the same as the number of test files created.
getScriptName() - Method in class hlcd.testing.matlabChecker.TesterParameters: Returns the name of the script file that will execute all the test files.
getStartTime() - Method in class hlcd.linearCode.CodeStatistics: Returns the start time of the execution.
getTitle() - Method in class hlcd.testing.matlabChecker.TesterParameters: Returns the title of the script that will be written as a comment in the Matlab script.
getTotalInvalidMinimumDistanceVectors(LongArray, boolean) - Method in class hlcd.linearCode.CodeValidator: The engine that goes through the linear combination array and ensures that the minimum distance for each vector in the combinations satisfies the minimum distance requirement.
getTotalTime() - Method in class hlcd.linearCode.CodeStatistics: Returns the total time of the execution as a long.
getWeight(long) - Method in class hlcd.operations.HammingWeight: Returns the weight of the vector specified.
getWeight(long, byte) - Static method in class hlcd.operations.HammingWeight: Finds the weight of the vector in the base specified.
getWeight(long, byte) - Method in class hlcd.operations.VectorGenerator: Returns the weight of non-zero digits in the value passed.
getWeightEnumerator() - Method in class hlcd.operations.WeightEnumerator: Returns the weight enumerator result.
GF4Operations - Class in hlcd.operations: A way to perform mathematical operations in \(\mathbb{F}_4\).
GF4Operations() - Constructor for class hlcd.operations.GF4Operations: Creates a calculator that perform calculations in \(\mathbb{F}_4\).

A B C D E F G H I J L M O P Q R S T V W
All Classes|All Packages|Constant Field Values|Serialized Form