org.cicirello.search.evo.EncodingWithParameters 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.concurrent.ThreadLocalRandom;
import org.cicirello.search.operators.reals.GaussianMutation;
import org.cicirello.search.representations.SingleReal;
import org.cicirello.util.Copyable;

/**
 * This is a package-access support class for evolutionary algorithms with evolvable control
 * parameters.
 *
 * @param  The type of object under optimization.
 * @author Vincent A. Cicirello, https://www.cicirello.org/
 */
final class EncodingWithParameters>
    implements Copyable> {

  private final T candidate;
  private final SingleReal[] params;
  private final GaussianMutation mutator;
  private static final GaussianMutation mutationMutator =
      GaussianMutation.createGaussianMutation(0.01, 0.01, 0.2);

  EncodingWithParameters(T candidate, int numParams) {
    this(candidate, numParams, 0.1, 1.0);
  }

  EncodingWithParameters(T candidate, int numParams, double minRate, double maxRate) {
    this.candidate = candidate;
    params = new SingleReal[numParams];
    for (int i = 0; i < numParams; i++) {
      params[i] = new SingleReal(ThreadLocalRandom.current().nextDouble(minRate, maxRate));
    }
    mutator =
        GaussianMutation.createGaussianMutation(
            ThreadLocalRandom.current().nextDouble(0.05, 0.15), minRate, maxRate);
  }

  private EncodingWithParameters(EncodingWithParameters other) {
    candidate = other.candidate.copy();
    params = new SingleReal[other.params.length];
    for (int i = 0; i < params.length; i++) {
      params[i] = other.params[i].copy();
    }
    mutator = other.mutator.copy();
  }

  /** Mutates the parameters. */
  public final void mutate() {
    for (SingleReal p : params) {
      mutator.mutate(p);
    }
    mutationMutator.mutate(mutator);
  }

  /**
   * Gets the candidate solution.
   *
   * @return the candidate solution.
   */
  public final T getCandidate() {
    return candidate;
  }

  /**
   * Gets the vector of parameters.
   *
   * @param i Index of parameter to get
   * @return the vector of parameters
   */
  public final SingleReal getParameter(int i) {
    return params[i];
  }

  /**
   * Gets number of parameters.
   *
   * @return number of parameters
   */
  public final int length() {
    return params.length;
  }

  @Override
  public EncodingWithParameters copy() {
    return new EncodingWithParameters(this);
  }

  @Override
  public int hashCode() {
    // hashCode and equals need to be strictly for whether the encapsulated
    // candidates are equal to function properly with the elite sets, and some
    // other stuff within the package.
    return candidate.hashCode();
  }

  @Override
  public boolean equals(Object other) {
    // hashCode and equals need to be strictly for whether the encapsulated
    // candidates are equal to function properly with the elite sets, and some
    // other stuff within the package.
    if (other instanceof EncodingWithParameters) {
      EncodingWithParameters casted = (EncodingWithParameters) other;
      return candidate.equals(casted.candidate);
    }
    return false;
  }
}