uk.ac.sussex.gdsc.smlm.ga.ChromosomeComparator 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.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.Comparator;
import java.util.List;

/**
 * Sorts chromosome using the fitness, highest fitness first.
 *
 * @param  the generic type
 */
public class ChromosomeComparator>
    implements Comparator>, Serializable {
  private static final long serialVersionUID = 1L;
  /** An instance of the comparator. */
  @SuppressWarnings("rawtypes")
  private static final ChromosomeComparator INSTANCE = new ChromosomeComparator<>();

  /**
   * Returns an instance.
   *
   * @param  the generic type
   * @return the chromosome comparator
   */
  public static final > ChromosomeComparator instance() {
    return INSTANCE;
  }

  @Override
  public int compare(Chromosome chromosome1, Chromosome chromosome2) {
    return chromosome1.getFitness().compareTo(chromosome2.getFitness());
  }

  /**
   * Sort the list (highest fitness first).
   *
   * @param  the generic type
   * @param list the list
   */
  public static > void sort(List> list) {
    Collections.sort(list, instance());
  }

  /**
   * Sort the list (highest fitness first).
   *
   * @param  the generic type
   * @param list the list
   */
  public static > void sort(Chromosome[] list) {
    sort(list, 0, list.length);
  }

  /**
   * Sort the list (highest fitness first).
   *
   * @param  the generic type
   * @param list the list
   * @param fromIndex the from index
   * @param toIndex the to index
   */
  public static > void sort(Chromosome[] list, int fromIndex,
      int toIndex) {
    Arrays.sort(list, fromIndex, toIndex, instance());
  }
}