Serialized Form

  • Package hlcd.exceptions

  • Package hlcd.linearCode

    • Class hlcd.linearCode.Code extends Object implements Serializable

      • Serialized Fields

        • BASE
          byte BASE
          The base of the code which can be either 2 or 4.
        • codeStatistics
          CodeStatistics codeStatistics
          The code statistics that benchmarks the run of a code. It contains the duration of the execution, the code parameters and the validator parameters used.
        • cp
          CodeParameters cp
          The code parameters which includes n, k, d, base and other properties such as having the generator matrix in standard form, if the code is Hermitian LCD, etc.
        • cvp
          CodeValidatorParameters cvp
          The parameters for the validator after the code completes to ensure the code is valid (and the program is bug-free).
        • D
          byte D
          The minimum distance between any two codewords in code.
        • K
          byte K
          The dimension of the code (and the number of rows in the generator matrix).
        • matrix
          Matrix matrix
          The generator matrix that contains G, G transpose, G Hermitian transpose.
        • N
          byte N
          The length of each codeword in the code.
        • recursiveCallsCount
          long recursiveCallsCount
          The number of recursive calls needed to arrive to a solution.
        • RHS_WEIGHT
          byte RHS_WEIGHT
          The minimum weight of far-right n - k values.

    • Class hlcd.linearCode.CodeStatistics extends Object implements Serializable

      • Serialized Fields

        • cp
          CodeParameters cp
          The code parameters which includes \(n\), \(k\), \(d\), base and other properties such as having the generator matrix in standard form, if the code is Hermitian LCD, etc.
        • cvp
          CodeValidatorParameters cvp
          The code validator parameters which includes what kind of tests should be executed to ensure the code found is correct and that there aren't bugs present.
        • endTime
          long endTime
          The end time of the execution.
        • lapsedTime
          String lapsedTime
          The time duration of the entire execution written in the following human-readable format: 00h:00m:00s.000.
        • recursiveCallsCount
          long recursiveCallsCount
          The number of recursive calls needed to arrive to the solution.
        • startTime
          long startTime
          The start time of the execution.
        • totalTime
          long totalTime
          The time duration of the entire execution.

  • Package hlcd.operations

    • Class hlcd.operations.Matrix extends Object implements Serializable

      • Serialized Fields

        • base
          byte base
          The base of the code which can be either 2 or 4.
        • k
          byte k
          The dimension of the code (and the number of rows in the matrix).
        • matrixArray
          long[] matrixArray
          The structure used to store a matrix.
        • n
          byte n
          The length of each codeword in the code.

  • Package hlcd.parameters

    • Class hlcd.parameters.CodeParameters extends Object implements Serializable

      • Serialized Fields

        • appendIdentity
          boolean appendIdentity
          Should the identity matrix be appended (i.e., the matrix is in standard form).
        • base
          byte base
          The base of the code which can be either 2 or 4.
        • d
          byte d
          The minimum distance between any two codewords in code.
        • isHlcd
          boolean isHlcd
          Whether the code is Hermitian LCD.
        • isMultithreaded
          boolean isMultithreaded
          Should multithreading be used.
        • k
          byte k
          The dimension of the code (and the number of rows in the generator matrix).
        • n
          byte n
          The length of each codeword in the code.
        • restrictCodewordGeneration
          boolean restrictCodewordGeneration
          Should the codeword restriction be applied to significantly cut down the search space.
        • rhsWeight
          byte rhsWeight
          The minimum weight of far-right n - k values.

    • Class hlcd.parameters.CodeValidatorParameters extends Object implements Serializable

      • Serialized Fields

        • checkDeterminant
          boolean checkDeterminant
          Checks if the determinant of the matrix is not zero.
        • checkHLCDProperty
          boolean checkHLCDProperty
          Checks if the Hermitian LCD property is satisfied. It will examine all the vectors in the space, seeing which are orthogonal to all the codewords in the code, then, ensures these vectors are not a part of the codewords in \(\mathsf{C}\). This should be left as false because it will take significant amount of time to complete.
        • checkUniqueness
          boolean checkUniqueness
          Checks if all codewords in the code are unique and that there doesn't exist duplicates in the codewords.
        • checkValidMinimumDistance
          boolean checkValidMinimumDistance
          Checks if the minimum distance of the code is satisfied by examining each codeword and ensuring it has the appropriate weight of larger or equal to \(d\).
        • checkZeroVectors
          boolean checkZeroVectors
          Checks if the linear combinations contain a single zero vector, the default zero vector, that is found in the 0th index of the combinations. Note that Java will automatically initialize all the cells in the array to 0's.
        • printInvalidEntries
          boolean printInvalidEntries
        • replicateLinearCombinations
          boolean replicateLinearCombinations
          Checks if the linear combinations found can be replicated by finding the linear combinations of the codewords in the generator matrix.
        • stopWhenFalseEncountered
          boolean stopWhenFalseEncountered
          Should stop the validator once a single test fails (i.e., recognizing that the code is invalid).