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

Science Score: 13.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (16.9%) to scientific vocabulary

Keywords

android dijkstra graph-search heuristic-search hipster4j java search-algorithm shortest-paths

Keywords from Contributors

archival projection evolutionary-algorithms profiles interactive genetic-algorithm sequences generic observability autograding
Last synced: 5 months ago · JSON representation

Repository

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.

Basic Info
  • Host: GitHub
  • Owner: citiususc
  • License: apache-2.0
  • Language: Java
  • Default Branch: 1.0.X
  • Homepage: http://hipster4j.github.io
  • Size: 5.47 MB
Statistics
  • Stars: 325
  • Watchers: 27
  • Forks: 87
  • Open Issues: 29
  • Releases: 5
Topics
android dijkstra graph-search heuristic-search hipster4j java search-algorithm shortest-paths
Created almost 13 years ago · Last pushed over 2 years ago
Metadata Files
Readme Changelog Contributing License

README.md

Hipster

CI

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)
  • 3rd party adapters:

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 <!-- Use sonatype oss public for snapshots --> sonatype-oss-public https://oss.sonatype.org/content/groups/public/ true

<!-- Add this dependency under your pom.xml section to add all the dependencies of Hipster to your project. Add hipster-core instead of hipster-all for basic functionality. --> es.usc.citius.hipster hipster-all 1.0.2-SNAPSHOT ```

Releases

Current stable release is v1.0.1. See the milestones to check the current development status.

xml <dependencies> <!-- Add this dependency under your pom.xml <dependencies> section to add all the dependencies of Hipster to your project. Add hipster-core instead of hipster-all for core functionality. --> <dependency> <groupId>es.usc.citius.hipster</groupId> <artifactId>hipster-all</artifactId> <version>1.0.1</version> </dependency> </dependencies>

Quick Example

Let's solve the graph used in this Wikipedia article about Shortest paths.

DirectedGraph

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 (not only graph search).

What's next?

If you want to learn how to solve a problem by searching with Hipster, check the wiki and the JavaDoc documentation. We also suggest you to check this presentation 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} }

Owner

  • Name: CiTIUS
  • Login: citiususc
  • Kind: organization
  • Email: citius@usc.es
  • Location: Santiago de Compostela

Centro Singular de Investigación en Tecnoloxías Intelixenteas da Universidade de Santiago de Compostela

GitHub Events

Total
  • Watch event: 2
  • Fork event: 1
Last Year
  • Watch event: 2
  • Fork event: 1

Committers

Last synced: 9 months ago

All Time
  • Total Commits: 663
  • Total Committers: 18
  • Avg Commits per committer: 36.833
  • Development Distribution Score (DDS): 0.323
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
pablo.rodriguez.mier p****r@u****s 449
Adrián González Sieira a****z@u****s 115
Pablo p****r@g****m 41
adrian a****n@d****3 27
michaelhaaf m****h@e****m 5
Andrew Grant a****3@g****m 5
dependabot[bot] 4****] 4
adrian a****n@a****0 4
Anurag Saxena a****r@g****m 2
Gareth Stretton g****n@g****m 2
PaulJackson123 p****3@v****t 2
Florian Bronder F****r@g****m 1
adrian a****n@a****u 1
Adrián González Sieira a****a@g****m 1
Adrián González Sieira a****r 1
Jennnnyz j****5@g****m 1
cmoins c****s@y****r 1
gabizekany g****1@y****m 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 7 months ago

All Time
  • Total issues: 271
  • Total pull requests: 66
  • Average time to close issues: 6 months
  • Average time to close pull requests: 5 months
  • Total issue authors: 21
  • Total pull request authors: 13
  • Average comments per issue: 0.65
  • Average comments per pull request: 1.53
  • Merged pull requests: 43
  • Bot issues: 0
  • Bot pull requests: 13
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • pablormier (36)
  • gonzalezsieira (19)
  • gahrae (3)
  • michaelhaaf (2)
  • martin3361 (1)
  • iad24 (1)
  • FrankS101 (1)
  • nikolauskrismer (1)
  • brendon-boldt (1)
  • davisg123 (1)
  • damianflannery (1)
  • bparv (1)
  • tetv (1)
  • ketan-vijayvargiya (1)
  • Maryia-M (1)
Pull Request Authors
  • dependabot[bot] (7)
  • michaelhaaf (5)
  • gabizekany (2)
  • gahrae (2)
  • andyg7 (1)
  • gonzalezsieira (1)
  • PaulJackson123 (1)
  • FlorianBronder (1)
  • anuragster (1)
  • ChenZhangg (1)
  • cmoins (1)
  • ankitramtriya (1)
  • Austinste (1)
Top Labels
Issue Labels
enhancement (22) task (13) question (9) bug (8) configuration (5) minor changes (4) in progress (3) ready (3) up-for-grabs (2) wontfix (2) duplicate (1) documentation (1) planned (1)
Pull Request Labels
dependencies (7) minor changes (2)

Packages

  • Total packages: 7
  • Total downloads: unknown
  • Total dependent packages: 13
    (may contain duplicates)
  • Total dependent repositories: 41
    (may contain duplicates)
  • Total versions: 27
repo1.maven.org: es.usc.citius.hipster:hipster-core

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.

  • Versions: 4
  • Dependent Packages: 9
  • Dependent Repositories: 21
Rankings
Dependent repos count: 5.3%
Dependent packages count: 6.7%
Average: 12.6%
Stargazers count: 18.8%
Forks count: 19.5%
Last synced: 6 months ago
repo1.maven.org: es.usc.citius.hipster:hipster-third-party-graphs

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.

  • Versions: 4
  • Dependent Packages: 2
  • Dependent Repositories: 2
Rankings
Dependent repos count: 16.1%
Stargazers count: 18.8%
Average: 19.4%
Forks count: 19.5%
Dependent packages count: 23.2%
Last synced: 6 months ago
repo1.maven.org: es.usc.citius.hipster:hipster-test

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.

  • Versions: 4
  • Dependent Packages: 1
  • Dependent Repositories: 2
Rankings
Dependent repos count: 16.1%
Stargazers count: 18.8%
Forks count: 19.5%
Average: 21.8%
Dependent packages count: 33.0%
Last synced: 6 months ago
repo1.maven.org: es.usc.citius.hipster:hipster-examples

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.

  • Versions: 4
  • Dependent Packages: 1
  • Dependent Repositories: 2
Rankings
Dependent repos count: 16.1%
Stargazers count: 18.8%
Forks count: 19.5%
Average: 21.8%
Dependent packages count: 33.0%
Last synced: 6 months ago
repo1.maven.org: es.usc.citius.hipster:hipster-all

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.

  • Versions: 4
  • Dependent Packages: 0
  • Dependent Repositories: 14
Rankings
Dependent repos count: 6.6%
Stargazers count: 18.8%
Forks count: 19.5%
Average: 23.7%
Dependent packages count: 50.1%
Last synced: 6 months ago
repo1.maven.org: es.usc.citius.hipster:hipster-pom

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.

  • Versions: 4
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Forks count: 13.6%
Stargazers count: 13.9%
Average: 27.1%
Dependent repos count: 32.0%
Dependent packages count: 48.9%
Last synced: 6 months ago
repo1.maven.org: es.usc.citius.hipster:hipster-extensions

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.

  • Versions: 3
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Forks count: 13.6%
Stargazers count: 13.9%
Average: 27.1%
Dependent repos count: 32.0%
Dependent packages count: 48.9%
Last synced: 6 months ago

Dependencies

hipster-all/pom.xml maven
  • es.usc.citius.hipster:hipster-core 1.0.2-SNAPSHOT
  • es.usc.citius.hipster:hipster-examples 1.0.2-SNAPSHOT
  • es.usc.citius.hipster:hipster-test 1.0.2-SNAPSHOT
hipster-core/pom.xml maven
  • com.google.guava:guava test
hipster-examples/pom.xml maven
  • com.google.guava:guava 29.0-jre
  • com.intellij:forms_rt 7.0.3
  • es.usc.citius.hipster:hipster-core 1.0.2-SNAPSHOT
  • es.usc.citius.hipster:hipster-third-party-graphs 1.0.2-SNAPSHOT
hipster-extensions/pom.xml maven
  • com.google.code.findbugs:jsr305 3.0.0
  • com.google.guava:guava 29.0-jre
  • es.usc.citius.hipster:hipster-core 1.0.2-SNAPSHOT
  • es.usc.citius.hipster:hipster-third-party-graphs 1.0.2-SNAPSHOT
hipster-test/pom.xml maven
  • com.google.code.findbugs:jsr305
  • com.google.guava:guava
  • es.usc.citius.hipster:hipster-core 1.0.2-SNAPSHOT test
hipster-third-party-graphs/pom.xml maven
  • com.tinkerpop.blueprints:blueprints-core 2.4.0
  • com.tinkerpop.blueprints:blueprints-graph-jung 2.4.0
  • es.usc.citius.hipster:hipster-core ${project.version}
  • net.sf.jung:jung-algorithms 2.0.1
  • net.sf.jung:jung-graph-impl 2.0.1
  • net.sf.jung:jung-io 2.0.1
pom.xml maven
  • com.google.code.findbugs:jsr305 3.0.0
  • com.google.guava:guava 29.0-jre
  • junit:junit
  • junit:junit 4.13.1 test
.github/workflows/maven.yml actions
  • actions/checkout v2 composite
  • actions/setup-java v2 composite