Skip to content

Commit dcdc820

Browse files
authored
Update README.md
1 parent f69eafe commit dcdc820

1 file changed

Lines changed: 40 additions & 25 deletions

File tree

README.md

Lines changed: 40 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,38 @@
1-
# kotgll
2-
[![Build](https://github.com/vadyushkins/kotgll/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/vadyushkins/kotgll/actions/workflows/build.yml)
3-
[![Test](https://github.com/vadyushkins/kotgll/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/vadyushkins/kotgll/actions/workflows/test.yml)
4-
5-
* [About](https://github.com/vadyushkins/kotgll#about)
6-
* [Usage](https://github.com/vadyushkins/kotgll#usage)
7-
* [From sources](https://github.com/vadyushkins/kotgll#from-sources)
8-
* [Using JAR](https://github.com/vadyushkins/kotgll#using-jar)
9-
* [CFG Format Example](https://github.com/vadyushkins/kotgll#cfg-format-example)
10-
* [RSM Format Example](https://github.com/vadyushkins/kotgll#rsm-format-example)
11-
* [Performance](https://github.com/vadyushkins/kotgll#performance)
12-
* [Graphs](https://github.com/vadyushkins/kotgll#graphs)
13-
* [Grammars](https://github.com/vadyushkins/kotgll#grammars)
14-
* [Results](https://github.com/vadyushkins/kotgll#results)
15-
* [More results](https://github.com/vadyushkins/kotgll#more-results)
1+
# UCFS
2+
[![Build](https://github.com/FormalLanguageConstrainedPathQuerying/kotgll/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/FormalLanguageConstrainedPathQuerying/kotgll/actions/workflows/build.yml)
3+
[![Test](https://github.com/FormalLanguageConstrainedPathQuerying/kotgll/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/FormalLanguageConstrainedPathQuerying/kotgll/actions/workflows/test.yml)
4+
5+
* [About](https://github.com/FormalLanguageConstrainedPathQuerying/kotgll#about)
6+
* [Usage](https://github.com/FormalLanguageConstrainedPathQuerying/kotgll#usage)
7+
* [From sources](https://github.com/FormalLanguageConstrainedPathQuerying/kotgll#from-sources)
8+
* [Using JAR](https://github.com/FormalLanguageConstrainedPathQuerying/kotgll#using-jar)
9+
* [CFG Format Example](https://github.com/FormalLanguageConstrainedPathQuerying/kotgll#cfg-format-example)
10+
* [RSM Format Example](https://github.com/FormalLanguageConstrainedPathQuerying/kotgll#rsm-format-example)
11+
* [Performance](https://github.com/FormalLanguageConstrainedPathQuerying/kotgll#performance)
12+
* [Graphs](https://github.com/FormalLanguageConstrainedPathQuerying/kotgll#graphs)
13+
* [Grammars](https://github.com/FormalLanguageConstrainedPathQuerying/kotgll#grammars)
14+
* [Results](https://github.com/FormalLanguageConstrainedPathQuerying/kotgll#results)
15+
* [More results](https://github.com/FormalLanguageConstrainedPathQuerying/kotgll#more-results)
1616

1717
> Note: project under heavy development!
1818
1919
## About
20-
**kotgll** is an open-source project for implementing the GLL algorithm and its modifications in Kotlin
20+
**UCFS** is an **U**nuversal **C**ontext-**F**ree **S**olver: a tool to solve problems related to context-free and regular language intersection. Examples of such problems:
21+
- Parsing
22+
- Context-free path querying (CFPQ)
23+
- Context-free language reachability (CFL-r)
24+
25+
<!-- Online -- offline modes.
26+
27+
All-pairs, multiple-source. All-paths, reachability.
28+
29+
Incrementality. Both the graph and RSM
30+
31+
Error recovery.
32+
33+
GLL-based
34+
RSM
35+
-->
2136

2237
## Usage
2338

@@ -39,15 +54,15 @@ Options:
3954

4055
#### Step 1. Clone repository
4156

42-
`git clone https://github.com/vadyushkins/kotgll.git`
57+
`git clone https://github.com/FormalLanguageConstrainedPathQuerying/kotgll.git`
4358

4459
or
4560

46-
`git clone git@github.com:vadyushkins/kotgll.git`
61+
`git clone git@github.com:FormalLanguageConstrainedPathQuerying/kotgll.git`
4762

4863
or
4964

50-
`gh repo clone vadyushkins/kotgll`
65+
`gh repo clone FormalLanguageConstrainedPathQuerying/kotgll`
5166

5267
#### Step 2. Go to the folder
5368

@@ -57,7 +72,7 @@ or
5772

5873
`gradle run --args="--help"`
5974

60-
You will see the ["Options list"](https://github.com/vadyushkins/kotgll#command-line-interface) message.
75+
You will see the ["Options list"](https://github.com/FormalLanguageConstrainedPathQuerying/kotgll#command-line-interface) message.
6176

6277
#### Example
6378

@@ -70,7 +85,7 @@ gradle run --args="--input graph --grammar rsm --sppf off --inputPath src/test/r
7085
#### Step 1. Download the latest JAR
7186

7287
```text
73-
curl -L -O https://github.com/vadyushkins/kotgll/releases/download/v1.0.0/kotgll-1.0.0.jar
88+
curl -L -O https://github.com/FormalLanguageConstrainedPathQuerying/kotgll/releases/download/v1.0.0/kotgll-1.0.0.jar
7489
```
7590

7691
#### Step 2. Run JAR with Java
@@ -152,17 +167,17 @@ S -> subClassOf_r S subClassOf | subClassOf_r subClassOf
152167
| type_r S type | type_r type
153168
```
154169

155-
The representation of **G<sub>1</sub>** context-free grammar in the repository can be found [here](https://github.com/vadyushkins/kotgll/blob/main/src/test/resources/cli/TestCFGReadWriteTXT/g1.txt).
170+
The representation of **G<sub>1</sub>** context-free grammar in the repository can be found [here](https://github.com/FormalLanguageConstrainedPathQuerying/kotgll/blob/main/src/test/resources/cli/TestCFGReadWriteTXT/g1.txt).
156171

157-
The representation of **G<sub>1</sub>** context-free grammar as recursive automaton in the repository can be found [here](https://github.com/vadyushkins/kotgll/blob/main/src/test/resources/cli/TestRSMReadWriteTXT/g1.txt).
172+
The representation of **G<sub>1</sub>** context-free grammar as recursive automaton in the repository can be found [here](https://github.com/FormalLanguageConstrainedPathQuerying/kotgll/blob/main/src/test/resources/cli/TestRSMReadWriteTXT/g1.txt).
158173

159174
### Results
160175

161176
The results of the **all pairs reachability** queries evaluation on graphs related to **RDF analysis** are listed below.
162177

163178
In each row, the best mean time in seconds is highlighted in **bold**.
164179

165-
| Graph | [CFG](https://github.com/vadyushkins/kotgll/tree/main/src/main/kotlin/org/kotgll/cfg/graphinput/withoutsppf) | [RSM](https://github.com/vadyushkins/kotgll/tree/main/src/main/kotlin/org/kotgll/rsm/graphinput/withoutsppf) | [GLL4Graph](https://github.com/FormalLanguageConstrainedPathQuerying/GLL4Graph) |
180+
| Graph | [CFG](https://github.com/FormalLanguageConstrainedPathQuerying/kotgll/tree/main/src/main/kotlin/org/kotgll/cfg/graphinput/withoutsppf) | [RSM](https://github.com/FormalLanguageConstrainedPathQuerying/kotgll/tree/main/src/main/kotlin/org/kotgll/rsm/graphinput/withoutsppf) | [GLL4Graph](https://github.com/FormalLanguageConstrainedPathQuerying/GLL4Graph) |
166181
|-------------- |:-----: |:---------: |:---------: |
167182
| [Enzyme](https://formallanguageconstrainedpathquerying.github.io/CFPQ_Data/graphs/data/enzyme.html#enzyme) | 0.107 | **0.044** | 0.22 |
168183
| [Eclass](https://formallanguageconstrainedpathquerying.github.io/CFPQ_Data/graphs/data/eclass.html#eclass) | 0.94 | **0.43** | 1.5 |
@@ -173,4 +188,4 @@ In each row, the best mean time in seconds is highlighted in **bold**.
173188

174189
#### More results
175190

176-
More results, but in raw form, can be found in repository [kotgll_benchmarks](https://github.com/vadyushkins/kotgll_benchmarks/)
191+
More results, but in raw form, can be found in repository [kotgll_benchmarks](https://github.com/FormalLanguageConstrainedPathQuerying/kotgll_benchmarks/)

0 commit comments

Comments
 (0)