Package hlcd.parameters

Class CodeDisplayParameters

java.lang.Object

hlcd.parameters.CodeDisplayParameters

public class CodeDisplayParameters
extends Object

A wrapper class containing the information of what should be displayed on console as output.

Since:

1.8

Version:

1.0 (February 24th, 2022)

Author:

Maysara Al Jumaily

Constructor Summary

Constructors

Constructor	Description
CodeDisplayParameters()	Uses the default values which are to print the generator matrix, the determinant of the generator matrix, the statistics of the code and the file path of where the data will be written to.
CodeDisplayParameters(boolean printGeneratorMatrix, boolean printGeneratorGPrimeDet, boolean printGPrime, boolean printCombinations, boolean printWeightEnumerator, boolean printCodeStatistics, boolean printFilePath)	Allows to choose the data to be displayed to console.

Method Summary

Modifier and Type	Method	Description
boolean	shouldPrintCodeStatistics()	Whether the code statistics should be printed on console.
boolean	shouldPrintCombinations()	Whether the codewords in the code should be printed on console.
boolean	shouldPrintFilePath()	Whether the directory used to write the files to should be printed on console.
boolean	shouldPrintGeneratorMatrix()	Whether the generator matrix should be printed on console.
boolean	shouldPrintGPrime()	Whether \(G^{\prime} = G^{\kern0pt}_{k \times n} \overline{G}^{T}_{n \times k}\) should be printed on console.
boolean	shouldPrintGPrimeDet()	Whether the determinant of \(G^{\prime} = G^{\kern0pt}_{k \times n} \overline{G}^{T}_{n \times k}\) should be printed on console.
boolean	shouldPrintWeightEnumerator()	Whether the weight enumerator of the code should be printed on console.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CodeDisplayParameters

public CodeDisplayParameters()

Uses the default values which are to print the generator matrix, the determinant of the generator matrix, the statistics of the code and the file path of where the data will be written to.

CodeDisplayParameters

public CodeDisplayParameters(boolean printGeneratorMatrix,
 boolean printGeneratorGPrimeDet,
 boolean printGPrime,
 boolean printCombinations,
 boolean printWeightEnumerator,
 boolean printCodeStatistics,
 boolean printFilePath)

Allows to choose the data to be displayed to console.

Parameters:

printGeneratorMatrix - should the generator matrix be printed

printGeneratorGPrimeDet - should the determinant of the G prime which is \(G^{\prime} = G^{\kern0pt}_{k \times n} \overline{G}^{T}_{n \times k}\)

printGPrime - print \(G^{\prime} = G^{\kern0pt}_{k \times n} \overline{G}^{T}_{n \times k}\)

printCombinations - print all the codewords in the code

printWeightEnumerator - print the weight enumerator of the code

printCodeStatistics - print the statistics of the code

printFilePath - print the filepath used to write the files to

Method Details

shouldPrintGeneratorMatrix

public boolean shouldPrintGeneratorMatrix()

Whether the generator matrix should be printed on console.

Returns:

true if the generator matrix should be printed on console, false otherwise

shouldPrintGPrimeDet

public boolean shouldPrintGPrimeDet()

Whether the determinant of \(G^{\prime} = G^{\kern0pt}_{k \times n} \overline{G}^{T}_{n \times k}\) should be printed on console.

Returns:

true if the determinant of \(G^{\prime} = G^{\kern0pt}_{k \times n} \overline{G}^{T}_{n \times k}\) should be printed on console, false otherwise

shouldPrintGPrime

public boolean shouldPrintGPrime()

Whether \(G^{\prime} = G^{\kern0pt}_{k \times n} \overline{G}^{T}_{n \times k}\) should be printed on console.

Returns:

true if \(G^{\prime} = G^{\kern0pt}_{k \times n} \overline{G}^{T}_{n \times k}\) should be printed on console, false otherwise

shouldPrintCombinations

public boolean shouldPrintCombinations()

Whether the codewords in the code should be printed on console.

Returns:

true if the codewords in the code should be printed on console, false otherwise

shouldPrintWeightEnumerator

public boolean shouldPrintWeightEnumerator()

Whether the weight enumerator of the code should be printed on console.

Returns:

true if the weight enumerator of the code should be printed on console, false otherwise

shouldPrintCodeStatistics

public boolean shouldPrintCodeStatistics()

Whether the code statistics should be printed on console.

Returns:

true if the code statistics of the code should be printed on console, false otherwise

shouldPrintFilePath

public boolean shouldPrintFilePath()

Whether the directory used to write the files to should be printed on console.

Returns:

true if the directory used to write the files to should be printed on console, false otherwise