Refactor graph package.

wrandelshofer · Oct 13, 2024 · 884fccf · 884fccf
1 parent bd49455
commit 884fccf
Show file tree

Hide file tree

Showing 28 changed files with 84 additions and 51 deletions.
diff --git a/.idea/compiler.xml b/.idea/compiler.xml
diff --git a/...tdraw8.graph/src/main/java/org.jhotdraw8.graph/org/jhotdraw8/graph/algo/package-info.java b/...tdraw8.graph/src/main/java/org.jhotdraw8.graph/org/jhotdraw8/graph/algo/package-info.java
@@ -0,0 +1,9 @@
+/*
+ * @(#)package-info.java
+ * Copyright © 2024 The authors and contributors of JHotDraw. MIT License.
+ */
+
+/**
+ * Provides algorithms for graphs.
+ */
+package org.jhotdraw8.graph.algo;
diff --git a/...hotdraw8.graph/src/main/java/org.jhotdraw8.graph/org/jhotdraw8/graph/io/package-info.java b/...hotdraw8.graph/src/main/java/org.jhotdraw8.graph/org/jhotdraw8/graph/io/package-info.java
@@ -0,0 +1,9 @@
+/*
+ * @(#)package-info.java
+ * Copyright © 2024 The authors and contributors of JHotDraw. MIT License.
+ */
+
+/**
+ * Provides classes for reading and writing graph data structures into files.
+ */
+package org.jhotdraw8.graph.io;
diff --git a/...w8.graph/src/main/java/org.jhotdraw8.graph/org/jhotdraw8/graph/iterator/package-info.java b/...w8.graph/src/main/java/org.jhotdraw8.graph/org/jhotdraw8/graph/iterator/package-info.java
@@ -0,0 +1,9 @@
+/*
+ * @(#)package-info.java
+ * Copyright © 2024 The authors and contributors of JHotDraw. MIT License.
+ */
+
+/**
+ * Provides iterators over graphs.
+ */
+package org.jhotdraw8.graph.iterator;
diff --git a/org.jhotdraw8.graph/src/main/java/org.jhotdraw8.graph/org/jhotdraw8/graph/package-info.java b/org.jhotdraw8.graph/src/main/java/org.jhotdraw8.graph/org/jhotdraw8/graph/package-info.java
@@ -4,6 +4,8 @@
  */
 
 /**
+ * Provides data structures for graphs.
+ * <p>
  * References:
  * <dl>
  *     <dt>Wikipedia. Path (graph theory). Walk, trail, path.

diff --git a/...aw8/graph/path/AllArcSequencesFinder.java → ...raph/path/algo/AllArcSequencesFinder.java b/...aw8/graph/path/AllArcSequencesFinder.java → ...raph/path/algo/AllArcSequencesFinder.java
@@ -3,7 +3,7 @@
  * Copyright © 2023 The authors and contributors of JHotDraw. MIT License.
  */
 
-package org.jhotdraw8.graph.path;
+package org.jhotdraw8.graph.path.algo;
 
 import org.jhotdraw8.collection.pair.OrderedPair;
 import org.jhotdraw8.graph.Arc;

diff --git a/.../graph/path/AllArrowsSequencesFinder.java → ...h/path/algo/AllArrowsSequencesFinder.java b/.../graph/path/AllArrowsSequencesFinder.java → ...h/path/algo/AllArrowsSequencesFinder.java
@@ -3,7 +3,7 @@
  * Copyright © 2023 The authors and contributors of JHotDraw. MIT License.
  */
 
-package org.jhotdraw8.graph.path;
+package org.jhotdraw8.graph.path.algo;
 
 import org.jhotdraw8.collection.pair.OrderedPair;
 import org.jhotdraw8.icollection.immutable.ImmutableList;

diff --git a/.../graph/path/AllVertexSequencesFinder.java → ...h/path/algo/AllVertexSequencesFinder.java b/.../graph/path/AllVertexSequencesFinder.java → ...h/path/algo/AllVertexSequencesFinder.java
@@ -3,7 +3,7 @@
  * Copyright © 2023 The authors and contributors of JHotDraw. MIT License.
  */
 
