Skip to content

Commit a3592b0

Browse files
committed
small changes in JavaDoc
1 parent 8519094 commit a3592b0

6 files changed

Lines changed: 50 additions & 11 deletions

File tree

org-tweetyproject-logics-translators/src/main/java/org/tweetyproject/logics/translators/adfcl/DalalDistanceThreeValued.java

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,15 @@
1515
*/
1616
public class DalalDistanceThreeValued {
1717

18-
/*
18+
/**
19+
*
1920
* Based on new version of PriestWorld_adapted
21+
*
22+
* @param a PriestWorldAdapted
23+
* @param b PriestWorldAdapted
24+
* @return distnace between the 2 worlds
2025
*/
26+
2127
public double distance(PriestWorldAdapted a, PriestWorldAdapted b) {
2228
double n = 0;
2329
PlSignature sig = new PlSignature();
@@ -45,6 +51,12 @@ else if (val_b == PriestWorldAdapted.TruthValue.TRUE && val_a == PriestWorldAdap
4551
}
4652
return n;
4753
}
54+
/**
55+
*
56+
* @param coll multiple PriestWorlds
57+
* @param b a PriestWorldAdapted
58+
* @return the distance
59+
*/
4860
public double distance(Collection<PriestWorldAdapted> coll, PriestWorldAdapted b) {
4961
double n = b.getSignature().size();
5062

org-tweetyproject-logics-translators/src/main/java/org/tweetyproject/logics/translators/adfcl/Indecision.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,11 @@ public PlFormula collapseAssociativeFormulas(){
5656
/* (non-Javadoc)
5757
* @see org.tweetyproject.logics.propositionallogic.syntax.PropositionalFormula#hasLowerBindingPriority(org.tweetyproject.logics.propositionallogic.syntax.PropositionalFormula)
5858
*/
59+
/**
60+
*
61+
* @param other a formula
62+
* @return returns false
63+
*/
5964
public boolean hasLowerBindingPriority(PlFormula other){
6065
// negations have the highest binding priority
6166
return false;

org-tweetyproject-logics-translators/src/main/java/org/tweetyproject/logics/translators/adfcl/PreferredRevisionerADF.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,9 @@ public class PreferredRevisionerADF {
3030

3131
/**
3232
* Revise an ADF with a Propositional Formula information-modular preorders
33-
* @param args
34-
* @throws FileNotFoundException
35-
* @throws IOException
33+
* @param args arguments
34+
* @throws FileNotFoundException FileNotFoundException
35+
* @throws IOException IOException
3636
*/
3737
public static void main(String[] args) throws FileNotFoundException, IOException {
3838
// Set path to ADF and psi

org-tweetyproject-logics-translators/src/main/java/org/tweetyproject/logics/translators/adfcl/PriestWorldAdapted.java

Lines changed: 27 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,43 +33,64 @@ public class PriestWorldAdapted extends AbstractInterpretation<PlBeliefSet,PlFor
3333

3434
/** The three truth values. */
3535
public enum TruthValue {
36-
TRUE, FALSE, BOTH;
36+
/**TRUE*/
37+
TRUE,
38+
/**FALSE*/
39+
FALSE,
40+
/**BOTH*/
41+
BOTH;
3742

3843
/*
3944
* J: Strong negation
4045
*/
46+
/**
47+
*
48+
* @return a Truthvalue
49+
*/
4150
public TruthValue neg(){
4251
if(this.equals(TRUE)) return FALSE;
4352
if(this.equals(FALSE)) return TRUE;
4453
return BOTH;
4554
}
46-
/*
55+
/**
4756
* J: Weak negation
48-
* return false, if interpretation is true
49-
* return true in all other case
57+
* @return false, if interpretation is true, true in all other case
5058
*/
5159
public TruthValue weakNeg(){
5260
if(this.equals(TRUE)) return FALSE;
5361
return TRUE;
5462
}
5563

56-
/*
64+
65+
/**
5766
* J: Return "True" iff TruthValue is True
58-
* (!) Compared to the original PriestWorld, return False if value is Both/Undecided (!)
67+
* (!) Compared to the original PriestWorld, return False if value is Both/Undecided (!)
68+
* @return whether this is equal to TRUE
5969
*/
6070
public boolean getClassical(){
6171
return this.equals(TRUE);
6272
}
73+
/**
74+
*
75+
* @param v a truth value
76+
* @return TruthValue
77+
*/
6378
public TruthValue and(TruthValue v){
6479
if(this.equals(FALSE) || v.equals(FALSE)) return FALSE;
6580
if(this.equals(BOTH) || v.equals(BOTH)) return BOTH;
6681
return TRUE;
6782
}
83+
/**
84+
*
85+
* @param v a truth value
86+
* @return TruthValue
87+
*/
6888
public TruthValue or(TruthValue v){
6989
if(this.equals(TRUE) || v.equals(TRUE)) return TRUE;
7090
if(this.equals(BOTH) || v.equals(BOTH)) return BOTH;
7191
return FALSE;
7292
}
93+
7394
public String toString(){
7495
if(this.equals(TRUE)) return "T";
7596
if(this.equals(FALSE)) return "F";

org-tweetyproject-logics-translators/src/main/java/org/tweetyproject/logics/translators/adfcl/PriestWorldIterator.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ public class PriestWorldIterator implements InterpretationIterator<PlFormula,PlB
3030

3131
/** The signature used for creating possible worlds. */
3232
private PlSignature sig = null;
33-
33+
3434
private List<Proposition> set;
3535

3636
private ThreeValuedBitSet currentItem;

org-tweetyproject-logics-translators/src/main/java/org/tweetyproject/logics/translators/adfcl/RankingFunctionThreeValued.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ public class RankingFunctionThreeValued extends AbstractInterpretation<ClBeliefS
2121
/**
2222
* Integer used to define infinity.
2323
*/
24+
2425
public static final Integer INFINITY = Integer.MAX_VALUE;
2526

2627
/**

0 commit comments

Comments
 (0)