Functions to control QuEST's user-input validation. More...

Functions
qreal	getValidationEpsilon ()

void	setInputErrorHandler (void(callback)(const char func, const char *msg))

void	setValidationEpsilon (qreal eps)

void	setValidationEpsilonToDefault ()

void	setValidationOff ()

void	setValidationOn ()

Detailed Description

Functions to control QuEST's user-input validation.

These can be used to adjust the precision with which properties like unitarity are checked/enforced, or otherwise disable all input validation (e.g. is the given qubit index valid?). Note passing erroneous input while validation is disabled can result in runtime errors like segmentation faults.

Function Documentation

◆ getValidationEpsilon()

qreal getValidationEpsilon ( )

Note: Documentation for this function or struct is under construction!

Definition at line 115 of file debug.cpp.

                             {
    validate_envIsInit(__func__);
 
    return validateconfig_getEpsilon();
}

◆ setInputErrorHandler()

void setInputErrorHandler ( void(* callback )(const char *func, const char *msg) )

Note: Documentation for this function or struct is under construction!

See also

C and C++ examples

Definition at line 74 of file debug.cpp.

                                                                      {
    validate_envIsInit(__func__);
 
    validateconfig_setErrorHandler(callback);
}

◆ setValidationEpsilon()

void setValidationEpsilon ( qreal eps )

Note: Documentation for this function or struct is under construction!

Definition at line 100 of file debug.cpp.

                                     {
    validate_envIsInit(__func__);
    validate_newEpsilonValue(eps, __func__);
 
    validateconfig_setEpsilon(eps);
    util_setEpsilonSensitiveHeapFlagsToUnknown();
}

Referenced by TEST_CASE(), TEST_CASE(), and TEST_CASE().

◆ setValidationEpsilonToDefault()

void setValidationEpsilonToDefault ( )

Note: Documentation for this function or struct is under construction!

Definition at line 108 of file debug.cpp.

                                     {
    validate_envIsInit(__func__);
 
    validateconfig_setEpsilonToDefault();
    util_setEpsilonSensitiveHeapFlagsToUnknown();
}

Referenced by TEST_CASE(), TEST_CASE(), and TEST_CASE().

◆ setValidationOff()

void setValidationOff ( )

Note: Documentation for this function or struct is under construction!

Definition at line 86 of file debug.cpp.

                        {
    validate_envIsInit(__func__);
 
    // disables all validation and computation
    // of matrix properties like isUnitary. Also
    // means pre-computed matrix properties are
    // ignored. It does not however erase pre-
    // computed properties; subsequently restoring 
    // validation will not necessitate re-eval.
 
    validateconfig_disable();
}

Referenced by TEST_CASE().

◆ setValidationOn()

void setValidationOn ( )

Note: Documentation for this function or struct is under construction!

Definition at line 80 of file debug.cpp.

                       {
    validate_envIsInit(__func__);
    
    validateconfig_enable();
}

Referenced by TEST_CASE().