NumericFileComparison.hpp

/*

Copyright (C) University of Oxford, 2005-2011

University of Oxford means the Chancellor, Masters and Scholars of the
University of Oxford, having an administrative office at Wellington
Square, Oxford OX1 2JD, UK.

This file is part of Chaste.

Chaste is free software: you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published
by the Free Software Foundation, either version 2.1 of the License, or
(at your option) any later version.

Chaste is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
License for more details. The offer of Chaste under the terms of the
License is subject to the License being interpreted in accordance with
English Law and subject to any action against the University of Oxford
being under the jurisdiction of the English Courts.

You should have received a copy of the GNU Lesser General Public License
along with Chaste. If not, see <http://www.gnu.org/licenses/>.

*/
#ifndef NUMERICFILECOMPARISON_HPP_
#define NUMERICFILECOMPARISON_HPP_

#include <cfloat>
#include <string>

#include "OutputFileHandler.hpp"
#include "MathsCustomFunctions.hpp"

#define A_WORD DBL_MAX
#define NOTHING_TO_READ DBL_MIN

class NumericFileComparison
{
private:

    std::string mFilename1; 
    std::string mFilename2; 
    std::ifstream* mpFile1; 
    std::ifstream* mpFile2; 
public:

    NumericFileComparison(std::string fileName1, std::string fileName2):
        mFilename1(fileName1),
        mFilename2(fileName2)
    {
        mpFile1 = new std::ifstream(fileName1.c_str());

        // If it doesn't exist - throw exception
        if (!mpFile1->is_open())
        {
            delete mpFile1;
            mpFile1 = NULL;
            EXCEPTION("Couldn't open file: " + fileName1);
        }

        mpFile2 = new std::ifstream(fileName2.c_str());

        // If it doesn't exist - throw exception
        if (!mpFile2->is_open())
        {
            mpFile1->close();
            delete mpFile1;
            mpFile1 = NULL;
            delete mpFile2;
            mpFile2 = NULL;
            EXCEPTION("Couldn't open file: " + fileName2);
        }
    }

    ~NumericFileComparison()
    {
        if (mpFile1)
        {
            mpFile1->close();
        }
        if (mpFile2)
        {
            mpFile2->close();
        }
        delete mpFile1;
        delete mpFile2;
    }

    bool CompareFiles(double absTol=DBL_EPSILON, unsigned ignoreFirstFewLines=0,
                      double relTol=DBL_EPSILON)
    {
        double data1;
        double data2;
        unsigned failures = 0;
        unsigned max_display_failures = 10;

        for (unsigned line_number=0; line_number<ignoreFirstFewLines; line_number++)
        {
            char buffer[1024];
            mpFile1->getline(buffer, 1024);
            mpFile2->getline(buffer, 1024);
            TS_ASSERT(!mpFile1->fail()); // Here we assume there are at least "ignoreFirstFewLines" lines...
            TS_ASSERT(!mpFile2->fail()); // ...and that they are lines of no more than 1024 characters
        }

        do
        {
            if (!(*mpFile1>>data1))
            {
                // Cannot read the next token from file as a number, so try a word instead
                std::string word;
                mpFile1->clear(); // reset the "failbit"
                if (*mpFile1 >> word)
                {
                    data1 = A_WORD;
                    if (word == "#" || word == "!")
                    {
                        // Ignore comment (up to 1024 characters until newline)
                        mpFile1->ignore(1024, '\n');
                    }
                }
                else
                {
                    mpFile1->clear(); // reset the "failbit"
                    data1 = NOTHING_TO_READ;
                }
            }
            if (!(*mpFile2 >> data2))
            {
                // Cannot read the next token from file as a number, so try a word instead
                std::string word;
                mpFile2->clear(); // reset the "failbit"
                if (*mpFile2 >> word)
                {
                    data2 = A_WORD;
                    if (word == "#" || word == "!")
                    {
                        // Ignore comment (up to 1024 characters until newline)
                        mpFile2->ignore(1024, '\n');
                    }
                }
                else
                {
                    mpFile2->clear(); // reset the "failbit"
                    data2 = NOTHING_TO_READ;
                }
            }

            bool ok = CompareDoubles::WithinAnyTolerance(data1, data2, relTol, absTol);
            if (!ok)
            {
                if (failures++ < max_display_failures)
                {
                    // Display error
                    CompareDoubles::WithinAnyTolerance(data1, data2, relTol, absTol, true);
                }
            }
        }
        while (data1 != NOTHING_TO_READ && data2 != NOTHING_TO_READ); // If either is a NOTHING_TO_READ, then it means that there's nothing to read from the file

        // Force CxxTest error if there were any major differences
        TS_ASSERT_EQUALS(failures, 0u);
        // If that assertion tripped...
        if (failures > 0u)
        {
#define COVERAGE_IGNORE
            // Report the paths to the files
            TS_TRACE("Files " + mFilename1 + " and " + mFilename2 + " numerically differ.");
#undef COVERAGE_IGNORE
        }
        return (failures==0);
    }
};

#endif /*NUMERICFILECOMPARISON_HPP_*/