228 Add get boundaries to Spatial Index (#229)

* Add getBoundaries to SpatialIndex

* Fix issue with empty boundaries

Author: mbastian

src/main/java/org/gephi/graph/api/Rect2D.java

@@ -173,4 +173,26 @@ public boolean contains(float minX, float minY, float maxX, float maxY) {
     public boolean intersects(float minX, float minY, float maxX, float maxY) {
         return this.minX <= maxX && minX <= this.maxX && this.maxY >= minY && maxY >= this.minY;
     }
+
+    @Override
+    public boolean equals(Object obj) {
+        if (this == obj) {
+            return true;
+        }
+        if (obj == null || getClass() != obj.getClass()) {
+            return false;
+        }
+        Rect2D rect2D = (Rect2D) obj;
+        return Float.compare(rect2D.minX, minX) == 0 && Float.compare(rect2D.minY, minY) == 0 && Float
+                .compare(rect2D.maxX, maxX) == 0 && Float.compare(rect2D.maxY, maxY) == 0;
+    }
+
+    @Override
+    public int hashCode() {
+        int result = (minX != +0.0f ? Float.floatToIntBits(minX) : 0);
+        result = 31 * result + (minY != +0.0f ? Float.floatToIntBits(minY) : 0);
+        result = 31 * result + (maxX != +0.0f ? Float.floatToIntBits(maxX) : 0);
+        result = 31 * result + (maxY != +0.0f ? Float.floatToIntBits(maxY) : 0);
+        return result;
+    }
 }

src/main/java/org/gephi/graph/api/SpatialIndex.java

@@ -37,4 +37,12 @@ public interface SpatialIndex {
      * @return edges in the area
      */
     EdgeIterable getEdgesInArea(Rect2D rect);
+
+    /**
+     * Returns the bounding rectangle that contains all nodes in the graph. The
+     * boundaries are calculated based on each node's position and size.
+     *
+     * @return the bounding rectangle, or null if there are no nodes
+     */
+    Rect2D getBoundaries();
 }

src/main/java/org/gephi/graph/impl/GraphViewDecorator.java

@@ -845,6 +845,46 @@ public EdgeIterable getEdgesInArea(Rect2D rect) {
         return new EdgeIterableWrapper(new EdgeViewIterator(iterator), graphStore.spatialIndex.nodesTree.lock);
     }
 
+    @Override
+    public Rect2D getBoundaries() {
+        graphStore.autoReadLock();
+        try {
+            float minX = Float.POSITIVE_INFINITY;
+            float minY = Float.POSITIVE_INFINITY;
+            float maxX = Float.NEGATIVE_INFINITY;
+            float maxY = Float.NEGATIVE_INFINITY;
+
+            boolean hasNodes = false;
+
+            // Iterate only through nodes visible in this view
+            for (Node node : getNodes()) {
+                hasNodes = true;
+                final float x = node.x();
+                final float y = node.y();
+                final float size = node.size();
+
+                final float nodeMinX = x - size;
+                final float nodeMinY = y - size;
+                final float nodeMaxX = x + size;
+                final float nodeMaxY = y + size;
+
+                if (nodeMinX < minX)
+                    minX = nodeMinX;
+                if (nodeMinY < minY)
+                    minY = nodeMinY;
+                if (nodeMaxX > maxX)
+                    maxX = nodeMaxX;
+                if (nodeMaxY > maxY)
+                    maxY = nodeMaxY;
+            }
+
+            return hasNodes ? new Rect2D(minX, minY, maxX, maxY) : new Rect2D(Float.NEGATIVE_INFINITY,
+                    Float.NEGATIVE_INFINITY, Float.POSITIVE_INFINITY, Float.POSITIVE_INFINITY);
+        } finally {
+            graphStore.autoReadUnlock();
+        }
+    }
+
     protected final class NodeViewIterator implements Iterator<Node> {
 
         private final Iterator<Node> nodeIterator;

src/main/java/org/gephi/graph/impl/NodesQuadTree.java

@@ -16,8 +16,6 @@
 /**
  * Adapted from https://bitbucket.org/C3/quadtree/wiki/Home
  *
- * TODO: unit tests!!
- *
  * @author Eduardo Ramos
  */
 public class NodesQuadTree {
@@ -171,6 +169,44 @@ public int getDepth() {
         return depth;
     }
 
+    public Rect2D getBoundaries() {
+        readLock();
+        try {
+            NodeIterable allNodes = getAllNodes();
+
+            float minX = Float.POSITIVE_INFINITY;
+            float minY = Float.POSITIVE_INFINITY;
+            float maxX = Float.NEGATIVE_INFINITY;
+            float maxY = Float.NEGATIVE_INFINITY;
+
+            boolean hasNodes = false;
+
+            for (Node node : allNodes) {
+                SpatialNodeDataImpl spatialData = ((NodeImpl) node).getSpatialData();
+                if (spatialData != null) {
+                    hasNodes = true;
+                    if (spatialData.minX < minX) {
+                        minX = spatialData.minX;
+                    }
+                    if (spatialData.minY < minY) {
+                        minY = spatialData.minY;
+                    }
+                    if (spatialData.maxX > maxX) {
+                        maxX = spatialData.maxX;
+                    }
+                    if (spatialData.maxY > maxY) {
+                        maxY = spatialData.maxY;
+                    }
+                }
+            }
+
+            return hasNodes ? new Rect2D(minX, minY, maxX, maxY) : new Rect2D(Float.NEGATIVE_INFINITY,
+                    Float.NEGATIVE_INFINITY, Float.POSITIVE_INFINITY, Float.POSITIVE_INFINITY);
+        } finally {
+            readUnlock();
+        }
+    }
+
     protected class QuadTreeNode {
 
         private Set<NodeImpl> objects = null;

src/main/java/org/gephi/graph/impl/SpatialIndexImpl.java

@@ -59,6 +59,11 @@ protected void moveNode(final NodeImpl node) {
         nodesTree.updateNode(node, minX, minY, maxX, maxY);
     }
 
+    @Override
+    public Rect2D getBoundaries() {
+        return nodesTree.getBoundaries();
+    }
+
     protected class EdgeIterator implements Iterator<Edge> {
 
         private final Iterator<Node> nodeItr;

src/test/java/org/gephi/graph/impl/GraphViewDecoratorTest.java

@@ -20,12 +20,15 @@
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.Random;
+import org.gephi.graph.api.Configuration;
 import org.gephi.graph.api.DirectedSubgraph;
 import org.gephi.graph.api.Edge;
 import org.gephi.graph.api.Element;
 import org.gephi.graph.api.ElementIterable;
 import org.gephi.graph.api.Interval;
 import org.gephi.graph.api.Node;
+import org.gephi.graph.api.Rect2D;
+import org.gephi.graph.api.SpatialIndex;
 import org.gephi.graph.api.UndirectedSubgraph;
 import org.testng.Assert;
 import org.testng.annotations.Test;
@@ -918,6 +921,189 @@ private GraphStore convertToStore(GraphViewImpl view) {
         return store;
     }
 
+    @Test
+    public void testGetBoundariesEmptyView() {
+        GraphStore graphStore = GraphGenerator.generateEmptyGraphStore(getSpatialConfig());
+        GraphViewStore store = graphStore.viewStore;
+        GraphViewImpl view = store.createView();
+
+        DirectedSubgraph graph = store.getDirectedGraph(view);
+
+        Assert.assertEquals(new Rect2D(Float.NEGATIVE_INFINITY, Float.NEGATIVE_INFINITY, Float.POSITIVE_INFINITY,
+                Float.POSITIVE_INFINITY), graph.getSpatialIndex().getBoundaries());
+    }
+
+    @Test
+    public void testGetBoundariesSingleNodeInView() {
+        GraphStore graphStore = GraphGenerator.generateEmptyGraphStore(getSpatialConfig());
+        GraphViewStore store = graphStore.viewStore;
+        GraphViewImpl view = store.createView();
+
+        // Add a node to the graph store
+        NodeImpl node1 = (NodeImpl) graphStore.factory.newNode("1");
+        node1.setPosition(100, 200);
+        node1.setSize(10);
+        graphStore.addNode(node1);
+
+        NodeImpl node2 = (NodeImpl) graphStore.factory.newNode("2");
+        node2.setPosition(500, 600);
+        node2.setSize(20);
+        graphStore.addNode(node2);
+
+        // Add only node1 to the view
+        view.addNode(node1);
+
+        DirectedSubgraph graph = store.getDirectedGraph(view);
+
+        // Should return boundaries only for node1
+        Rect2D boundaries = graph.getSpatialIndex().getBoundaries();
+        Assert.assertNotNull(boundaries);
+        Assert.assertEquals(boundaries.minX, 90f); // 100 - 10
+        Assert.assertEquals(boundaries.minY, 190f); // 200 - 10
+        Assert.assertEquals(boundaries.maxX, 110f); // 100 + 10
+        Assert.assertEquals(boundaries.maxY, 210f); // 200 + 10
+    }
+
+    @Test
+    public void testGetBoundariesMultipleNodesInView() {
+        GraphStore graphStore = GraphGenerator.generateEmptyGraphStore(getSpatialConfig());
+        GraphViewStore store = graphStore.viewStore;
+        GraphViewImpl view = store.createView();
+
+        // Add nodes to the graph store
+        NodeImpl node1 = (NodeImpl) graphStore.factory.newNode("1");
+        node1.setPosition(0, 0);
+        node1.setSize(5);
+        graphStore.addNode(node1);
+
+        NodeImpl node2 = (NodeImpl) graphStore.factory.newNode("2");
+        node2.setPosition(100, 200);
+        node2.setSize(10);
+        graphStore.addNode(node2);
+
+        NodeImpl node3 = (NodeImpl) graphStore.factory.newNode("3");
+        node3.setPosition(500, 600); // This node won't be in the view
+        node3.setSize(20);
+        graphStore.addNode(node3);
+
+        // Add only node1 and node2 to the view
+        view.addNode(node1);
+        view.addNode(node2);
+
+        DirectedSubgraph graph = store.getDirectedGraph(view);
+
+        // Should return boundaries only for node1 and node2
+        Rect2D boundaries = graph.getSpatialIndex().getBoundaries();
+        Assert.assertNotNull(boundaries);
+        Assert.assertEquals(boundaries.minX, -5f); // node1: 0 - 5
+        Assert.assertEquals(boundaries.minY, -5f); // node1: 0 - 5
+        Assert.assertEquals(boundaries.maxX, 110f); // node2: 100 + 10
+        Assert.assertEquals(boundaries.maxY, 210f); // node2: 200 + 10
+    }
+
+    @Test
+    public void testGetBoundariesViewSubsetVsFullGraph() {
+        GraphStore graphStore = GraphGenerator.generateEmptyGraphStore(getSpatialConfig());
+        GraphViewStore store = graphStore.viewStore;
+        GraphViewImpl view = store.createView();
+
+        // Add nodes to the graph store
+        NodeImpl node1 = (NodeImpl) graphStore.factory.newNode("1");
+        node1.setPosition(0, 0);
+        node1.setSize(5);
+        graphStore.addNode(node1);
+
+        NodeImpl node2 = (NodeImpl) graphStore.factory.newNode("2");
+        node2.setPosition(100, 200);
+        node2.setSize(10);
+        graphStore.addNode(node2);
+
+        NodeImpl node3 = (NodeImpl) graphStore.factory.newNode("3");
+        node3.setPosition(-50, -100);
+        node3.setSize(15);
+        graphStore.addNode(node3);
+
+        // Add only first two nodes to the view
+        view.addNode(node1);
+        view.addNode(node2);
+
+        DirectedSubgraph viewGraph = store.getDirectedGraph(view);
+        DirectedSubgraph fullGraph = graphStore;
+
+        // Get boundaries for both
+        Rect2D viewBoundaries = viewGraph.getSpatialIndex().getBoundaries();
+        Rect2D fullBoundaries = graphStore.spatialIndex.getBoundaries();
+
+        // View boundaries should only include node1 and node2
+        Assert.assertNotNull(viewBoundaries);
+        Assert.assertEquals(viewBoundaries.minX, -5f); // node1: 0 - 5
+        Assert.assertEquals(viewBoundaries.minY, -5f); // node1: 0 - 5
+        Assert.assertEquals(viewBoundaries.maxX, 110f); // node2: 100 + 10
+        Assert.assertEquals(viewBoundaries.maxY, 210f); // node2: 200 + 10
+
+        // Full graph boundaries should include all nodes
+        Assert.assertNotNull(fullBoundaries);
+        Assert.assertEquals(fullBoundaries.minX, -65f); // node3: -50 - 15
+        Assert.assertEquals(fullBoundaries.minY, -115f); // node3: -100 - 15
+        Assert.assertEquals(fullBoundaries.maxX, 110f); // node2: 100 + 10
+        Assert.assertEquals(fullBoundaries.maxY, 210f); // node2: 200 + 10
+
+        // They should be different
+        Assert.assertFalse(viewBoundaries.minX == fullBoundaries.minX);
+        Assert.assertFalse(viewBoundaries.minY == fullBoundaries.minY);
+    }
+
+    @Test
+    public void testGetBoundariesAfterViewChanges() {
+        GraphStore graphStore = GraphGenerator.generateEmptyGraphStore(getSpatialConfig());
+        GraphViewStore store = graphStore.viewStore;
+        GraphViewImpl view = store.createView();
+
+        // Add nodes to the graph store
+        NodeImpl node1 = (NodeImpl) graphStore.factory.newNode("1");
+        node1.setPosition(0, 0);
+        node1.setSize(5);
+        graphStore.addNode(node1);
+
+        NodeImpl node2 = (NodeImpl) graphStore.factory.newNode("2");
+        node2.setPosition(100, 200);
+        node2.setSize(10);
+        graphStore.addNode(node2);
+
+        DirectedSubgraph graph = store.getDirectedGraph(view);
+
+        // Initially empty view
+        Rect2D boundaries = graph.getSpatialIndex().getBoundaries();
+        Rect2D expected = new Rect2D(Float.NEGATIVE_INFINITY, Float.NEGATIVE_INFINITY, Float.POSITIVE_INFINITY,
+                Float.POSITIVE_INFINITY);
+        Assert.assertEquals(expected, boundaries);
+
+        // Add first node to view
+        view.addNode(node1);
+        Rect2D boundaries1 = graph.getSpatialIndex().getBoundaries();
+        Assert.assertNotNull(boundaries1);
+        Assert.assertEquals(boundaries1.minX, -5f);
+        Assert.assertEquals(boundaries1.maxX, 5f);
+
+        // Add second node to view
+        view.addNode(node2);
+        Rect2D boundaries2 = graph.getSpatialIndex().getBoundaries();
+        Assert.assertNotNull(boundaries2);
+        Assert.assertEquals(boundaries2.minX, -5f);
+        Assert.assertEquals(boundaries2.maxX, 110f);
+
+        // Remove first node from view
+        view.removeNode(node1);
+        Rect2D boundaries3 = graph.getSpatialIndex().getBoundaries();
+        Assert.assertNotNull(boundaries3);
+        Assert.assertEquals(boundaries3.minX, 90f); // Only node2 remains
+        Assert.assertEquals(boundaries3.maxX, 110f);
+
+        // Remove last node from view
+        view.removeNode(node2);
+        Assert.assertEquals(expected, graph.getSpatialIndex().getBoundaries());
+    }
+
     private void addSomeElements(GraphStore store, GraphViewImpl view) {
         double perc = 0.8;
         Random rand = new Random(98324);
@@ -934,4 +1120,9 @@ private void addSomeElements(GraphStore store, GraphViewImpl view) {
             }
         }
     }
+
+    // Configuration with spatial index enabled
+    private Configuration getSpatialConfig() {
+        return Configuration.builder().enableSpatialIndex(true).build();
+    }
 }