bluepyopt/stoppingCriteria.py

"""Stopping Criteria class"""

"""
Copyright (c) 2016-2020, EPFL/Blue Brain Project
 This file is part of BluePyOpt <https://github.com/BlueBrain/BluePyOpt>
 This library is free software; you can redistribute it and/or modify it under
 the terms of the GNU Lesser General Public License version 3.0 as published
 by the Free Software Foundation.
 This library 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.
 You should have received a copy of the GNU Lesser General Public License
 along with this library; if not, write to the Free Software Foundation, Inc.,
 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
"""


class StoppingCriteria(object):
    """Stopping Criteria class"""

    def __init__(self):
        """Constructor"""
        self.criteria_met = False
        pass

    def check(self, kwargs):
        """Check if the stopping criteria is met"""
        pass

    def reset(self):
        self.criteria_met = False