Function freeHeapMatrix

quest/src/api/matrices.cpp:86–117

// type T can be CompMatr, DiagMatr or FullStateDiagMatr
template <class T>
void freeHeapMatrix(T matr) {

    // WARNING: this is not overwriting any freed pointers with null, 
    // since the caller's struct is not changed. This is fine here,
    // but would be an issue if the struct contained nested pointers,
    // since caller would not know an outer pointer was freed and
    // ergo that it should not be enumerated (to check/free inner ptr)

    // free the 1D or 2D matrix - safe even if nullptr
    if constexpr (util_isDenseMatrixType<T>()) {
        cpu_deallocMatrixWrapper(matr.cpuElems);
        cpu_deallocArray(matr.cpuElemsFlat);
    } else
        cpu_deallocArray(matr.cpuElems);

    // we avoid invoking a GPU function in non-GPU mode
    auto gpuPtr = util_getGpuMemPtr(matr);
    if (mem_isAllocated(gpuPtr))
        gpu_deallocArray(gpuPtr);

    // free the teeny tiny heap flags
    util_deallocEpsilonSensitiveHeapFlag(matr.isApproxUnitary);
    util_deallocEpsilonSensitiveHeapFlag(matr.isApproxHermitian);
    cpu_deallocHeapFlag(matr.wasGpuSynced);

    // only diagonal matrices (which can be raised to
    // exponents) need their negativity/zeroness checked
    if constexpr (!util_isDenseMatrixType<T>()) {
        util_deallocEpsilonSensitiveHeapFlag(matr.isApproxNonZero);
        cpu_deallocHeapFlag(matr.isStrictlyNonNegative);
    }
}


// type T can be CompMatr, DiagMatr or FullStateDiagMatr