-package org.jhotdraw8.graph.path;
+package org.jhotdraw8.graph.path.algo;
 
 import org.jhotdraw8.collection.pair.OrderedPair;
 import org.jhotdraw8.icollection.immutable.ImmutableList;

diff --git a/...otdraw8/graph/path/ArcSequenceFinder.java → ...w8/graph/path/algo/ArcSequenceFinder.java b/...otdraw8/graph/path/ArcSequenceFinder.java → ...w8/graph/path/algo/ArcSequenceFinder.java
@@ -3,7 +3,7 @@
  * Copyright © 2023 The authors and contributors of JHotDraw. MIT License.
  */
 
-package org.jhotdraw8.graph.path;
+package org.jhotdraw8.graph.path.algo;
 
 import org.jhotdraw8.collection.pair.OrderedPair;
 import org.jhotdraw8.collection.pair.SimpleOrderedPair;

diff --git a/...draw8/graph/path/ArrowSequenceFinder.java → .../graph/path/algo/ArrowSequenceFinder.java b/...draw8/graph/path/ArrowSequenceFinder.java → .../graph/path/algo/ArrowSequenceFinder.java
@@ -3,7 +3,7 @@
  * Copyright © 2023 The authors and contributors of JHotDraw. MIT License.
  */
 
-package org.jhotdraw8.graph.path;
+package org.jhotdraw8.graph.path.algo;
 
 import org.jhotdraw8.collection.pair.OrderedPair;
 import org.jhotdraw8.collection.pair.SimpleOrderedPair;

diff --git a/...raph/path/CombinedAllSequencesFinder.java → ...path/algo/CombinedAllSequencesFinder.java b/...raph/path/CombinedAllSequencesFinder.java → ...path/algo/CombinedAllSequencesFinder.java
@@ -3,7 +3,7 @@
  * Copyright © 2023 The authors and contributors of JHotDraw. MIT License.
  */
 
-package org.jhotdraw8.graph.path;
+package org.jhotdraw8.graph.path.algo;
 
 /**
  * Interface for finding all sequences between a set of source

diff --git a/...w8/graph/path/CombinedSequenceFinder.java → ...aph/path/algo/CombinedSequenceFinder.java b/...w8/graph/path/CombinedSequenceFinder.java → ...aph/path/algo/CombinedSequenceFinder.java
@@ -3,7 +3,7 @@
  * Copyright © 2023 The authors and contributors of JHotDraw. MIT License.
  */
 
-package org.jhotdraw8.graph.path;
+package org.jhotdraw8.graph.path.algo;
 
 /**
  * Interface for finding arc-, arrow- and vertex-sequences

diff --git a/...raw8/graph/path/PathBuilderException.java → ...graph/path/algo/PathBuilderException.java b/...raw8/graph/path/PathBuilderException.java → ...graph/path/algo/PathBuilderException.java
@@ -2,7 +2,7 @@
  * @(#)PathBuilderException.java
  * Copyright © 2023 The authors and contributors of JHotDraw. MIT License.
  */
-package org.jhotdraw8.graph.path;
+package org.jhotdraw8.graph.path.algo;
 
 import java.io.Serial;
 

diff --git a/...draw8/graph/path/ReachabilityChecker.java → .../graph/path/algo/ReachabilityChecker.java b/...draw8/graph/path/ReachabilityChecker.java → .../graph/path/algo/ReachabilityChecker.java
@@ -3,7 +3,7 @@
  * Copyright © 2023 The authors and contributors of JHotDraw. MIT License.
  */
 
-package org.jhotdraw8.graph.path;
+package org.jhotdraw8.graph.path.algo;
 
 import org.jhotdraw8.graph.algo.AddToSet;
 

diff --git a/...ath/SimpleCombinedAllSequencesFinder.java → ...lgo/SimpleCombinedAllSequencesFinder.java b/...ath/SimpleCombinedAllSequencesFinder.java → ...lgo/SimpleCombinedAllSequencesFinder.java
@@ -3,13 +3,12 @@
  * Copyright © 2023 The authors and contributors of JHotDraw. MIT License.
  */
 
