org.cicirello.search.problems.IntegerCostFunctionScaler 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-2021  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.problems;

import org.cicirello.util.Copyable;

/**
 * This is a wrapper class for {@link IntegerCostOptimizationProblem} objects that enables scaling
 * all cost values by a positive constant. This transformation doesn't change what solution is
 * optimal, and doesn't change the topology of the search space. It simply scales the cost values.
 * For example, if you want to explore the effects of the range of the cost function on the behavior
 * of a search algorithm, you can use this class to scale the cost values of a problem whose cost
 * function range is known.
 *
 * Note that this does not scale the results of the {@link #value} method, which will continue to
 * return the actual value of the candidate solution (see its documentation for details).
 *
 * @param  The type of object used to represent candidate solutions to the problem.
 * @author Vincent A. Cicirello, https://www.cicirello.org/
 * @version 3.5.2021
 */
public final class IntegerCostFunctionScaler>
    implements IntegerCostOptimizationProblem {

  private final IntegerCostOptimizationProblem problem;
  private final int scale;

  /**
   * Constructs the IntegerCostFunctionScaler.
   *
   * @param problem The original problem specification.
   * @param scale The scale factor, which must be positive. All cost values of the original problem
   *     will be multiplied by scale.
   * @throws IllegalArgumentException if scale ≤ 0.
   */
  public IntegerCostFunctionScaler(IntegerCostOptimizationProblem problem, int scale) {
    if (scale <= 0) throw new IllegalArgumentException("scale must be positive");
    this.scale = scale;
    this.problem = problem;
  }

  /**
   * {@inheritDoc}
   *
   * 
In the case of the IntegerCostFunctionScaler, the cost values are all multiplied by the
   * scale factor.
   */
  @Override
  public int cost(T candidate) {
    return scale * problem.cost(candidate);
  }

  /**
   * {@inheritDoc}
   *
   * In the case of the IntegerCostFunctionScaler, the cost values are all multiplied by the
   * scale factor.
   */
  @Override
  public int minCost() {
    return scale * problem.minCost();
  }

  @Override
  public int value(T candidate) {
    return problem.value(candidate);
  }
}