Logo

jaicore-search is an AILibs library

jaicore-search

Overview

Installation

Usage

JavaDoc

Contribute

jaicore-search

jaicore-search is a library for heuristic search.

Overview

With the algorithms contained in jaicore-search, you can search tree-structured graphs with

Installation

You can bind in jaicore-search via a Maven dependency (using Maven central as repository).

Maven

<dependency>
  <groupId>ai.libs</groupId>
  <artifactId>jaicore-search</artifactId>
  <version>0.2.4</version>
</dependency>

Gradle

dependencies {
    implementation 'ai.libs:jaicore-search:0.2.4'
}

Usage

At a Glance

For every search algorithm, jaicore-search provides a distinct class that implements the IAlgorithmInterface and, hence, can be used in a step-wise manner. In particular, this means that you can iterate over the search algorithm object, and each iteration gives you an of the search algorithm. In the simplest case, the algorithm steps once for every solution path, but, depending on the concrete search algorithm, there may also be steps for much more subtle events such as a node added to the model or a type switch of a node.

To apply a search algorithm to a graph, three steps are necessary:

  1. create an object representing the search problem
  2. create a new search algorithm instance for the problem
  3. run the search algorithm

A minimal code example in jaicore-search for the 8-queens problems looks like this:

GraphSearchInput<QueenNode, String> input = new GraphSearchInput<>(new NQueensGraphGenerator(8));
RandomSearch<QueenNode, String> rs = new RandomSearch<>(input);
SearchGraphPath<QueenNode, String> solution = rs.call();
System.out.println(solution);

Note that search problems and algorithms are always generic in (at least) the labels associated with nodes (here QueenNode) and labels associated with edges (here String).

In the following, these steps are described in some more detail, and we describe alternative problem formulations and algorithms.

In-Depth

Defining a Search Problem

Every search algorithm receives an object of the type GraphSearchInput (or one of its sub-types) as input. Such an input provides a GraphGenerator and, depending on the concrete sub-class, potentially other objects such as path evaluators, heuristics, etc. jaicore-search already comes with a number of GraphGenerator classes for standard AI search problems, which you can have a look at to understand how these work.

For example, to create a search problem for the 8-queens problem, you can do the following:

GraphSearchInput<QueenNode, String> input1 = new GraphSearchInput<>(new NQueensGraphGenerator(8));

Some algorithms can already work with this kind of problem, e.g. RandomSearch. Some algorithms, however, need additional input. For example, BestFirstSearch requires a function that can evaluate arbitrary paths starting from the root (typically called f). To this end, a more specific input object can be created:

GraphSearchWithSubpathEvaluationsInput<QueenNode, String, Double> input2 = new GraphSearchWithSubpathEvaluationsInput<>(new NQueensGraphGenerator(4), p -> 0.0);

Here, the evaluator simply assigns a constant 0.0 to each path. You may also observe that this input problem has an additional generic parameter (Double), which is the class for the node evaluations. Often, these are Double, but you can also you more complex evaluations like vectors etc. as long as they implement the Comparable interface.

Initializing and Configuring the Search Algorithm

Every search algorithm can be instantiated with a problem instance that corresponds to its input type.

RandomSearch<QueenNode, String> rs = new RandomSearch<>(input1);
StandardBestFirst<QueenNode, String> bf = new StandardBestFirst<>(input2);

Since every search algorithm implements the IAlgorithm interface, a timeout, and conditions on CPU usage, and maximum threads can be defined.

rs.setTimeout(new TimeOut(10, TimeUnit.SECONDS));
rs.setNumCPUs(4);
rs.setMaxNumThreads(8);

Running a Search Algorithm

You can simply invoke the call method to obtain any solution.

SearchGraphPath<QueenNode, String> solution = rs.call();

For algorithms that evaluate paths, you get a more specific object, an EvaluatedSearchGraphPath, which you can ask for the score of the solution:

EvaluatedSearchGraphPath<QueenNode, String, Double> solution = bf.call();
Double score = solution.getScore();

Alternatively, you can iterate over all solutions using

while (true) {
  SearchGraphPath<QueenNode, String> solution = rs.nextSolutionCandidate();
}

Note that this throws a NoSuchElementException if no more solutions exist.

For iterating over all events, use:

for (AlgorithmEvent e : bf) {
  if (e instanceof EvaluatedSearchSolutionCandidateFoundEvent) {
    EvaluatedSearchGraphPath<QueenNode, String, Double> solution = ((EvaluatedSearchSolutionCandidateFoundEvent<QueenNode, String, Double>)e).getSolutionCandidate();
    double score = solution.getScore();
    System.out.println(score);
  }
}

In this example, we only consider events that indicate the encounter of a solution, but there are many more events that you can react to. A list of supported events per algorithm is given in the documentation of the respective algorithm.

You may note that the library adopts Java Generics in a very exhaustive way, and that class names appear sometimes quite complicated (long). In AILibs, we are trading off readibility, reliability, reusability, and API comfort. The strongly generic architecture gives AILibs an enormous potential of reusability of code. API comfort in itself is a goal that needs to trade-off between short syntax and semantic safety. With less generics, the code that uses our API would be shorter and perhaps a bit easier to read, but generics have the advantage of giving type guarantees at compile time, and relief you from the need of casting. Our general approach is to try to hide as much of the generics as possible in internal structures, such that API users benefit from generics as much as possible while suffering as little as possible from the overhead that comes along with it.

List of Search Algorithms

Algorithm Input Output
DepthFirstSearch GraphSearchInput SearchGraphPath
RandomSearch GraphSearchInput SearchGraphPath
MCTSPathSearch GraphSearchWithPathEvaluationsInput EvaluatedSearchGraphPath
UCTPathSearch GraphSearchWithPathEvaluationsInput EvaluatedSearchGraphPath
StandardBestFirst GraphSearchWithSubpathEvaluationsInput EvaluatedSearchGraphPath
AStar GraphSearchWithNumberBasedAdditivePathEvaluation EvaluatedSearchGraphPath
RStar GraphSearchWithNumberBasedAdditivePathEvaluationAndSubPathHeuristic EvaluatedSearchGraphPath
AwaStarSearch GraphSearchWithSubpathEvaluationsInput EvaluatedSearchGraphPath
BestFirstLimitedDiscrepancySearch GraphSearchWithNodeRecommenderInput EvaluatedSearchGraphPath

JavaDoc

JavaDoc is available here.

Contribute

jaicore-search is currently developed in the JAICore/jaicore-search folder of AILibs on github.com.

We welcome contributions to jaicore-search given that the code quality meets our standards. If you would like to add changes to jaicore-search, feel free to create a pull request on the `dev` branch.

Please consider the following: