def check_group(self, group):
"""
Checks the generator's group.
This method must be overloaded in all MoveGenerator sub-classes.
:Parameters:
#. group (Group): the Group instance
"""
raise Exception(LOGGER.impl("MovesGenerator '%s' method must be overloaded"%inspect.stack()[0][3]))
def pick_from_list(self, engine):
"""
This method must be overloaded in all RemoveGenerator sub-classes.
:Parameters:
#. engine (Engine): stochastic engine calling the method.
"""
raise Exception(
LOGGER.impl("%s '%s' method must be overloaded" %
(self.__class__.__name__, inspect.stack()[0][3])))
def pick_from_list(self, engine):
"""
In this particular case it checks and verifies maximumCollected
:Parameters:
#. engine (Engine): The engine calling the method.
:Returns:
#. indexes (np.ndarray): The array of indexes that need to be tested for removal.
"""
raise Exception(LOGGER.impl("%s '%s' method must be overloaded"%(self.__class__.__name__,inspect.stack()[0][3])))
def transform_coordinates(self, coordinates, argument=None):
"""
Transform coordinates. This method is called in every move.
This method must be overloaded in all MoveGenerator sub-classes.
:Parameters:
#. coordinates (np.ndarray): The coordinates on which to apply the move.
#. argument (object): Any other argument needed to perform the move.
In General it's not needed.
:Returns:
#. coordinates (np.ndarray): The new coordinates after applying the move.
"""
raise Exception(LOGGER.impl("%s '%s' method must be overloaded"%(self.__class__.__name__,inspect.stack()[0][3])))
def reject_insertion(self, realIndex, relativeIndex):
raise Exception(LOGGER.impl("%s '%s' method must be overloaded"%(self.__class__.__name__,inspect.stack()[0][3])))
def compute_as_if_amputated(self, realIndex, relativeIndex):
raise Exception(LOGGER.impl("%s '%s' method must be overloaded"%(self.__class__.__name__,inspect.stack()[0][3])))
def accept_move(self, realIndexes, relativeIndexes):
raise Exception(LOGGER.impl("%s '%s' method must be overloaded"%(self.__class__.__name__,inspect.stack()[0][3])))
def compute_after_move(self, realIndexes, relativeIndexes, movedBoxCoordinates):
raise Exception(LOGGER.impl("%s '%s' method must be overloaded"%(self.__class__.__name__,inspect.stack()[0][3])))
def compute_data(self):
raise Exception(LOGGER.impl("%s '%s' method must be overloaded"%(self.__class__.__name__,inspect.stack()[0][3])))
def get_constraint_original_value(self):
raise Exception(LOGGER.impl("%s '%s' method must be overloaded"%(self.__class__.__name__,inspect.stack()[0][3])))
def accept_insertion(self, realIndex, relativeIndex):
"""Method must be overloaded in children classes."""
raise Exception(
LOGGER.impl("%s '%s' method must be overloaded" %
(self.__class__.__name__, inspect.stack()[0][3])))
def compute_before_move(self, realIndexes, relativeIndexes):
"""Method must be overloaded in children classes."""
raise Exception(
LOGGER.impl("%s '%s' method must be overloaded" %
(self.__class__.__name__, inspect.stack()[0][3])))
def compute_standard_error(self):
"""Method must be overloaded in children classes."""
raise Exception(
LOGGER.impl("%s '%s' method must be overloaded" %
(self.__class__.__name__, inspect.stack()[0][3])))
def get_constraint_value(self):
"""Method must be overloaded in children classes."""
raise Exception(
LOGGER.impl("%s '%s' method must be overloaded" %
(self.__class__.__name__, inspect.stack()[0][3])))
def _on_collector_release_atom(self, realIndex):
raise Exception(LOGGER.impl("%s '%s' method must be overloaded"%(self.__class__.__name__,inspect.stack()[0][3])))
def _on_collector_reset(self):
raise Exception(LOGGER.impl("%s '%s' method must be overloaded"%(self.__class__.__name__,inspect.stack()[0][3])))
def _on_collector_collect_atom(self, realIndex):
"""Method must be overloaded in children classes."""
raise Exception(
LOGGER.impl("%s '%s' method must be overloaded" %
(self.__class__.__name__, inspect.stack()[0][3])))