DiffUtil Namespace Reference

Functions
bool	checkRelativeDifference (const std::vector< double > &dat, const std::vector< double > &ref, double threshold)
	Returns true is relative difference is below threshold; prints informative output. More...
double	meanRelativeDifference (const SimulationResult &dat, const SimulationResult &ref)
	Returns sum of relative differences between each pair of elements: (a, b) -> 2*abs(a - b)/(a + b) ( and zero if a-b=0 ) More...
double	meanRelVecDiff (const std::vector< double > &dat, const std::vector< double > &ref)
	Returns relative difference between two data sets sum(dat[i] - ref[i])/ref[i]). More...
Datafield *	relativeDifferenceField (const Datafield &dat, const Datafield &ref)
	Returns Datafield representing relative difference of two histograms. More...

Function Documentation

checkRelativeDifference()

bool DiffUtil::checkRelativeDifference	(	const std::vector< double > &	dat,
		const std::vector< double > &	ref,
		double	threshold
	)

Returns true is relative difference is below threshold; prints informative output.

Definition at line 64 of file DiffUtil.cpp.

{
    if (*std::min_element(dat.begin(), dat.end()) == 0
        && *std::max_element(dat.begin(), dat.end()) == 0) {
        std::cerr << "FAILED: simulated data set is empty" << std::endl;
        return false;
    }
 
    try {
        const double diff = DiffUtil::meanRelVecDiff(dat, ref);
        if (diff > threshold) {
            std::cerr << "FAILED: relative deviation of dat from ref is " << diff
                      << ", above given threshold " << threshold << std::endl;
            return false;
        }
        if (diff)
            std::cerr << "- OK: relative deviation of dat from ref is " << diff
                      << ", within given threshold " << threshold << std::endl;
        else
            std::cout << "- OK: dat = ref\n";
        return true;
    } catch (...) {
        return false;
    }
}

References meanRelVecDiff().

Referenced by IOUtil::filesAgree().

Here is the call graph for this function:

meanRelativeDifference()

double DiffUtil::meanRelativeDifference	(	const SimulationResult &	dat,
		const SimulationResult &	ref
	)

Returns sum of relative differences between each pair of elements: (a, b) -> 2*abs(a - b)/(a + b) ( and zero if a-b=0 )

Returns sum of relative differences between each pair of elements: (a, b) -> 2*abs(a - b)/(|a| + |b|) ( and zero if a=b=0 within epsilon )

Definition at line 50 of file DiffUtil.cpp.

{
    if (dat.size() != ref.size())
        throw std::runtime_error("Error in DiffUtil::meanRelativeDifference: "
                                 "different number of elements");
    if (dat.empty())
        return 0.0;
    double sum_of_diff = 0.0;
    for (size_t i = 0; i < dat.size(); ++i)
        sum_of_diff += Numeric::relativeDifference(dat[i], ref[i]);
    return sum_of_diff / dat.size();
}

References SimulationResult::empty(), Numeric::relativeDifference(), and SimulationResult::size().

Here is the call graph for this function:

meanRelVecDiff()

double DiffUtil::meanRelVecDiff	(	const std::vector< double > &	dat,
		const std::vector< double > &	ref
	)

Returns relative difference between two data sets sum(dat[i] - ref[i])/ref[i]).

Definition at line 28 of file DiffUtil.cpp.

{
    ASSERT(dat.size() == ref.size());
    double diff = 0;
    for (size_t i = 0; i < dat.size(); ++i)
        diff += Numeric::relativeDifference(dat[i], ref[i]);
    diff /= dat.size();
    ASSERT(!std::isnan(diff));
    return diff;
}

References ASSERT, and Numeric::relativeDifference().

Referenced by checkRelativeDifference().

Here is the call graph for this function:

relativeDifferenceField()

Datafield * DiffUtil::relativeDifferenceField	(	const Datafield &	dat,
		const Datafield &	ref
	)

Returns Datafield representing relative difference of two histograms.

Definition at line 39 of file DiffUtil.cpp.

{
    ASSERT(dat.hasSameShape(ref));
    std::vector<double> out(dat.size());
    for (size_t i = 0; i < dat.size(); ++i)
        out[i] = Numeric::relativeDifference(dat.valAt(i), ref.valAt(i));
    return new Datafield(dat.frame().cloned_axes(), out);
}

References ASSERT, Frame::cloned_axes(), Datafield::frame(), Datafield::hasSameShape(), Numeric::relativeDifference(), Datafield::size(), and Datafield::valAt().

Here is the call graph for this function: