Range queries (#40)

Implements range queries (e.g., `5..6 vertices`).
Closes #20.

Author: mdbrnowski

README.md

@@ -33,17 +33,17 @@ graphreveal search "10 edges, bipartite, no isolated vertices, 2 components"
 ```
 
 ```shell
-graphreveal search --count "6 vertices, connected"
+graphreveal search --count "5..6 vertices, connected"
 ```
 
 Without `--count`, this command will print a list of graphs in [graph6](https://users.cecs.anu.edu.au/~bdm/data/formats.html) format. You can use [houseofgraphs.org](https://houseofgraphs.org/draw_graph) to visualize them.
 
 ### List of available properties
 
-* [int] `vertices` (alternatives: `verts`,`V`, `nodes`)
-* [int] `edges` (alternative: `E`)
-* [int] `blocks` (alternative: `biconnected components`)
-* [int] `components` (alternative: `C`)
+* [N] `vertices` (alternatives: `verts`,`V`, `nodes`)
+* [N] `edges` (alternative: `E`)
+* [N] `blocks` (alternative: `biconnected components`)
+* [N] `components` (alternative: `C`)
 * `acyclic` (alternative: `forest`)
 * `bipartite`
 * `complete`
@@ -56,4 +56,5 @@ Without `--count`, this command will print a list of graphs in [graph6](https://
 * `regular`
 * `tree`
 
-You can also negate these properties using `!` or `not`.
+As [N], you can use a simple number or range (e.g., `3-4`, `3..4`, `< 5`, `>= 2`).
+You can also negate any property using `!` or `not`.

src/graphreveal/__init__.py

@@ -3,7 +3,7 @@
 
 from platformdirs import user_data_dir
 
-__version__ = "0.2.2"
+__version__ = "0.3.0"
 
 DATABASE_PATH = os.path.join(
     user_data_dir(appname="graphreveal", appauthor="graphreveal"), "graphs.db"

src/graphreveal/translator/QueryLexer.g4

@@ -13,6 +13,12 @@ SEPERATOR: ',' | ';';
 
 NOT: 'not' | '!';
 
+LESS             : '<';
+GREATER          : '>';
+LESS_OR_EQUAL    : '<=';
+GREATER_OR_EQUAL : '>=';
+RANGE_OPERATOR   : '..' | '-';
+
 VERTEX : 'vertex' | 'vertices' | 'vertexes' | 'verts' | 'V' | 'node' | 'nodes';
 EDGE   : 'edge' | 'edges' | 'E';
 BLOCK:

src/graphreveal/translator/QueryParser.g4

@@ -13,14 +13,19 @@ query
     ;
 
 expr
-    : numEntityProperty     # simpleExpr
-    | boolProperty          # simpleExpr
-    | NOT numEntityProperty # notExpr
-    | NOT boolProperty      # notExpr
+    : entityProperty     # simpleExpr
+    | boolProperty       # simpleExpr
+    | NOT entityProperty # notExpr
+    | NOT boolProperty   # notExpr
     ;
 
-numEntityProperty
-    : INTEGER entity
+entityProperty
+    : INTEGER entity                        # numEntityProperty
+    | op = LESS INTEGER entity              # halfOpenRange
+    | op = GREATER INTEGER entity           # halfOpenRange
+    | op = LESS_OR_EQUAL INTEGER entity     # halfOpenRange
+    | op = GREATER_OR_EQUAL INTEGER entity  # halfOpenRange
+    | INTEGER RANGE_OPERATOR INTEGER entity # closedRange
     ;
 
 entity

src/graphreveal/translator/QueryTranslator.py

@@ -39,6 +39,23 @@ def visitNumEntityProperty(self, ctx: QueryParser.NumEntityPropertyContext):
         entity = self.visit(ctx.entity())
         return NUM_ENTITY_PROPERTY_MAP[entity] + " = " + num
 
+    def visitHalfOpenRange(self, ctx: QueryParser.HalfOpenRangeContext):
+        num = ctx.INTEGER().getText()
+        entity = self.visit(ctx.entity())
+        operator = {
+            QueryParser.LESS: "<",
+            QueryParser.GREATER: ">",
+            QueryParser.LESS_OR_EQUAL: "<=",
+            QueryParser.GREATER_OR_EQUAL: ">=",
+        }[ctx.op.type]
+        return NUM_ENTITY_PROPERTY_MAP[entity] + f" {operator} {num}"
+
+    def visitClosedRange(self, ctx: QueryParser.ClosedRangeContext):
+        num_1 = ctx.INTEGER(0).getText()
+        num_2 = ctx.INTEGER(1).getText()
+        entity = self.visit(ctx.entity())
+        return NUM_ENTITY_PROPERTY_MAP[entity] + " BETWEEN " + num_1 + " AND " + num_2
+
     def visitEntity(self, ctx: QueryParser.EntityContext):
         return ctx.getChild(0).symbol.type