Package hlcd.parameters

Class CodeExporterParameters

java.lang.Object

hlcd.parameters.CodeExporterParameters

public class CodeExporterParameters
extends Object

Stores the options of a code when being exported. The default constructor will set all options to true and write the code object, the generator matrix as \(\LaTeX\) and Matlab files, as well as the weight enumerator of the code as a \(\LaTeX\) file.

Since:

1.8

Version:

1.0 (January 20th, 2022)

Author:

Maysara Al Jumaily

Constructor Summary

Constructors

Constructor	Description
CodeExporterParameters()	Writes all data to file: the code object, the generator matrix as \(\LaTeX\) and Matlab files, as well as the weight enumerator of the code as a \(\LaTeX\) file.
CodeExporterParameters(boolean writeCodeObject, boolean writeMatrixAsMatlab, boolean writeGMatrixAsLatex, boolean writeWeightEnumeratorAsLatex)	Accepts the code being exported as well as the options associated with it.

Method Summary

Modifier and Type	Method	Description
boolean	isCodeObjectWritable()	Should the code object be written to file.
boolean	isGMatrixLatexWritable()	Should write the generator matrix of the code as a .tex file.
boolean	isGMatrixMatlabWritable()	Should write the generator matrix of the code as a .m (Matlab) file.
boolean	isWeightEnumeratorAsLatexWritable()	Should write the weight enumerator of the code be written as a .tex file.
void	setCodeObjectWritableStatus(boolean status)	Sets the value of whether the code object should be written to file.
void	setGMatrixLatexWritableStatus(boolean status)	Sets the value of whether the generator matrix should be written as a .tex file.
void	setGMatrixMatlabWritableStatus(boolean status)	Sets the value of whether the generator matrix should be written as a .m (Matlab) file.
void	setWeightEnumeratorAsLatexStatus(boolean status)	Sets the value of whether the weight enumerator should be written as a .tex file.

Methods inherited from class java.lang.Object

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

Constructor Details

CodeExporterParameters

public CodeExporterParameters()

Writes all data to file: the code object, the generator matrix as \(\LaTeX\) and Matlab files, as well as the weight enumerator of the code as a \(\LaTeX\) file.

CodeExporterParameters

public CodeExporterParameters(boolean writeCodeObject,
 boolean writeMatrixAsMatlab,
 boolean writeGMatrixAsLatex,
 boolean writeWeightEnumeratorAsLatex)

Accepts the code being exported as well as the options associated with it.

Parameters:

writeCodeObject - should write the code as .bin file

writeMatrixAsMatlab - should write the code as a .m Matlab executable file

writeGMatrixAsLatex - should typeset the generator matrix as a .tex \(\LaTeX\) file

writeWeightEnumeratorAsLatex - should typeset the weight enumerator of the code as a .tex \(\LaTeX\) file

Method Details

isCodeObjectWritable

public boolean isCodeObjectWritable()

Should the code object be written to file.

Returns:

true if the code object should be written to file, false otherwise

setCodeObjectWritableStatus

public void setCodeObjectWritableStatus(boolean status)

Sets the value of whether the code object should be written to file.

Parameters:

status - the new value to set as

isGMatrixLatexWritable

public boolean isGMatrixLatexWritable()

Should write the generator matrix of the code as a .tex file.

Returns:

true if the generator matrix should be written as a .tex file, false otherwise

setGMatrixLatexWritableStatus

public void setGMatrixLatexWritableStatus(boolean status)

Sets the value of whether the generator matrix should be written as a .tex file.

Parameters:

status - the new value to set as

isWeightEnumeratorAsLatexWritable

public boolean isWeightEnumeratorAsLatexWritable()

Should write the weight enumerator of the code be written as a .tex file.

Returns:

true if the weight enumerator should be written as a .tex file, false otherwise

setWeightEnumeratorAsLatexStatus

public void setWeightEnumeratorAsLatexStatus(boolean status)

Sets the value of whether the weight enumerator should be written as a .tex file.

Parameters:

status - the new value to set as

isGMatrixMatlabWritable

public boolean isGMatrixMatlabWritable()

Should write the generator matrix of the code as a .m (Matlab) file.

Returns:

true if the generator matrix should be written as a .tex file, false otherwise

setGMatrixMatlabWritableStatus

public void setGMatrixMatlabWritableStatus(boolean status)

Sets the value of whether the generator matrix should be written as a .m (Matlab) file.

Parameters:

status - the new value to set as