Source code for easyvvuq.comparison.base

"""Provides base class for all comparison/validation elements.
"""
from .. import BaseElement

__copyright__ = """

    Copyright 2018 Robin A. Richardson, David W. Wright

    This file is part of EasyVVUQ

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

    EasyVVUQ 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
    Lesser GNU General Public License for more details.

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

"""
__license__ = "LGPL"



[docs]class BaseComparisonElement(BaseElement):
    """Baseclass for all EasyVVUQ comparison elements.

    Attributes
    ----------

    """


[docs]    def compare(self, dataframe1, dataframe2):
        raise NotImplementedError



[docs]    def element_category(self):
        return "comparison"