Reporters

Functions for printing Qureg states or reporting their configuration. More...

Functions
void	reportQureg (Qureg qureg)
void	reportQuregParams (Qureg qureg)

Detailed Description

Functions for printing Qureg states or reporting their configuration.

Function Documentation

reportQureg()

void reportQureg

(

Qureg

qureg

)

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 371 of file qureg.cpp.

                              {
    validate_quregFields(qureg, __func__);
    validate_numReportedNewlinesAboveZero(__func__); // because trailing newline mandatory
 
    // account all local CPU memory (including buffer), neglecting GPU memory
    // because it occupies distinct memory spaces, confusing accounting
    size_t localMem = mem_getLocalQuregMemoryRequired(qureg.numAmpsPerNode);
    if (qureg.isDistributed)
        localMem *= 2; // include buffer. @todo will this ever overflow?!?!
    
    // include struct size (expected negligibly tiny)
    localMem += sizeof(qureg);
 
    print_header(qureg, localMem);
    print_elems(qureg);
 
    // exclude mandatory newline above
    print_oneFewerNewlines();
}

reportQuregParams()

void reportQuregParams

(

Qureg

qureg

)

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 353 of file qureg.cpp.

                                    {
    validate_quregFields(qureg, __func__);
    validate_numReportedNewlinesAboveZero(__func__); // because trailing newline mandatory
 
    /// @todo add function to write this output to file (useful for HPC debugging)
 
    // printer routines will consult env rank to avoid duplicate printing
    print_label("Qureg");
    printDeploymentInfo(qureg);
    printDimensionInfo(qureg);
    printDistributionInfo(qureg);
    printMemoryInfo(qureg);
 
    // exclude mandatory newline above
    print_oneFewerNewlines();
}