From 634ec20b38085e791668a335a3db682624e309bf Mon Sep 17 00:00:00 2001 From: Krasimir Angelov Date: Tue, 29 Aug 2017 14:42:52 +0200 Subject: corrected and tested documentation for Java --- doc/runtime-api.html | 57 ++++++++++++++++++++++++++-------------------------- 1 file changed, 29 insertions(+), 28 deletions(-) (limited to 'doc/runtime-api.html') diff --git a/doc/runtime-api.html b/doc/runtime-api.html index 374060403..e63899ded 100644 --- a/doc/runtime-api.html +++ b/doc/runtime-api.html @@ -81,7 +81,7 @@ A grammar is loaded by calling the method pgf.readPGF gr <- readPGF "App12.pgf" 
-PGF gr = PGF.readPGF("App12.pgf")
+PGF gr = PGF.readPGF("App12.pgf");
From the grammar you can query the set of available languages. @@ -100,7 +100,7 @@ Prelude PGF2> :t eng eng :: Concr 
-Concr eng = gr.getLanguages().get("AppEng")
+Concr eng = gr.getLanguages().get("AppEng");

Parsing

@@ -115,7 +115,7 @@ For example to invoke the parser, you can call: Prelude PGF2> let res = parse eng (startCat gr) "this is a small theatre" 
-Iterable<ExprProb> iterable = eng.parse(gr.startCat(), "this is a small theatre")
+Iterable<ExprProb> iterable = eng.parse(gr.getStartCat(), "this is a small theatre");
This gives you an iterator which can enumerate all possible @@ -141,8 +141,8 @@ Prelude PGF2> let Right ((e,p):rest) = res This gives you an iterable which can enumerate all possible abstract trees. You can get the next tree by calling next: 
-Iterator<ExprProb> iter = iterable.iterator()
-ExprProb ep = iter.next()
+Iterator<ExprProb> iter = iterable.iterator();
+ExprProb ep = iter.next();
@@ -161,7 +161,7 @@ Prelude PGF2> print p 35.9166526794 
-System.out.println(ep.getProb())
+System.out.println(ep.getProb());
 35.9166526794
and this is the corresponding abstract tree: @@ -174,7 +174,7 @@ Prelude PGF2> print e PhrUtt NoPConj (UttS (UseCl (TTAnt TPres ASimul) PPos (PredVP (DetNP (DetQuant this_Quant NumSg)) (UseComp (CompNP (DetCN (DetQuant IndefArt NumSg) (AdjCN (PositA small_A) (UseN theatre_N)))))))) NoVoc 
-System.out.println(ep.getExpr())
+System.out.println(ep.getExpr());
 PhrUtt NoPConj (UttS (UseCl (TTAnt TPres ASimul) PPos (PredVP (DetNP (DetQuant this_Quant NumSg)) (UseComp (CompNP (DetCN (DetQuant IndefArt NumSg) (AdjCN (PositA small_A) (UseN theatre_N)))))))) NoVoc
@@ -216,7 +216,7 @@ There is also the method parseWithHeuristics which takes two more paramaters which let you to have a better control over the parser's behaviour: 
-Iterable<ExprProb> iterable = eng.parseWithHeuristics(gr.startCat(), heuristic_factor, callbacks)
+Iterable<ExprProb> iterable = eng.parseWithHeuristics(gr.startCat(), heuristic_factor, callbacks);
@@ -250,7 +250,7 @@ a new expression like this: Prelude PGF2> let Just e = readExpr "AdjCN (PositA red_A) (UseN theatre_N)" 
-Expr e = Expr.readExpr("AdjCN (PositA red_A) (UseN theatre_N)")
+Expr e = Expr.readExpr("AdjCN (PositA red_A) (UseN theatre_N)");
and then we can linearize it: 
@@ -262,7 +262,7 @@ Prelude PGF2> putStrLn (linearize eng e)
 red theatre
 
-System.out.println(eng.linearize(e))
+System.out.println(eng.linearize(e));
 red theatre
This method produces only a single linearization. If you use variants @@ -281,7 +281,7 @@ red theater 
 for (String s : eng.linearizeAll(e)) {
-    System.out.println(s)
+    System.out.println(s);
 }
 red theatre
 red theater
@@ -297,7 +297,7 @@ Prelude PGF2> tabularLinearize eng e
 fromList [("s Pl Gen","red theatres'"),("s Pl Nom","red theatres"),("s Sg Gen","red theatre's"),("s Sg Nom","red theatre")]
 
