uk.ac.sussex.gdsc.smlm.ga.SelectionStrategy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gdsc-smlm Show documentation

Genome Damage and Stability Centre SMLM Package Software for single molecule localisation microscopy (SMLM)

The newest version!

/*-
 * #%L
 * Genome Damage and Stability Centre SMLM Package
 *
 * Software for single molecule localisation microscopy (SMLM)
 * %%
 * Copyright (C) 2011 - 2023 Alex Herbert
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public
 * License along with this program.  If not, see
 * .
 * #L%
 */

package uk.ac.sussex.gdsc.smlm.ga;

import java.util.List;
import uk.ac.sussex.gdsc.core.logging.TrackProgress;

/**
 * Defines a selection strategy of a population of individuals.
 *
 * @param  the generic type
 */
public interface SelectionStrategy> {
  /**
   * Select a subset from the population using the fitness.
   *
   * @param individuals the individuals
   * @return a selection of individuals
   */
  List> select(List> individuals);

  /**
   * Initialise the selection of pairs for breeding using the fitness.
   *
   * @param individuals the population of individuals
   */
  void initialiseBreeding(List> individuals);

  /**
   * Get the next pair of individuals for breeding. Must be called after
   * {@link #initialiseBreeding(List)}.
   *
   * @return The next pair
   */
  ChromosomePair next();

  /**
   * Finish selection of pairs for breeding.
   */
  void finishBreeding();

  /**
   * Set the tracker used to track progress. This should be used in the {@link #select(List)}
   * method. It is possible to know the end point when breeding and so it is not advised to use the
   * tracker in the {@link #next()} method.
   *
   * @param tracker the new tracker
   */
  void setTracker(TrackProgress tracker);
}