absrelcompare.m

Go to the documentation of this file.

function [isEqual, absDiff, isRelDiffTriggered, relDiff, absMRelDiff, reportStr] = absrelcompare(leftArr, rightArr, absTol, relTol, fNormOp)

import mxberry.core.checkvar;
import mxberry.core.checkmultvar;
import mxberry.core.throwerror;
%
FORMAT_SPEC='%.17g';
%
if ~(isequal(size(leftArr),size(rightArr))&&...
        isnumeric(leftArr)&&isnumeric(rightArr))
    throwerror('wrongInput:wrongArgs',['leftArr and rightArr must be ',...
        'numeric arrays with the same size']);
end
if ~(isnumeric(absTol)&&isscalar(absTol)&&(absTol>=0))
    throwerror('wrongInput:wrongAbsTol',['absTol', ...
        ' must be a nonnegative scalar']);
end
if ~(isempty(relTol)||(isscalar(relTol)&&(relTol>=0)))&&isnumeric(relTol)
    throwerror('wrongInput:wrongRelTol',['relTol', ...
        ' must be a nonnegative scalar']);
end
if ~mxberry.core.check.lib.isfunction(fNormOp)
    throwerror('wrongInput:wrongNormOp',['fNormOp must be ', ...
        'a function handle']);
end
%
diffArr = fNormOp(leftArr - rightArr);
absDiff = max(diffArr(:));
if isempty(absDiff)
    absDiff = [];
end
absRDiff = absDiff;
%
relDiff = [];
absMRelDiff = [];
%
isRelDiffTriggeredArr = (diffArr > absTol) & ~isempty(relTol);
isRelDiffTriggered = any(isRelDiffTriggeredArr(:));
if isRelDiffTriggered
    argSumNormArr = fNormOp(leftArr) + fNormOp(rightArr);
    isRelDiffTriggeredArr = isRelDiffTriggeredArr & ...
        (argSumNormArr > absTol);
    isRelDiffTriggered = any(isRelDiffTriggeredArr(:));
    if isRelDiffTriggered
        tempArr = zeros(size(diffArr));
        temp2Arr = tempArr;
        tempArr(isRelDiffTriggeredArr) = ...
            2 .* diffArr(isRelDiffTriggeredArr) ./ ...
            argSumNormArr(isRelDiffTriggeredArr);
        relDiff = max(tempArr(:));
        temp2Arr(tempArr == relDiff) = diffArr(tempArr == relDiff);
        absMRelDiff = max(temp2Arr(:));
        tempArr = zeros(size(diffArr));
        tempArr(~isRelDiffTriggeredArr) = diffArr(~isRelDiffTriggeredArr);
        absRDiff = max(tempArr(:));
    end
end
isEqual = all([absRDiff <= absTol, relDiff <= relTol]);
%
if nargout > 5
    if isEqual
        reportStr = '';
    else
        if isRelDiffTriggered
            reportStr = sprintf(strrep(['relative difference (FORMAT_SPEC) is greater', ...
                ' than the specified tolerance (FORMAT_SPEC); absolute', ...
                ' difference (FORMAT_SPEC), absolute tolerance (FORMAT_SPEC)'],...
                'FORMAT_SPEC',FORMAT_SPEC), relDiff, ...
                relTol, absMRelDiff, absTol);
        else
            reportStr = sprintf(strrep(['absolute difference (FORMAT_SPEC) is greater', ...
                ' than the specified tolerance (FORMAT_SPEC)'],...
                'FORMAT_SPEC',FORMAT_SPEC),...
                absDiff, absTol);
        end
    end
end