-package org.jhotdraw8.graph.path;
+package org.jhotdraw8.graph.path.algo;
 
 import org.jhotdraw8.base.function.Function3;
 import org.jhotdraw8.collection.pair.OrderedPair;
 import org.jhotdraw8.collection.spliterator.SpliteratorIterable;
 import org.jhotdraw8.graph.Arc;
-import org.jhotdraw8.graph.path.algo.AllWalksSpliterator;
 import org.jhotdraw8.graph.path.backlink.ArcBackLinkWithCost;
 import org.jhotdraw8.icollection.immutable.ImmutableList;
 

diff --git a/...ph/path/SimpleCombinedSequenceFinder.java → ...th/algo/SimpleCombinedSequenceFinder.java b/...ph/path/SimpleCombinedSequenceFinder.java → ...th/algo/SimpleCombinedSequenceFinder.java
@@ -3,14 +3,13 @@
  * Copyright © 2023 The authors and contributors of JHotDraw. MIT License.
  */
 
-package org.jhotdraw8.graph.path;
+package org.jhotdraw8.graph.path.algo;
 
 import org.jhotdraw8.base.function.Function3;
 import org.jhotdraw8.collection.pair.OrderedPair;
 import org.jhotdraw8.collection.pair.SimpleOrderedPair;
 import org.jhotdraw8.graph.Arc;
 import org.jhotdraw8.graph.algo.AddToSet;
-import org.jhotdraw8.graph.path.algo.ArcPathSearchAlgo;
 import org.jhotdraw8.graph.path.backlink.ArcBackLinkWithCost;
 import org.jhotdraw8.icollection.immutable.ImmutableList;
 import org.jspecify.annotations.Nullable;

diff --git a/...th/SimpleIndexedVertexSequenceFinder.java → ...go/SimpleIndexedVertexSequenceFinder.java b/...th/SimpleIndexedVertexSequenceFinder.java → ...go/SimpleIndexedVertexSequenceFinder.java
@@ -3,12 +3,11 @@
  * Copyright © 2023 The authors and contributors of JHotDraw. MIT License.
  */
 
-package org.jhotdraw8.graph.path;
+package org.jhotdraw8.graph.path.algo;
 
 import org.jhotdraw8.collection.pair.SimpleOrderedPair;
 import org.jhotdraw8.graph.algo.AddToIntSet;
 import org.jhotdraw8.graph.algo.AddToSet;
-import org.jhotdraw8.graph.path.algo.IndexedVertexPathSearchAlgo;
 import org.jhotdraw8.graph.path.backlink.IndexedVertexBackLinkWithCost;
 import org.jhotdraw8.icollection.immutable.ImmutableList;
 import org.jspecify.annotations.Nullable;

diff --git a/...graph/path/SimpleReachabilityChecker.java → .../path/algo/SimpleReachabilityChecker.java b/...graph/path/SimpleReachabilityChecker.java → .../path/algo/SimpleReachabilityChecker.java
@@ -3,12 +3,11 @@
  * Copyright © 2023 The authors and contributors of JHotDraw. MIT License.
  */
 
-package org.jhotdraw8.graph.path;
+package org.jhotdraw8.graph.path.algo;
 
 import org.jhotdraw8.base.function.Function3;
 import org.jhotdraw8.graph.Arc;
 import org.jhotdraw8.graph.algo.AddToSet;
-import org.jhotdraw8.graph.path.algo.ArcReachabilityAlgo;
 
 import java.util.Collections;
 import java.util.function.BiFunction;

diff --git a/...raph/path/SimpleVertexSequenceFinder.java → ...path/algo/SimpleVertexSequenceFinder.java b/...raph/path/SimpleVertexSequenceFinder.java → ...path/algo/SimpleVertexSequenceFinder.java
@@ -3,11 +3,10 @@
  * Copyright © 2023 The authors and contributors of JHotDraw. MIT License.
  */
 
-package org.jhotdraw8.graph.path;
+package org.jhotdraw8.graph.path.algo;
 
 import org.jhotdraw8.collection.pair.SimpleOrderedPair;
 import org.jhotdraw8.graph.algo.AddToSet;
