Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cicirello/chips-n-salsa-examples
Example programs for usage of the Chips-n-Salsa library
https://github.com/cicirello/chips-n-salsa-examples
combinatorial-optimization evolutionary-algorithms genetic-algorithms hill-climbing metaheuristics simulated-annealing stochastic-sampling
Last synced: about 2 months ago
JSON representation
Example programs for usage of the Chips-n-Salsa library
- Host: GitHub
- URL: https://github.com/cicirello/chips-n-salsa-examples
- Owner: cicirello
- License: gpl-3.0
- Created: 2020-10-14T14:48:44.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-03T23:58:36.000Z (3 months ago)
- Last Synced: 2024-10-05T12:41:43.057Z (3 months ago)
- Topics: combinatorial-optimization, evolutionary-algorithms, genetic-algorithms, hill-climbing, metaheuristics, simulated-annealing, stochastic-sampling
- Language: Java
- Homepage: https://chips-n-salsa.cicirello.org/
- Size: 329 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Example Programs for Usage of the Chips-n-Salsa Library
Copyright (C) 2020-2023 Vincent A. Cicirello. https://www.cicirello.org/
| __Packages and Releases__ | [](https://central.sonatype.com/artifact/org.cicirello/chips-n-salsa-examples/) [](https://github.com/cicirello/chips-n-salsa-examples/releases) |
| :--- | :--- |
| __Build Status__ | [](https://github.com/cicirello/chips-n-salsa-examples/actions/workflows/build.yml) [](https://github.com/cicirello/chips-n-salsa-examples/actions/workflows/codeql-analysis.yml) |
| __Security__ | [](https://snyk.io/vuln/maven%3Aorg.cicirello%3Achips-n-salsa-examples) [](https://snyk.io/test/github/cicirello/chips-n-salsa-examples) |
| __Other Information__ | [](https://github.com/cicirello/chips-n-salsa-examples/blob/main/LICENSE) [](https://google.github.io/styleguide/javaguide.html) |
| __Support__ | [](https://github.com/sponsors/cicirello) [](https://liberapay.com/cicirello) [](https://ko-fi.com/cicirello) |
This repository contains several example programs of the usage of the [Chips-n-Salsa](https://chips-n-salsa.cicirello.org)
library. Chips-n-Salsa is a Java library of customizable, hybridizable, iterative, parallel, stochastic, and self-adaptive
local search algorithms. [Chips-n-Salsa's source code](https://github.com/cicirello/Chips-n-Salsa) is maintained on GitHub,
and the prebuilt jars of the library can be imported from [Maven Central](https://central.sonatype.com/artifact/org.cicirello/chips-n-salsa/)
using maven or other build tools. The purpose of this repository is to demonstrate usage of the major functionality of the
Chips-n-Salsa library.
## The Example Programs
The source for several example programs is contained in this repository.
Read the comments in the source code of the example programs
for a description of what they demonstrate, etc. Running the
examples without reading the source code, and comments,
is not advised, since the output of the example programs
requires the context of the code samples to be meaningful.
__Basic Examples__: The following
examples are of basic usage using simulated annealing or genetic algorithms to optimize
functions over different structure types: bit vectors, integer vectors,
permutations, and a real-value function optimization example, the root finding
example:
* org.cicirello.examples.chipsnsalsa.BitVectorExample
* org.cicirello.examples.chipsnsalsa.GeneticAlgorithmExamples
* org.cicirello.examples.chipsnsalsa.IntegerVectorExample
* org.cicirello.examples.chipsnsalsa.RootFindingExample
* org.cicirello.examples.chipsnsalsa.PermutationExample
__Configuring the Random Number Generator__: If you either need to specify a particular
pseudorabdom number generator (PRNG) to be used by the library, or if you want to seed its
default PRNG in order to exactly repeat a run of your program, or if you want to do both,
then you can use the `Configurator` class. Here are examples of using the `Configurator` class.
* org.cicirello.examples.chipsnsalsa.ConfigureRandomness
__Parallel Examples__: The next couple examples are of parallel search:
* org.cicirello.examples.chipsnsalsa.ParallelPermutationExample
* org.cicirello.examples.chipsnsalsa.TimedParallelExample
__Custom Problem Examples__: The following examples demonstrate defining a custom optimization
problem (whereas the above examples mostly use benchmark problems
included in the library):
* org.cicirello.examples.chipsnsalsa.CustomProblemExample
* org.cicirello.examples.chipsnsalsa.CustomIntegerCostProblemExample
__Hybrid Search Examples__: The following examples show how multiple search algorithms can be
integrated (e.g., combining hill climbing with simulated annealing):
* org.cicirello.examples.chipsnsalsa.PostHillclimbExample
* org.cicirello.examples.chipsnsalsa.PreHillclimbExample
__Industrial Scheduling Problem Examples__: The following examples use scheduling
problems, and are also a bit more complex than some of the other example programs.
* org.cicirello.examples.chipsnsalsa.SchedulingExample
* org.cicirello.examples.chipsnsalsa.SchedulingWithVBSS
## Versioning Scheme
The version numbers for the example programs mirror the versions of
Chips-n-Salsa. The version may or may not be incremented upon every new release
of the Chips-n-Salsa library. The version number of the examples corresponds
to the version of the Chips-n-Salsa library used in that release.
The examples should run against newer versions of the Chips-n-Salsa library
provided the MAJOR portion of the version number is the same.
The Chips-n-Salsa library uses [Semantic Versioning](https://semver.org/) with
version numbers of the form: MAJOR.MINOR.PATCH, where differences
in MAJOR correspond to incompatible API changes, differences in MINOR
correspond to introduction of backwards compatible new functionality,
and PATCH corresponds to backwards compatible bug fixes.
## Prebuilt Jars of the Examples
Since the purpose of the example programs is to demonstrate usage of the
Chips-n-Salsa library, you will most likely want to build the examples
directly from the source (see the sections that follow). However, we
also provide jars of the compiled examples, as well as of the source and javadocs,
in a variety of ways:
* [GitHub releases](https://github.com/cicirello/chips-n-salsa-examples/releases)
* [Maven Central](https://central.sonatype.com/artifact/org.cicirello/chips-n-salsa-examples/)
* [GitHub Packages](https://github.com/cicirello?tab=packages&repo_name=chips-n-salsa-examples)
If you use the example programs in precompiled form, you will also need
a compatible version of the Chips-n-Salsa library, and its dependencies. If you
build the examples from the source, the build process will take care of downloading these
for you. But if you choose to use the prebuilt jars, you can find the jars
of the [Chips-n-Salsa library](https://github.com/cicirello/Chips-n-Salsa)
likewise in Maven Central, GitHub Releases, and GitHub Packages. In particular,
you will find a jarred version of Chips-n-Salsa that includes all of its dependencies.
## Requirements to Build and Run the Example Programs from the Source
To build and run the examples on your own machine, you will need the following:
* __JDK 17__: Beginning with Chips-n-Salsa, v5.0.0, the minimum supported version of Java is
Java 17, so you will need Java 17+ for the example programs.
* __Apache Maven__: In the root of the repository, there is a pom.xml for building the example programs. Using this pom.xml, Maven will take care of downloading the most recent version of the [Chips-n-Salsa](https://chips-n-salsa.cicirello.org/) library for which the examples have been tested, as well as Chips-n-Salsa's dependencies. The examples should also work with more recent versions of the library.
* __Make__ (optional): The repository also contains a Makefile to simplify running the build, and running the example programs. If you are familiar with using the Maven build tool, then you can just run these directly, although the Makefile may be useful to see the specific commands needed, such as the main classes to execute for the example programs.
## Building the Example Programs with Maven
The source code of the example programs are
in the [src/main/java](src/main/java) directory. You can build the example
programs in one of the following ways:
* Execute `mvn package` at the root of the repository (`mvn compile` should also be sufficient, but only generates `class` files, while `mvn package` generates `jar` files as well as the javadocs).
* Execute `make` or `make build` at the root of the repository (which simply executes a `mvn package`).
This build process follows the usual Maven directory structure, so
the `.class` files, `.jar` files, etc will be found in a `target`
directory that is created by the build process.
To run various static analysis tools (e.g., SpotBugs, FindSecBugs, refactor-first,
etc) during the build, run: `mvn clean package -Panalysis`.
## Running the Example Programs with Maven
Once you have successfully executed the build above, you can run the
examples by executing `make examples` at the root of the
repository. This will run each of the example programs in sequence.
Be aware that the examples are intended to illustrate how to use
the Chips-n-Salsa library, so will be most meaningful if you read the
source code, which includes comments explaining what they are doing.
If you would rather run them one at a time, see the `examples` target
in the `Makefile` for the main classes to execute.
## License
The example programs in this repository are licensed under
the [GNU General Public License 3.0](https://www.gnu.org/licenses/gpl-3.0.en.html).