Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/citiususc/hipster
Hipster4j is a lightweight and powerful heuristic search library for Java and Android. It contains common, fully customizable algorithms such as Dijkstra, A* (A-Star), DFS, BFS, Bellman-Ford and more.
https://github.com/citiususc/hipster
android dijkstra graph-search heuristic-search hipster4j java search-algorithm shortest-paths
Last synced: 1 day ago
JSON representation
Hipster4j is a lightweight and powerful heuristic search library for Java and Android. It contains common, fully customizable algorithms such as Dijkstra, A* (A-Star), DFS, BFS, Bellman-Ford and more.
- Host: GitHub
- URL: https://github.com/citiususc/hipster
- Owner: citiususc
- License: apache-2.0
- Created: 2013-04-01T08:42:29.000Z (over 11 years ago)
- Default Branch: 1.0.X
- Last Pushed: 2023-06-14T22:29:37.000Z (over 1 year ago)
- Last Synced: 2024-12-13T21:06:29.634Z (9 days ago)
- Topics: android, dijkstra, graph-search, heuristic-search, hipster4j, java, search-algorithm, shortest-paths
- Language: Java
- Homepage: http://hipster4j.github.io
- Size: 5.47 MB
- Stars: 325
- Watchers: 28
- Forks: 89
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://jitpack.io/#citiususc/hipster)
A powerful and friendly heuristic search library implemented in Java.
## What's Hipster4j?
The aim of Hipster4j is to provide an easy to use yet powerful and flexible type-safe Java library for heuristic search.
Hipster relies on a flexible model with generic operators that allow you to reuse and change the behavior of the algorithms very easily. Algorithms are also implemented in an iterative way, avoiding recursion. This has many benefits: full control over the search, access to the internals at runtime or a better and clear scale-out for large search spaces using the heap memory.
You can use Hipster4j to solve from simple graph search problems to more advanced state-space search problems where the state space is complex and weights are not just double values but custom defined costs.
## Features
The current version of the library comes with some very well-known and wide used search algorithms. We're working to add more algorithms soon:
* Search algorithms:
* Uninformed search:
* DFS: Depth-First-Search.
* BFS: Breadth-First-Search.
* Dijkstra's algorithm.
* Bellman-Ford.
* Informed search:
* A star (A*).
* IDA star (IDA*), Iterative Deepening A*.
* AD star (AD*): Anytime Dynamic A*.
* Local search:
* Hill-Climbing.
* Enforced-Hill-Climbing.
* Multiobjective search
* Multiobjective LS algorithm. Original paper: Martins, E. D. Q. V., & Santos, J. L. E. (1999). *"The labeling algorithm for the multiobjective shortest path problem"*. Departamento de Matematica, Universidade de Coimbra, Portugal, Tech. Rep. TR-99/005 ([see an example](https://github.com/citiususc/hipster/wiki/Multiobjective-Search-with-Hipster-and-TinkerPop-Blueprints))
* 3rd party adapters:
* [Java Universal/Graph (JUNG)](http://jung.sourceforge.net/) adapter.
If you don't find the algorithm or the feature you are looking for, please consider contributing to Hipster!. You can open a new issue or better fork this repository and create a pull request with your contribution.
## Getting started
The easiest way to use Hipster is adding it as a dependency with your favourite dependency manager.
Maven users can include the library using the following snippet:
#### Snapshots
You can use the latest (unstable) version of Hipster under development. Just add the following dependency into your pom.xml:
```xml
sonatype-oss-public
https://oss.sonatype.org/content/groups/public/
true
es.usc.citius.hipster
hipster-all
1.0.2-SNAPSHOT
```
#### Releases
Current stable release is v1.0.1. See the [milestones](https://github.com/citiususc/hipster/milestones) to check the current development status.
```xml
es.usc.citius.hipster
hipster-all
1.0.1
```
#### Quick Example
Let's solve the graph used in [this Wikipedia article](http://en.wikipedia.org/wiki/Shortest_path_problem)
about Shortest paths.
Although Hipster is graph agnostic, we include some useful classes to create a graph or a
directed graph and the search problem. We create a graph using the GraphBuilder class and then
we use the GraphSearchProblem to create the required components to solve it using Dijkstra's algorithm:
```java
// Create a simple weighted directed graph with Hipster where
// vertices are Strings and edge values are just doubles
HipsterDirectedGraph graph =
GraphBuilder.create()
.connect("A").to("B").withEdge(4d)
.connect("A").to("C").withEdge(2d)
.connect("B").to("C").withEdge(5d)
.connect("B").to("D").withEdge(10d)
.connect("C").to("E").withEdge(3d)
.connect("D").to("F").withEdge(11d)
.connect("E").to("D").withEdge(4d)
.createDirectedGraph();
// Create the search problem. For graph problems, just use
// the GraphSearchProblem util class to generate the problem with ease.
SearchProblem p = GraphSearchProblem
.startingFrom("A")
.in(graph)
.takeCostsFromEdges()
.build();
// Search the shortest path from "A" to "F"
System.out.println(Hipster.createDijkstra(p).search("F"));
```
Output result:
`Total solutions: 1
Total time: 6 ms
Total number of iterations: 6
+ Solution 1:
- States:
[A, C, E, D, F]
- Actions:
[2.0, 3.0, 4.0, 11.0]
- Search information:
WeightedNode{state=F, cost=20.0, estimation=0.0, score=20.0}`
But that's not all. Hipster comes with different problem examples
that illustrate how Hipster can be used to solve a [wide variety of problems](https://github.com/citiususc/hipster/tree/0c0ec9cb5087fede9930a6efbd5126afd69896ac/hipster-examples/src/main/java/es/usc/citius/hipster/examples) (not only graph search).
## What's next?
If you want to learn how to solve a problem by searching with Hipster, check the [wiki](https://github.com/citiususc/hipster/wiki) and the [JavaDoc documentation](http://www.hipster4j.org/hipster-javadocs).
We also suggest you to check [this presentation](https://speakerdeck.com/pablormier/hipster-an-open-source-java-library-for-heuristic-search) for a quick introduction.
## License & Citation
This software is licensed under the Apache 2 license, quoted below.
Copyright 2013 Centro de Investigación en Tecnoloxías da Información (CITIUS),
University of Santiago de Compostela (USC).
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
### Citation
This library was presented in the "9th Iberian Conference on Information Systems and Technologies (CISTI), 2014". If you use this library in your research projects, we encourage you to please cite our work:
> Rodriguez-Mier, P., Gonzalez-Sieira, A., Mucientes, M., Lama, M. & Bugarin, A. (2014). **Hipster: An Open Source Java Library for Heuristic Search**. _9th Iberian Conference on Information Systems and Technologies (CISTI)_.
```
@inproceedings{RodriguezMier2014,
author = {Rodriguez-Mier, Pablo and Gonzalez-Sieira, Adrian and Mucientes, Manuel and and Lama, Manuel and Bugarin, Alberto},
booktitle = {9th Iberian Conference on Information Systems and Technologies (CISTI 2014)},
month = jun,
volume = 1,
title = {{Hipster: An Open Source Java Library for Heuristic Search}},
pages = {481--486},
isbn = "978-989-98434-2-4"
address = "Barcelona",
year = {2014}
}
```