-import org.jhotdraw8.graph.path.algo.VertexPathSearchAlgo;
 import org.jhotdraw8.graph.path.backlink.VertexBackLinkWithCost;
 import org.jhotdraw8.icollection.immutable.ImmutableList;
 import org.jspecify.annotations.Nullable;

diff --git a/...raw8/graph/path/VertexSequenceFinder.java → ...graph/path/algo/VertexSequenceFinder.java b/...raw8/graph/path/VertexSequenceFinder.java → ...graph/path/algo/VertexSequenceFinder.java
@@ -3,7 +3,7 @@
  * Copyright © 2023 The authors and contributors of JHotDraw. MIT License.
  */
 
-package org.jhotdraw8.graph.path;
+package org.jhotdraw8.graph.path.algo;
 
 import org.jhotdraw8.collection.pair.OrderedPair;
 import org.jhotdraw8.collection.pair.SimpleOrderedPair;

diff --git a/...8.graph/src/main/java/org.jhotdraw8.graph/org/jhotdraw8/graph/path/algo/package-info.java b/...8.graph/src/main/java/org.jhotdraw8.graph/org/jhotdraw8/graph/path/algo/package-info.java
@@ -0,0 +1,9 @@
+/*
+ * @(#)package-info.java
+ * Copyright © 2024 The authors and contributors of JHotDraw. MIT License.
+ */
+
+/**
+ * Provides algorithms for finding paths in graphs.
+ */
+package org.jhotdraw8.graph.path.algo;
diff --git a/...aph/src/main/java/org.jhotdraw8.graph/org/jhotdraw8/graph/path/backlink/package-info.java b/...aph/src/main/java/org.jhotdraw8.graph/org/jhotdraw8/graph/path/backlink/package-info.java
@@ -0,0 +1,9 @@
+/*
+ * @(#)package-info.java
+ * Copyright © 2024 The authors and contributors of JHotDraw. MIT License.
+ */
+
+/**
+ * Provides data structures that describe the result of path finding algorithms.
+ */
+package org.jhotdraw8.graph.path.backlink;
diff --git a/.../java/org.jhotdraw8.graph/org/jhotdraw8/graph/UniqueOrOneHopVertexPathSearchAlgoTest.java b/.../java/org.jhotdraw8.graph/org/jhotdraw8/graph/UniqueOrOneHopVertexPathSearchAlgoTest.java
@@ -7,9 +7,9 @@
 
 import org.jhotdraw8.collection.pair.SimpleOrderedPair;
 import org.jhotdraw8.graph.io.AdjacencyListWriter;
-import org.jhotdraw8.graph.path.SimpleVertexSequenceFinder;
-import org.jhotdraw8.graph.path.VertexSequenceFinder;
+import org.jhotdraw8.graph.path.algo.SimpleVertexSequenceFinder;
 import org.jhotdraw8.graph.path.algo.UniqueOrOneHopVertexPathSearchAlgo;
+import org.jhotdraw8.graph.path.algo.VertexSequenceFinder;
 import org.jhotdraw8.icollection.VectorList;
 import org.jhotdraw8.icollection.immutable.ImmutableList;
 import org.junit.jupiter.api.DynamicTest;

diff --git a/.../test/java/org.jhotdraw8.graph/org/jhotdraw8/graph/path/algo/AllWalksSpliteratorTest.java b/.../test/java/org.jhotdraw8.graph/org/jhotdraw8/graph/path/algo/AllWalksSpliteratorTest.java
@@ -7,8 +7,6 @@
 import org.jhotdraw8.collection.pair.OrderedPair;
 import org.jhotdraw8.graph.DirectedGraph;
 import org.jhotdraw8.graph.SimpleMutableDirectedGraph;
-import org.jhotdraw8.graph.path.CombinedAllSequencesFinder;
-import org.jhotdraw8.graph.path.SimpleCombinedAllSequencesFinder;
 import org.jhotdraw8.icollection.VectorList;
 import org.jhotdraw8.icollection.immutable.ImmutableList;
 import org.junit.jupiter.api.DynamicTest;