-for (Map.Entry<String,String> entry : eng.tabularLinearize(e)) {
+for (Map.Entry<String,String> entry : eng.tabularLinearize(e).entrySet()) {
     System.out.println(entry.getKey() + ": " + entry.getValue());
 }
 s Sg Nom: red theatre
@@ -320,7 +320,7 @@ Prelude PGF2> putStrLn (showBracketedString b)
 (CN:4 (AP:1 (A:0 red)) (CN:3 (N:2 theatre)))
 
-Object[] bs = eng.bracketedLinearize(e)
+Object[] bs = eng.bracketedLinearize(e);
Each element in the sequence above is either a string or an object @@ -378,7 +378,7 @@ Prelude PGF2> print (hasLinearization eng "apple_N") True 
-System.out.println(eng.hasLinearization("apple_N"))
+System.out.println(eng.hasLinearization("apple_N"));
 true
@@ -435,8 +435,8 @@ from unStr will not be null with the actual literal. For example the output from: 
-Expr e = Expr.readExpr("\"literal\"")
-System.out.println(e.unStr())
+Expr elit = Expr.readExpr("\"literal\"");
+System.out.println(elit.unStr());
is just the string "literal". Situations like this can be detected @@ -446,6 +446,9 @@ for the other possible literal types in GF. There are also the functions unAbs, unInt, unFloat and unMeta for all other possible cases. + +There are also the methods unAbs, unInt, unFloat and unMeta for all other possible cases. +

@@ -554,7 +557,7 @@ word form with its possible analyses: Prelude PGF2> mapM_ print [(form,lemma,analysis,prob) | (form,analyses) <- fullFormLexicon eng, (lemma,analysis,prob) <- analyses] 
-for (FullFormEntry entry in eng.fullFormLexicon()) {
+for (FullFormEntry entry in eng.fullFormLexicon()) { ///// TODO
 	for (MorphoAnalysis analysis : entry.getAnalyses()) {
 		System.out.println(entry.getForm()+" "+analysis.getProb()+" "+analysis.getLemma()+" "+analysis.getField());
 	}
@@ -603,7 +606,7 @@ Prelude PGF2> categories gr
 ....
 
-List<String> cats = gr.getCategories()
+List<String> cats = gr.getCategories();
 ....
You can also access all functions with the same result category: @@ -616,7 +619,7 @@ Prelude PGF2> functionsByCat gr "Weekday" ['friday_Weekday', 'monday_Weekday', 'saturday_Weekday', 'sunday_Weekday', 'thursday_Weekday', 'tuesday_Weekday', 'wednesday_Weekday'] 
-List<String> cats = gr.getFunctionsByCat("Weekday")
+List<String> funsByCat = gr.getFunctionsByCat("Weekday");
 ....
The full type of a function can be retrieved as: @@ -629,7 +632,7 @@ Prelude PGF2> print (functionType gr "DetCN") Det -> CN -> NP 
-System.out.println(gr.getFunctionType("DetCN"))
+System.out.println(gr.getFunctionType("DetCN"));
 Det -> CN -> NP
@@ -653,11 +656,9 @@ Prelude PGF2> print ty CN 
-TypedExpr te = gr.inferExpr(e)
-System.out.println(te.getExpr())
-AdjCN (PositA red_A) (UseN theatre_N)
-System.out.println(te.getType())
-CN
+TypedExpr te = gr.inferExpr(e);
+System.out.println(te.getExpr()+" : "+te.getType());
+AdjCN (PositA red_A) (UseN theatre_N) : CN
The result is a potentially updated expression and its type. In this case we always deal with simple types, which means that the new @@ -678,7 +679,7 @@ Prelude PGF2> print e' AdjCN (PositA red_A) (UseN theatre_N) 
-Expr e = gr.checkExpr(e,Type.readType("CN"))
+Expr new_e = gr.checkExpr(e,Type.readType("CN")); //// TODO
 System.out.println(e)

In case of type error you will get an error: @@ -826,7 +827,7 @@ n0 -- n3 [style = "solid"] } 

-System.out.println(gr.graphvizAbstractTree(e))
+System.out.println(gr.graphvizAbstractTree(e));   //// TODO
 graph {
 n0[label = "AdjCN", style = "solid", shape = "plaintext"]
 n1[label = "PositA", style = "solid", shape = "plaintext"]
@@ -915,7 +916,7 @@ graph {
 }
 
-System.out.println(eng.graphvizParseTree(e))
+System.out.println(eng.graphvizParseTree(e));   //// TODO
 graph {
   node[shape=plaintext]
 
-- 
cgit v1.2.3