org.cicirello.search.evo.EliteSet Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of chips-n-salsa Show documentation

Chips-n-Salsa is a Java library of customizable, hybridizable, iterative, parallel, stochastic, and self-adaptive local search algorithms. The library includes implementations of several stochastic local search algorithms, including simulated annealing, hill climbers, as well as constructive search algorithms such as stochastic sampling. Chips-n-Salsa now also includes genetic algorithms as well as evolutionary algorithms more generally. The library very extensively supports simulated annealing. It includes several classes for representing solutions to a variety of optimization problems. For example, the library includes a BitVector class that implements vectors of bits, as well as classes for representing solutions to problems where we are searching for an optimal vector of integers or reals. For each of the built-in representations, the library provides the most common mutation operators for generating random neighbors of candidate solutions, as well as common crossover operators for use with evolutionary algorithms. Additionally, the library provides extensive support for permutation optimization problems, including implementations of many different mutation operators for permutations, and utilizing the efficiently implemented Permutation class of the JavaPermutationTools (JPT) library. Chips-n-Salsa is customizable, making extensive use of Java's generic types, enabling using the library to optimize other types of representations beyond what is provided in the library. It is hybridizable, providing support for integrating multiple forms of local search (e.g., using a hill climber on a solution generated by simulated annealing), creating hybrid mutation operators (e.g., local search using multiple mutation operators), as well as support for running more than one type of search for the same problem concurrently using multiple threads as a form of algorithm portfolio. Chips-n-Salsa is iterative, with support for multistart metaheuristics, including implementations of several restart schedules for varying the run lengths across the restarts. It also supports parallel execution of multiple instances of the same, or different, stochastic local search algorithms for an instance of a problem to accelerate the search process. The library supports self-adaptive search in a variety of ways, such as including implementations of adaptive annealing schedules for simulated annealing, such as the Modified Lam schedule, implementations of the simpler annealing schedules but which self-tune the initial temperature and other parameters, and restart schedules that adapt to run length.

There is a newer version: 7.0.1

Show newest version

/*
 * Chips-n-Salsa: A library of parallel self-adaptive local search algorithms.
 * Copyright (C) 2002-2022 Vincent A. Cicirello
 *
 * This file is part of Chips-n-Salsa (https://chips-n-salsa.cicirello.org/).
 *
 * Chips-n-Salsa 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.
 *
 * Chips-n-Salsa 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 .
 */

package org.cicirello.search.evo;

import java.util.ArrayList;
import java.util.HashSet;
import java.util.Iterator;
import java.util.NoSuchElementException;
import org.cicirello.util.Copyable;

/**
 * Abstract package-private class for use by classes within the evo package for maintaining a set of
 * elite population members for evolutionary algorithms with elitism. This class supports
 * double-valued fitness.
 */
abstract class EliteSet> {

  /**
   * Package-private class for use by classes within the evo package for maintaining a set of elite
   * population members for evolutionary algorithms with elitism. This class supports double-valued
   * fitness.
   */
  static final class DoubleFitness> extends EliteSet
      implements Iterable> {

    private final PopulationMember.DoubleFitness[] elite;
    private int size;
    private final HashSet isElite;

    /*
     * package-private for use by classes in evo package for maintaining a set of elite population members.
     */
    @SuppressWarnings("unchecked")
    DoubleFitness(int numElite) {
      isElite = new HashSet();
      elite = (PopulationMember.DoubleFitness[]) new PopulationMember.DoubleFitness[numElite];
      size = 0;
    }

    /*
     * package-private for use by classes in evo package for maintaining a set of elite population members.
     */
    DoubleFitness(ArrayList> initialPop, int numElite) {
      this(numElite);
      offerAll(initialPop);
    }

    /*
     * package-private for use by classes in evo package for adding to a set of elite population members.
     */
    void offerAll(ArrayList> pop) {
      for (PopulationMember.DoubleFitness popMember : pop) {
        offer(popMember);
      }
    }

    /*
     * package-private for use by classes in evo package for adding to a set of elite population members.
     */
    void offer(PopulationMember.DoubleFitness popMember) {
      if (size < elite.length) {
        if (!isElite.contains(popMember.candidate)) {
          elite[size] = popMember;
          percolateUp(size);
          size++;
          isElite.add(popMember.candidate);
        }
      } else if (popMember.getFitness() > elite[0].getFitness()) {
        if (!isElite.contains(popMember.candidate)) {
          isElite.remove(elite[0].candidate);
          isElite.add(popMember.candidate);
          elite[0] = popMember;
          percolateDown(0);
        }
      }
    }

    /*
     * package-private for use by classes in evo package for adding to a set of elite population members.
     */
    void clear() {
      isElite.clear();
      for (int i = 0; i < size; i++) {
        elite[i] = null;
      }
      size = 0;
    }

    @Override
    public Iterator> iterator() {
      return new EliteIterator();
    }

    /*
     * private helper for min-heap used for elite set
     */
    private void percolateDown(int index) {
      int child = (index << 1) + 1;
      if (child < size) {
        int minIndex = elite[child].getFitness() < elite[index].getFitness() ? child : index;
        child++;
        if (child < size && elite[child].getFitness() < elite[minIndex].getFitness()) {
          minIndex = child;
        }
        if (index != minIndex) {
          PopulationMember.DoubleFitness temp = elite[index];
          elite[index] = elite[minIndex];
          elite[minIndex] = temp;
          percolateDown(minIndex);
        }
      }
    }

    /*
     * private helper for min-heap used for elite set
     */
    private void percolateUp(int index) {
      while (index > 0) {
        int parent = (index - 1) >> 1;
        if (elite[index].getFitness() < elite[parent].getFitness()) {
          PopulationMember.DoubleFitness temp = elite[index];
          elite[index] = elite[parent];
          elite[parent] = temp;
          index = parent;
        } else {
          break;
        }
      }
    }

    /*
     * internal iterator class
     */
    private final class EliteIterator implements Iterator> {

      private int nextIndex;

      private EliteIterator() {
        nextIndex = 0;
      }

      @Override
      public boolean hasNext() {
        return nextIndex < size;
      }

      @Override
      public PopulationMember.DoubleFitness next() {
        if (hasNext()) {
          PopulationMember.DoubleFitness result = elite[nextIndex];
          nextIndex++;
          return result;
        }
        throw new NoSuchElementException("No more elements in this iterator.");
      }
    }
  }