diff --git a/...ava/org.jhotdraw8.graph/org/jhotdraw8/graph/path/algo/ArbitraryArcPathSearchAlgoTest.java b/...ava/org.jhotdraw8.graph/org/jhotdraw8/graph/path/algo/ArbitraryArcPathSearchAlgoTest.java
@@ -9,10 +9,6 @@
 import org.jhotdraw8.graph.DirectedGraph;
 import org.jhotdraw8.graph.SimpleMutableDirectedGraph;
 import org.jhotdraw8.graph.io.AdjacencyListWriter;
-import org.jhotdraw8.graph.path.CombinedAllSequencesFinder;
-import org.jhotdraw8.graph.path.CombinedSequenceFinder;
-import org.jhotdraw8.graph.path.SimpleCombinedAllSequencesFinder;
-import org.jhotdraw8.graph.path.SimpleCombinedSequenceFinder;
 import org.jhotdraw8.icollection.VectorList;
 import org.jhotdraw8.icollection.immutable.ImmutableList;
 import org.jspecify.annotations.Nullable;

diff --git a/...jhotdraw8.graph/org/jhotdraw8/graph/path/algo/ArbitraryShortestArcPathSearchAlgoTest.java b/...jhotdraw8.graph/org/jhotdraw8/graph/path/algo/ArbitraryShortestArcPathSearchAlgoTest.java
@@ -10,8 +10,6 @@
 import org.jhotdraw8.graph.DirectedGraph;
 import org.jhotdraw8.graph.SimpleMutableDirectedGraph;
 import org.jhotdraw8.graph.io.AdjacencyListWriter;
-import org.jhotdraw8.graph.path.CombinedSequenceFinder;
-import org.jhotdraw8.graph.path.SimpleCombinedSequenceFinder;
 import org.jhotdraw8.icollection.VectorList;
 import org.jhotdraw8.icollection.immutable.ImmutableList;
 import org.junit.jupiter.api.DynamicTest;

diff --git a/...rg.jhotdraw8.graph/org/jhotdraw8/graph/path/algo/UniqueOnDagVertexPathSearchAlgoTest.java b/...rg.jhotdraw8.graph/org/jhotdraw8/graph/path/algo/UniqueOnDagVertexPathSearchAlgoTest.java
@@ -9,8 +9,6 @@
 import org.jhotdraw8.graph.DirectedGraph;
 import org.jhotdraw8.graph.SimpleMutableDirectedGraph;
 import org.jhotdraw8.graph.io.AdjacencyListWriter;
-import org.jhotdraw8.graph.path.SimpleVertexSequenceFinder;
-import org.jhotdraw8.graph.path.VertexSequenceFinder;
 import org.jhotdraw8.icollection.immutable.ImmutableList;
 import org.jspecify.annotations.Nullable;
 import org.junit.jupiter.api.DynamicTest;

diff --git a/...rg.jhotdraw8.graph/org/jhotdraw8/graph/path/algo/UniqueShortestArcPathSearchAlgoTest.java b/...rg.jhotdraw8.graph/org/jhotdraw8/graph/path/algo/UniqueShortestArcPathSearchAlgoTest.java
@@ -10,8 +10,6 @@
 import org.jhotdraw8.graph.DirectedGraph;
 import org.jhotdraw8.graph.SimpleMutableDirectedGraph;
 import org.jhotdraw8.graph.io.AdjacencyListWriter;
-import org.jhotdraw8.graph.path.CombinedSequenceFinder;
-import org.jhotdraw8.graph.path.SimpleCombinedSequenceFinder;
 import org.jhotdraw8.icollection.VectorList;
 import org.jhotdraw8.icollection.immutable.ImmutableList;
 import org.junit.jupiter.api.DynamicTest;
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,6 +4,8 @@ @@
      */
     /**
+     * Provides data structures for graphs.
+     * <p>
      * References:
      * <dl>
      *     <dt>Wikipedia. Path (graph theory). Walk, trail, path.
@@ Expand Down @@