Reporting

Functions to control how QuEST's reporters display and truncate information. More...

Functions
void	setMaxNumReportedItems (qindex numRows, qindex numCols)
void	setMaxNumReportedSigFigs (int numSigFigs)
void	setNumReportedNewlines (int numNewlines)
void	setReportedPauliChars (const char *paulis)
void	setReportedPauliStrStyle (int style)

Detailed Description

Functions to control how QuEST's reporters display and truncate information.

Function Documentation

setMaxNumReportedItems()

void setMaxNumReportedItems	(	qindex	numRows,
		qindex	numCols )

Note

Documentation for this function or struct is under construction!

Warning

This function has not yet been unit tested and may contain bugs. Please use with caution!

Definition at line 128 of file debug.cpp.

                                                            {
    validate_envIsInit(__func__);
    validate_newMaxNumReportedScalars(numRows, numCols, __func__);
 
    // replace 0 values (indicating no truncation) with max-val,
    // since there can never be max(qindex)-many amps
    qindex max = std::numeric_limits<qindex>::max();
    numRows = (numRows == 0)? max : numRows;
    numCols = (numCols == 0)? max : numCols;
 
    printer_setMaxNumPrintedScalars(numRows, numCols);
}

setMaxNumReportedSigFigs()

void setMaxNumReportedSigFigs

(

int

numSigFigs

)

Note

Documentation for this function or struct is under construction!

‍This function does not affect the significant figures in printed memory sizes (e.g. 5.32 KiB) which is always shown with three significant figures (or four when in bytes, e.g. 1023 bytes).

Definition at line 142 of file debug.cpp.

                                              {
    validate_envIsInit(__func__);
    validate_newMaxNumReportedSigFigs(numSigFigs, __func__);
 
    printer_setMaxNumPrintedSigFig(numSigFigs);
}

setNumReportedNewlines()

void setNumReportedNewlines

(

int

numNewlines

)

Note

Documentation for this function or struct is under construction!

Definition at line 150 of file debug.cpp.

                                             {
    validate_envIsInit(__func__);
    validate_newNumReportedNewlines(numNewlines, __func__);
 
    printer_setNumTrailingNewlines(numNewlines);
}

setReportedPauliChars()

void setReportedPauliChars

(

const char *

paulis

)

Note

Documentation for this function or struct is under construction!

Warning

This function has not yet been unit tested and may contain bugs. Please use with caution!

Example

PauliStr str = getInlinePauliStr("XYZ", {0,10,20});
reportPauliStr(str);
 
setReportedPauliChars(".xyz");
reportPauliStr(str);

Definition at line 158 of file debug.cpp.

                                               {
    validate_envIsInit(__func__);
    validate_numPauliChars(paulis, __func__);
 
    printer_setPauliChars(paulis);
}

setReportedPauliStrStyle()

void setReportedPauliStrStyle

(

int

style

)

Note

Documentation for this function or struct is under construction!

Warning

This function has not yet been unit tested and may contain bugs. Please use with caution!

Example

PauliStr str = getInlinePauliStr("XYZ", {0,10,20});
 
setReportedPauliStrStyle(0);
reportPauliStr(str);
 
setReportedPauliStrStyle(1);
reportPauliStr(str);

Definition at line 166 of file debug.cpp.

                                        {
    validate_envIsInit(__func__);
    validate_reportedPauliStrStyleFlag(flag, __func__);
 
    printer_setPauliStrFormat(flag);
}