Skip to content

Commit 8ad3530

Browse files
TraumlosTraumlos
committed
added missing javadoc for some methods
1 parent e3ead96 commit 8ad3530

13 files changed

Lines changed: 219 additions & 164 deletions

File tree

‎src/main/java/gprover/CClass.java‎

Lines changed: 26 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,34 @@
1+
package gprover;
12
/**
2-
* The CClass class represents a base class for geometric objects.
3-
* It includes properties for unique identification, depth, type, and text description.
4-
*/
5-
package gprover;
6-
7-
public class CClass {
8-
/** The maximum number of geometric objects. */
9-
final public static int MAX_GEO = 40;
3+
* The CClass class represents a base class for geometric objects.
4+
* It includes properties for unique identification, depth, type, and text description.
5+
*/
6+
public class CClass {
7+
/** The maximum number of geometric objects. */
8+
final public static int MAX_GEO = 40;
109

11-
/** A static counter for generating unique IDs. */
12-
public static long id_count = 0;
10+
/** A static counter for generating unique IDs. */
11+
public static long id_count = 0;
1312

14-
/** The unique ID of the geometric object. */
15-
long id = id_count++;
13+
/** The unique ID of the geometric object. */
14+
long id = id_count++;
1615

17-
/** The depth of the geometric object. */
18-
long dep = Gib.depth;
16+
/** The depth of the geometric object. */
17+
long dep = Gib.depth;
1918

20-
/** The type of the geometric object. */
21-
int type;
19+
/** The type of the geometric object. */
20+
int type;
2221

23-
/** The text description of the geometric object. */
24-
String text;
22+
/** The text description of the geometric object. */
23+
String text;
2524

26-
/**
27-
* Returns a string representation of the geometric object.
28-
*
29-
* @return the text description of the geometric object
30-
*/
31-
@Override
32-
public String toString() {
33-
return text;
34-
}
25+
/**
26+
* Returns a string representation of the geometric object.
27+
*
28+
* @return the text description of the geometric object
29+
*/
30+
@Override
31+
public String toString() {
32+
return text;
3533
}
34+
}

‎src/main/java/gprover/Cm.java‎

Lines changed: 114 additions & 113 deletions
Original file line numberDiff line numberDiff line change
@@ -1,114 +1,115 @@
1+
package gprover;
12
/**
2-
* The Cm class contains various constants and utility methods used in geometric proofs.
3-
* It includes string constants for geometric symbols, predicates, and messages,
4-
* as well as a debug flag and a print method for debugging purposes.
5-
*/
6-
package gprover;
7-
8-
final public class Cm {
9-
10-
/** Hypothesis string constant. */
11-
final public static String s2070 = "(hyp)";
12-
13-
/** The machine proof string constant. */
14-
final public static String s2072 = "The Machine Proof";
15-
16-
/** Perpendicular sign constant. */
17-
final public static String PERPENDICULAR_SIGN = " ⊥ ";
18-
/** Parallel sign constant. */
19-
final public static String PARALLEL_SIGN = " ∥ ";
20-
/** Triangle sign constant. */
21-
final public static String TRIANGLE_SIGN = "∆";
22-
23-
/** Angle sign constant. */
24-
final public static String ANGLE_SIGN = "∠";
25-
/** Equal sign constant. */
26-
final public static String EQUAL_SIGN = " = ";
27-
/** Similar sign constant. */
28-
final public static String SIMILAR_SIGN = " ~ ";
29-
/** Intersect sign constant. */
30-
final public static String INTERSECT_SIGN = " ∩ ";
31-
32-
/** Lines string constant. */
33-
final public static String s2707 = "lines";
34-
35-
/** Circles in the database string constant. */
36-
final public static String s2713 = "circles in the database.";
37-
38-
/** Similar triangles string constant. */
39-
final public static String s2720 = "similar triangles";
40-
41-
/** Congruent triangles string constant. */
42-
final public static String s2722 = "congruent triangles";
43-
44-
/** Because string constant. */
45-
final public static String s2727 = " because ";
46-
/** And string constant. */
47-
final public static String s2728 = " and ";
48-
49-
/** Collinear predicate constant. */
50-
final public static String PC_COLL = "COLLINEAR";
51-
/** Parallel predicate constant. */
52-
final public static String PC_PARA = "PARALLEL";
53-
/** Perpendicular predicate constant. */
54-
final public static String PC_PERP = "PERPENDICULAR";
55-
/** Equal distance predicate constant. */
56-
final public static String PC_CONG = "EQDISTANCE";
57-
/** Equal angle predicate constant. */
58-
final public static String PC_ACONG = "EQANGLE";
59-
/** Cocircle predicate constant. */
60-
final public static String PC_CYCLIC = "COCIRCLE";
61-
62-
/** Similar triangle predicate constant. */
63-
final public static String PC_STRI = "SIM_TRIANGLE";
64-
/** Congruent triangle predicate constant. */
65-
final public static String PC_CTRI = "CON_TRIANGLE";
66-
/** Midpoint predicate constant. */
67-
final public static String PC_MIDP = "MIDPOINT";
68-
69-
/** Point predicate constant. */
70-
final public static String P_POINT = "POINT";
71-
72-
/** WPT string constant. */
73-
final public static String DR_WPT = "WPT";
74-
75-
/** Only full-angles allowed message constant. */
76-
final public static String s2810 = "\r\n\r\nOnly full-angles are allowd in this case";
77-
/** Conclusion cannot be represented with full-angles message constant. */
78-
final public static String s2811 = "\r\nConclusion cannot be represented with full-angles.\r\n";
79-
/** Cannot solve problem with full-angles message constant. */
80-
final public static String s2812 = "\r\nCannot solve this problem with full-angles.\r\n";
81-
82-
/** Index string constant. */
83-
final public static String s1993 = "Index";
84-
85-
/** The statement is true message constant. */
86-
final public static String s2300 = "\r\n\r\nThe statement is true.\r\n\r\n";
87-
88-
/** No proof exists message constant. */
89-
final public static String s2220 = "\r\nThere exists no proof.\r\n";
90-
/** Conclusion message constant. */
91-
final public static String s2221 = "The conclusion is: ";
92-
/** Equivalent message constant. */
93-
final public static String s2222 = "This is equivalent to: ";
94-
/** Eliminating common factors message constant. */
95-
final public static String s2223 = "Eliminating the common factors: ";
96-
97-
/** Geometric quantities used in proof message constant. */
98-
final public static String s2225 = "\r\nThe geometric quantities used in the proof.\r\n";
99-
/** Eliminate variables message constant. */
100-
final public static String s2226 = "Eliminate variables";
101-
102-
/** Debug flag. */
103-
final public static boolean DEBUG = false;
104-
105-
/**
106-
* Prints the specified string if the debug flag is set.
107-
*
108-
* @param s the string to print
109-
*/
110-
public static void print(String s) {
111-
if (DEBUG)
112-
System.out.println(s);
113-
}
114-
}
3+
* The Cm class contains various constants and utility methods used in geometric proofs.
4+
* It includes string constants for geometric symbols, predicates, and messages,
5+
* as well as a debug flag and a print method for debugging purposes.
6+
*/
7+
8+
9+
final public class Cm {
10+
11+
/** Hypothesis string constant. */
12+
final public static String s2070 = "(hyp)";
13+
14+
/** The machine proof string constant. */
15+
final public static String s2072 = "The Machine Proof";
16+
17+
/** Perpendicular sign constant. */
18+
final public static String PERPENDICULAR_SIGN = " ⊥ ";
19+
/** Parallel sign constant. */
20+
final public static String PARALLEL_SIGN = " ∥ ";
21+
/** Triangle sign constant. */
22+
final public static String TRIANGLE_SIGN = "∆";
23+
24+
/** Angle sign constant. */
25+
final public static String ANGLE_SIGN = "∠";
26+
/** Equal sign constant. */
27+
final public static String EQUAL_SIGN = " = ";
28+
/** Similar sign constant. */
29+
final public static String SIMILAR_SIGN = " ~ ";
30+
/** Intersect sign constant. */
31+
final public static String INTERSECT_SIGN = " ∩ ";
32+
33+
/** Lines string constant. */
34+
final public static String s2707 = "lines";
35+
36+
/** Circles in the database string constant. */
37+
final public static String s2713 = "circles in the database.";
38+
39+
/** Similar triangles string constant. */
40+
final public static String s2720 = "similar triangles";
41+
42+
/** Congruent triangles string constant. */
43+
final public static String s2722 = "congruent triangles";
44+
45+
/** Because string constant. */
46+
final public static String s2727 = " because ";
47+
/** And string constant. */
48+
final public static String s2728 = " and ";
49+
50+
/** Collinear predicate constant. */
51+
final public static String PC_COLL = "COLLINEAR";
52+
/** Parallel predicate constant. */
53+
final public static String PC_PARA = "PARALLEL";
54+
/** Perpendicular predicate constant. */
55+
final public static String PC_PERP = "PERPENDICULAR";
56+
/** Equal distance predicate constant. */
57+
final public static String PC_CONG = "EQDISTANCE";
58+
/** Equal angle predicate constant. */
59+
final public static String PC_ACONG = "EQANGLE";
60+
/** Cocircle predicate constant. */
61+
final public static String PC_CYCLIC = "COCIRCLE";
62+
63+
/** Similar triangle predicate constant. */
64+
final public static String PC_STRI = "SIM_TRIANGLE";
65+
/** Congruent triangle predicate constant. */
66+
final public static String PC_CTRI = "CON_TRIANGLE";
67+
/** Midpoint predicate constant. */
68+
final public static String PC_MIDP = "MIDPOINT";
69+
70+
/** Point predicate constant. */
71+
final public static String P_POINT = "POINT";
72+
73+
/** WPT string constant. */
74+
final public static String DR_WPT = "WPT";
75+
76+
/** Only full-angles allowed message constant. */
77+
final public static String s2810 = "\r\n\r\nOnly full-angles are allowd in this case";
78+
/** Conclusion cannot be represented with full-angles message constant. */
79+
final public static String s2811 = "\r\nConclusion cannot be represented with full-angles.\r\n";
80+
/** Cannot solve problem with full-angles message constant. */
81+
final public static String s2812 = "\r\nCannot solve this problem with full-angles.\r\n";
82+
83+
/** Index string constant. */
84+
final public static String s1993 = "Index";
85+
86+
/** The statement is true message constant. */
87+
final public static String s2300 = "\r\n\r\nThe statement is true.\r\n\r\n";
88+
89+
/** No proof exists message constant. */
90+
final public static String s2220 = "\r\nThere exists no proof.\r\n";
91+
/** Conclusion message constant. */
92+
final public static String s2221 = "The conclusion is: ";
93+
/** Equivalent message constant. */
94+
final public static String s2222 = "This is equivalent to: ";
95+
/** Eliminating common factors message constant. */
96+
final public static String s2223 = "Eliminating the common factors: ";
97+
98+
/** Geometric quantities used in proof message constant. */
99+
final public static String s2225 = "\r\nThe geometric quantities used in the proof.\r\n";
100+
/** Eliminate variables message constant. */
101+
final public static String s2226 = "Eliminate variables";
102+
103+
/** Debug flag. */
104+
final public static boolean DEBUG = false;
105+
106+
/**
107+
* Prints the specified string if the debug flag is set.
108+
*
109+
* @param s the string to print
110+
*/
111+
public static void print(String s) {
112+
if (DEBUG)
113+
System.out.println(s);
114+
}
115+
}

‎src/main/java/gprover/CongSeg.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1+
package gprover;
2+
13
/**
24
* The CongSeg class represents a congruent segment in a geometric proof.
35
* It includes properties for lemma, condition, points, types, and the next segment.
46
*/
5-
package gprover;
6-
77
public class CongSeg extends CClass {
88

99
/** The lemma associated with the congruent segment. */

‎src/main/java/gprover/Incenter.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1+
package gprover;
2+
13
/**
2-
* Represents an incenter in a geometric proof.
4+
* Represents an incenter(the center of the incircle) in a geometric proof.
35
* This class extends the CClass and includes properties for lemma, coordinates, and a reference to the next incenter.
46
*/
5-
package gprover;
6-
77
public class Incenter extends CClass {
88
/** The lemma associated with the incenter. */
99
int lemma;

‎src/main/java/gprover/LLine.java‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
1+
2+
package gprover;
13
/**
24
* Represents a geometric line in the construction.
5+
* <p>
6+
* The class extends CClass and is used to model a line in a geometric context.
7+
* It includes properties such as a lemma identifier, a condition object,
8+
* an integer number to uniquely identify the line, an array of point indices,
9+
* and a reference to another LLine (for linked constructs).
10+
* </p>
311
*/
4-
package gprover;
5-
612
public class LLine extends CClass {
713

814
int lemma;

‎src/main/java/gprover/Main.java‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,12 @@
33
import java.io.*;
44
import java.util.Vector;
55

6+
/**
7+
* The main class for the GProver application.
8+
* This class contains the main method and handles the reading of geometric terms,
9+
* processing them, and outputting the results.
10+
*/
11+
@Deprecated
612
public class Main {
713

814
/**
@@ -81,9 +87,6 @@ public static void main1(String[] args) {
8187
DataOutputStream out = new DataOutputStream(fp);
8288
gt.Save(out);
8389

84-
//db.setPrintToString();
85-
//db.show_fproof();
86-
//out.writeBytes(db.getFileProve().append("\n********************************\n").toString());
8790
out.close();
8891
} else {
8992
f++;

0 commit comments

Comments
 (0)