  /**
   * Package-private class for use by classes within the evo package for maintaining a set of elite
   * population members for evolutionary algorithms with elitism. This class supports int-valued
   * fitness.
   */
  static final class IntegerFitness> extends EliteSet
      implements Iterable> {

    private final PopulationMember.IntegerFitness[] elite;
    private int size;
    private final HashSet isElite;

    /*
     * package-private for use by classes in evo package for maintaining a set of elite population members.
     */
    @SuppressWarnings("unchecked")
    IntegerFitness(int numElite) {
      isElite = new HashSet();
      elite = (PopulationMember.IntegerFitness[]) new PopulationMember.IntegerFitness[numElite];
      size = 0;
    }

    /*
     * package-private for use by classes in evo package for maintaining a set of elite population members.
     */
    IntegerFitness(ArrayList> initialPop, int numElite) {
      this(numElite);
      offerAll(initialPop);
    }

    /*
     * package-private for use by classes in evo package for adding to a set of elite population members.
     */
    void offerAll(ArrayList> pop) {
      for (PopulationMember.IntegerFitness popMember : pop) {
        offer(popMember);
      }
    }

    /*
     * package-private for use by classes in evo package for adding to a set of elite population members.
     */
    void offer(PopulationMember.IntegerFitness popMember) {
      if (size < elite.length) {
        if (!isElite.contains(popMember.candidate)) {
          elite[size] = popMember;
          percolateUp(size);
          size++;
          isElite.add(popMember.candidate);
        }
      } else if (popMember.getFitness() > elite[0].getFitness()) {
        if (!isElite.contains(popMember.candidate)) {
          isElite.remove(elite[0].candidate);
          isElite.add(popMember.candidate);
          elite[0] = popMember;
          percolateDown(0);
        }
      }
    }

    /*
     * package-private for use by classes in evo package for adding to a set of elite population members.
     */
    void clear() {
      isElite.clear();
      for (int i = 0; i < size; i++) {
        elite[i] = null;
      }
      size = 0;
    }

    @Override
    public Iterator> iterator() {
      return new EliteIterator();
    }

    /*
     * private helper for min-heap used for elite set
     */
    private void percolateDown(int index) {
      int child = (index << 1) + 1;
      if (child < size) {
        int minIndex = elite[child].getFitness() < elite[index].getFitness() ? child : index;
        child++;
        if (child < size && elite[child].getFitness() < elite[minIndex].getFitness()) {
          minIndex = child;
        }
        if (index != minIndex) {
          PopulationMember.IntegerFitness temp = elite[index];
          elite[index] = elite[minIndex];
          elite[minIndex] = temp;
          percolateDown(minIndex);
        }
      }
    }

    /*
     * private helper for min-heap used for elite set
     */
    private void percolateUp(int index) {
      while (index > 0) {
        int parent = (index - 1) >> 1;
        if (elite[index].getFitness() < elite[parent].getFitness()) {
          PopulationMember.IntegerFitness temp = elite[index];
          elite[index] = elite[parent];
          elite[parent] = temp;
          index = parent;
        } else {
          break;
        }
      }
    }

    /*
     * internal iterator class
     */
    private final class EliteIterator implements Iterator> {

      private int nextIndex;

      private EliteIterator() {
        nextIndex = 0;
      }

      @Override
      public boolean hasNext() {
        return nextIndex < size;
      }

      @Override
      public PopulationMember.IntegerFitness next() {
        if (hasNext()) {
          PopulationMember.IntegerFitness result = elite[nextIndex];
          nextIndex++;
          return result;
        }
        throw new NoSuchElementException("No more elements in this iterator.");
      }
    }
  }
}