Skip to content

Commit

Permalink
Release 0.5.0
Browse files Browse the repository at this point in the history
  • Loading branch information
barakugav committed Jul 1, 2024
1 parent e6a1f26 commit 8301411
Show file tree
Hide file tree
Showing 9 changed files with 13 additions and 13 deletions.
3 changes: 2 additions & 1 deletion .github/workflows/javadoc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,9 @@ jobs:
mv 0.2.0 ${{ runner.temp }}/docs/
mv 0.3.0 ${{ runner.temp }}/docs/
mv 0.4.0 ${{ runner.temp }}/docs/
mv 0.5.0 ${{ runner.temp }}/docs/
mv ${{ runner.temp }}/docs-snapshot/index.html ${{ runner.temp }}/docs-snapshot/index-main.html
mv ${{ runner.temp }}/docs-snapshot ${{ runner.temp }}/docs/0.4.1-snapshot
mv ${{ runner.temp }}/docs-snapshot ${{ runner.temp }}/docs/0.5.1-snapshot
- name: Deploy to Documentation Branch
uses: JamesIves/github-pages-deploy-action@v4
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The library runs on Java 11 or higher, and it is installed using [Maven](https:/

JGAlgo offer [unparalleled speed](https://github.com/barakugav/JGAlgo/actions/workflows/benchmarks.yaml) and efficiency by implementing algorithms with theoretically guaranteed running times using the most efficient underlying building blocks and data-structures. A few concrete reasons for the library performance are:
- All building blocks of the library are primitives, rather than Objects
- The underlying [Graph](https://barakugav.github.io/JGAlgo/0.4.0/com/jgalgo/graph/Graph.html) implementations and algorithms do not use costly hash maps, only plain primitive arrays, yielding faster query time, smaller memory footprint and better cache hit rate
- The underlying [Graph](https://barakugav.github.io/JGAlgo/0.5.0/com/jgalgo/graph/Graph.html) implementations and algorithms do not use costly hash maps, only plain primitive arrays, yielding faster query time, smaller memory footprint and better cache hit rate
- Extensive use of [fastutil](https://fastutil.di.unimi.it/) for all collections
- Memory allocations are postpone and reused by algorithms objects

Expand All @@ -30,12 +30,12 @@ Add the following lines to your `pom.xml`:
<dependency>
<groupId>com.jgalgo</groupId>
<artifactId>jgalgo-core</artifactId>
<version>0.4.0</version>
<version>0.5.0</version>
</dependency>
```


The most basic object in the library is a [Graph](https://barakugav.github.io/JGAlgo/0.4.0/com/jgalgo/graph/Graph.html). A graph consist of vertices and edges (directed or undirected) connecting between pairs of vertices, all represented by some hashable objects. Algorithms such as [shortest path algorithm](https://barakugav.github.io/JGAlgo/0.4.0/com/jgalgo/alg/ShortestPathSingleSource.html) accept a graph as an input and perform some computation on it. Here is a snippet creating an undirected graph representing the roads between cities in Germany, and computing the shortest path from a source city to all others with respect to a weight function:
The most basic object in the library is a [Graph](https://barakugav.github.io/JGAlgo/0.5.0/com/jgalgo/graph/Graph.html). A graph consist of vertices and edges (directed or undirected) connecting between pairs of vertices, all represented by some hashable objects. Algorithms such as [shortest path algorithm](https://barakugav.github.io/JGAlgo/0.5.0/com/jgalgo/alg/shortestpath/ShortestPathSingleSource.html) accept a graph as an input and perform some computation on it. Here is a snippet creating an undirected graph representing the roads between cities in Germany, and computing the shortest path from a source city to all others with respect to a weight function:

```java
/* Create an undirected graph with three vertices and edges between them */
Expand Down
2 changes: 1 addition & 1 deletion jgalgo-adapt-guava/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<parent>
<groupId>com.jgalgo</groupId>
<artifactId>jgalgo</artifactId>
<version>0.4.1-SNAPSHOT</version>
<version>0.5.0</version>
</parent>
<artifactId>jgalgo-adapt-guava</artifactId>
<name>JGAlgo - Guava Adapters</name>
Expand Down
2 changes: 1 addition & 1 deletion jgalgo-adapt-jgrapht/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<parent>
<groupId>com.jgalgo</groupId>
<artifactId>jgalgo</artifactId>
<version>0.4.1-SNAPSHOT</version>
<version>0.5.0</version>
</parent>
<artifactId>jgalgo-adapt-jgrapht</artifactId>
<name>JGAlgo - JGraphT Adapters</name>
Expand Down
2 changes: 1 addition & 1 deletion jgalgo-bench/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<parent>
<groupId>com.jgalgo</groupId>
<artifactId>jgalgo</artifactId>
<version>0.4.1-SNAPSHOT</version>
<version>0.5.0</version>
</parent>
<artifactId>jgalgo-bench</artifactId>
<name>JGAlgo - Benchmarks</name>
Expand Down
2 changes: 1 addition & 1 deletion jgalgo-core/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<parent>
<groupId>com.jgalgo</groupId>
<artifactId>jgalgo</artifactId>
<version>0.4.1-SNAPSHOT</version>
<version>0.5.0</version>
</parent>
<artifactId>jgalgo-core</artifactId>
<name>JGAlgo - Core</name>
Expand Down
2 changes: 1 addition & 1 deletion jgalgo-example/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<parent>
<groupId>com.jgalgo</groupId>
<artifactId>jgalgo</artifactId>
<version>0.4.1-SNAPSHOT</version>
<version>0.5.0</version>
</parent>
<artifactId>jgalgo-example</artifactId>
<name>JGAlgo - Examples</name>
Expand Down
2 changes: 1 addition & 1 deletion jgalgo-io/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<parent>
<groupId>com.jgalgo</groupId>
<artifactId>jgalgo</artifactId>
<version>0.4.1-SNAPSHOT</version>
<version>0.5.0</version>
</parent>
<artifactId>jgalgo-io</artifactId>
<name>JGAlgo - IO</name>
Expand Down
5 changes: 2 additions & 3 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<groupId>com.jgalgo</groupId>
<artifactId>jgalgo</artifactId>
<name>JGAlgo - Parent</name>
<version>0.4.1-SNAPSHOT</version>
<version>0.5.0</version>
<packaging>pom</packaging>
<url>https://www.jgalgo.com/</url>
<description>A performant Java library for graph algorithms</description>
Expand All @@ -23,7 +23,7 @@
<url>https://github.com/barakugav/JGAlgo.git</url>
<connection>scm:git:[email protected]:barakugav/JGAlgo.git</connection>
<developerConnection>scm:git:[email protected]:barakugav/JGAlgo.git</developerConnection>
<tag>jgalgo-0.4.0</tag>
<tag>jgalgo-0.5.0</tag>
</scm>

<developers>
Expand Down Expand Up @@ -76,7 +76,6 @@
<module>jgalgo-io</module>
<module>jgalgo-adapt-guava</module>
<module>jgalgo-adapt-jgrapht</module>
<module>jgalgo-bench</module>
<module>jgalgo-example</module>
</modules>

Expand Down

0 comments on commit 8301411

Please sign in to comment.