Merge pull request #21 from dhendriks/18-release-2.0

#18 Prepare for release 2.0

Author: dhendriks

pom.xml

@@ -1,5 +1,4 @@
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 
     <modelVersion>4.0.0</modelVersion>
 

src/main/java/com/github/javabdd/BDD.java

@@ -163,6 +163,7 @@ public BDD and(BDD that) {
      * </p>
      *
      * @param that the BDD to 'and' with
+     * @return the logical 'and' of the two BDDs
      */
     public BDD andWith(BDD that) {
         return this.applyWith(that, BDDFactory.and);
@@ -191,6 +192,7 @@ public BDD or(BDD that) {
      * </p>
      *
      * @param that the BDD to 'or' with
+     * @return the logical 'or' of the two BDDs
      */
     public BDD orWith(BDD that) {
         return this.applyWith(that, BDDFactory.or);
@@ -219,6 +221,7 @@ public BDD xor(BDD that) {
      * </p>
      *
      * @param that the BDD to 'xor' with
+     * @return the logical 'xor' of the two BDDs
      */
     public BDD xorWith(BDD that) {
         return this.applyWith(that, BDDFactory.xor);
@@ -247,6 +250,7 @@ public BDD imp(BDD that) {
      * </p>
      *
      * @param that the BDD to 'implication' with
+     * @return the logical 'implication' of the two BDDs
      */
     public BDD impWith(BDD that) {
         return this.applyWith(that, BDDFactory.imp);
@@ -276,6 +280,7 @@ public BDD biimp(BDD that) {
      * </p>
      *
      * @param that the BDD to 'bi-implication' with
+     * @return the logical 'bi-implication' of two BDDs
      */
     public BDD biimpWith(BDD that) {
         return this.applyWith(that, BDDFactory.biimp);
@@ -426,6 +431,7 @@ public BDD relprod(BDD that, BDDVarSet var) {
      * </p>
      *
      * @param var BDD containing the variables to be restricted
+     * @return the result of the restrict operation
      * @see com.github.javabdd.BDDDomain#set()
      */
     public abstract BDD restrictWith(BDD var);
@@ -456,7 +462,7 @@ public BDD relprod(BDD that, BDDVarSet var) {
     public abstract BDDVarSet support();
 
     /**
-     * Returns the result of applying the binary operator <tt>opr</tt> to the two BDDs.
+     * Returns the result of applying the binary operator {@code opr} to the two BDDs.
      *
      * <p>
      * Compare to bdd_apply.
@@ -469,7 +475,7 @@ public BDD relprod(BDD that, BDDVarSet var) {
     public abstract BDD apply(BDD that, BDDFactory.BDDOp opr);
 
     /**
-     * Makes this BDD be the result of the binary operator <tt>opr</tt> of two BDDs. The "that" BDD is consumed, and can
+     * Makes this BDD be the result of the binary operator {@code opr} of two BDDs. The "that" BDD is consumed, and can
      * no longer be used. Attempting to use the passed in BDD again will result in an exception being thrown.
      *
      * <p>
@@ -478,12 +484,13 @@ public BDD relprod(BDD that, BDDVarSet var) {
      *
      * @param that the BDD to apply the operator on
      * @param opr the operator to apply
+     * @return the result of applying the operator
      */
     public abstract BDD applyWith(BDD that, BDDFactory.BDDOp opr);
 
     /**
-     * Applies the binary operator <tt>opr</tt> to two BDDs and then performs a universal quantification of the
-     * variables from the variable set <tt>var</tt>.
+     * Applies the binary operator {@code opr} to two BDDs and then performs a universal quantification of the variables
+     * from the variable set {@code var}.
      *
      * <p>
      * Compare to bdd_appall.
@@ -498,8 +505,8 @@ public BDD relprod(BDD that, BDDVarSet var) {
     public abstract BDD applyAll(BDD that, BDDFactory.BDDOp opr, BDDVarSet var);
 
     /**
-     * Applies the binary operator <tt>opr</tt> to two BDDs and then performs an existential quantification of the
-     * variables from the variable set <tt>var</tt>.
+     * Applies the binary operator {@code opr} to two BDDs and then performs an existential quantification of the
+     * variables from the variable set {@code var}.
      *
      * <p>
      * Compare to bdd_appex.
@@ -514,8 +521,8 @@ public BDD relprod(BDD that, BDDVarSet var) {
     public abstract BDD applyEx(BDD that, BDDFactory.BDDOp opr, BDDVarSet var);
 
     /**
-     * Applies the binary operator <tt>opr</tt> to two BDDs and then performs a unique quantification of the variables
-     * from the variable set <tt>var</tt>.
+     * Applies the binary operator {@code opr} to two BDDs and then performs a unique quantification of the variables
+     * from the variable set {@code var}.
      *
      * <p>
      * Compare to bdd_appuni.
@@ -554,9 +561,9 @@ public BDD relprod(BDD that, BDDVarSet var) {
     public abstract BDD fullSatOne();
 
     /**
-     * Finds one satisfying variable assignment. Finds a minterm in this BDD. The <tt>var</tt> argument is a set of
+     * Finds one satisfying variable assignment. Finds a minterm in this BDD. The {@code var} argument is a set of
      * variables that must be mentioned in the result. The polarity of these variables in the result - in case they are
-     * undefined in this BDD - are defined by the <tt>pol</tt> parameter. If <tt>pol</tt> is false, then all variables
+     * undefined in this BDD - are defined by the {@code pol} parameter. If {@code pol} is false, then all variables
      * will be in negative form. Otherwise they will be in positive form.
      *
      * <p>
@@ -723,7 +730,7 @@ public void remove() {
     }
 
     /**
-     * Finds one satisfying assignment of the domain <tt>d</tt> in this BDD and returns that value.
+     * Finds one satisfying assignment of the domain {@code d} in this BDD and returns that value.
      *
      * <p>
      * Compare to fdd_scanvar.
@@ -817,8 +824,8 @@ public BigInteger[] scanAllVar() {
      */
 
     /**
-     * Returns an iteration of the satisfying assignments of this BDD. Returns an iteration of minterms. The
-     * <tt>var</tt> argument is the set of variables that will be mentioned in the result.
+     * Returns an iteration of the satisfying assignments of this BDD. Returns an iteration of minterms. The {@code var}
+     * argument is the set of variables that will be mentioned in the result.
      *
      * @param var set of variables to mention in result
      * @return an iteration of minterms
@@ -1053,8 +1060,8 @@ public void remove() {
         }
 
         /**
-         * Returns true if the given BDD variable number is a dont-care. <tt>var</tt> must be a variable in the
-         * iteration set.
+         * Returns true if the given BDD variable number is a dont-care. {@code var} must be a variable in the iteration
+         * set.
          *
          * @param var variable number to check
          * @return if the given variable is a dont-care
@@ -1116,7 +1123,7 @@ public void fastForward(int[] vars) {
         }
 
         /**
-         * Assuming <tt>d</tt> is a dont-care, skip to the end of the iteration for <tt>d</tt>.
+         * Assuming {@code d} is a dont-care, skip to the end of the iteration for {@code d}.
          *
          * @param d BDD domain to fast-forward past
          */
@@ -1153,6 +1160,7 @@ public void skipDontCare(BDDDomain d) {
      * </p>
      *
      * @param pair pairing of variables to the BDDs that replace those variables
+     * @return result of replace
      */
     public abstract BDD replaceWith(BDDPairing pair);
 
@@ -1285,6 +1293,7 @@ protected int printdot_rec(PrintStream out, int current, boolean[] visited, Hash
      * Compare to bdd_satcountset.
      * </p>
      *
+     * @param varset the given varset
      * @return the number of satisfying variable assignments
      */
     public double satCount(BDDVarSet varset) {
@@ -1321,6 +1330,7 @@ public double logSatCount() {
      * Compare to bdd_satcountset.
      * </p>
      *
+     * @param varset the given varset
      * @return the logarithm of the number of satisfying variable assignments
      */
     public double logSatCount(BDDVarSet varset) {
@@ -1334,6 +1344,8 @@ public double logSatCount(BDDVarSet varset) {
      * <p>
      * Compare to bdd_varprofile.
      * </p>
+     *
+     * @return the variable profile
      */
     public abstract int[] varProfile();
 
@@ -1434,8 +1446,8 @@ public String toStringWithDomains() {
     /**
      * Returns a string representation of this BDD on the defined domains, using the given BDDToString converter.
      *
+     * @param ts the given BDDToString converter
      * @return string representation of this BDD using the given BDDToString converter
-     *
      * @see com.github.javabdd.BDD.BDDToString
      */
     public String toStringWithDomains(BDDToString ts) {

src/main/java/com/github/javabdd/BDDDomain.java

@@ -17,7 +17,7 @@
  * </p>
  *
  * <p>
- * Use <tt>BDDFactory.extDomain()</tt> to create one or more domains with a specified list of sizes.
+ * Use {@code BDDFactory.extDomain()} to create one or more domains with a specified list of sizes.
  * </p>
  *
  * @see com.github.javabdd.BDDFactory#extDomain(int[])
@@ -63,25 +63,33 @@ protected BDDDomain(int index, BigInteger range) {
 
     /**
      * Returns the factory that created this domain.
+     *
+     * @return the BDD factory
      */
     public abstract BDDFactory getFactory();
 
     /**
      * Sets the name of this domain.
+     *
+     * @param name the name
      */
     public void setName(String name) {
         this.name = name;
     }
 
     /**
      * Gets the name of this domain.
+     *
+     * @return the name
      */
     public String getName() {
         return name;
     }
 
     /**
      * Returns the index of this domain.
+     *
+     * @return the index
      */
     public int getIndex() {
         return index;
@@ -94,6 +102,8 @@ public int getIndex() {
      * <p>
      * Compare to fdd_domain.
      * </p>
+     *
+     * @return BDD representing the possible values of this domain
      */
     public BDD domain() {
         BDDFactory factory = getFactory();
@@ -119,6 +129,8 @@ public BDD domain() {
      * <p>
      * Compare to fdd_domainsize.
      * </p>
+     *
+     * @return the size
      */
     public BigInteger size() {
         return this.realsize;
@@ -189,6 +201,7 @@ public BDD buildAdd(BDDDomain that, int bits, long value) {
      * Compare to fdd_equals/fdd_equ.
      * </p>
      *
+     * @param that the other BDD domain
      * @return BDD
      */
     public BDD buildEquals(BDDDomain that) {
@@ -233,6 +246,7 @@ public BDDVarSet set() {
      * Compare to fdd_ithvar.
      * </p>
      *
+     * @param val the given value
      * @return BDD
      */
     public BDD ithVar(long val) {
@@ -262,6 +276,8 @@ public BDD ithVar(BigInteger val) {
     /**
      * Returns the BDD that defines the given range of values, inclusive, for this finite domain block.
      *
+     * @param lo low value (inclusive)
+     * @param hi high value (inclusive)
      * @return BDD
      */
     public BDD varRange(long lo, long hi) {
@@ -352,39 +368,40 @@ public String toString() {
     }
 
     /**
-     * Convert a BDD that to a list of indices of this domain. This method assumes that the BDD passed is a disjunction
-     * of ithVar(i_1) to ithVar(i_k). It returns an array of length 'k' with elements [i_1,...,i_k].
+     * Convert a BDD {@code that} to a list of indices of this domain. This method assumes that the BDD passed is a
+     * disjunction of ithVar(i_1) to ithVar(i_k). It returns an array of length 'k' with elements [i_1,...,i_k].
      *
      * <p>
      * Be careful when using this method for BDDs with a large number of entries, as it allocates a BigInteger[] array
      * of dimension k.
      * </p>
      *
-     * @param bdd bdd that is the disjunction of domain indices
+     * @param that bdd that is the disjunction of domain indices
+     * @return list of indices in this domain
      * @see #getVarIndices(BDD,int)
      * @see #ithVar(BigInteger)
      */
-    public BigInteger[] getVarIndices(BDD bdd) {
-        return getVarIndices(bdd, -1);
+    public BigInteger[] getVarIndices(BDD that) {
+        return getVarIndices(that, -1);
     }
 
     /**
-     * Convert a BDD that to a list of indices of this domain. Same as getVarIndices(BDD), except only 'max' indices are
-     * extracted.
+     * Convert a BDD {@code that} to a list of indices of this domain. Same as getVarIndices(BDD), except only 'max'
+     * indices are extracted.
      *
-     * @param bdd bdd that is the disjunction of domain indices
+     * @param that bdd that is the disjunction of domain indices
      * @param max maximum number of entries to be returned
-     *
+     * @return list of indices of this domain
      * @see #ithVar(long)
      */
-    public BigInteger[] getVarIndices(BDD bdd, int max) {
+    public BigInteger[] getVarIndices(BDD that, int max) {
         BDDVarSet myvarset = set(); // can't use var here, must respect subclass a factory may provide
-        int n = (int)bdd.satCount(myvarset);
+        int n = (int)that.satCount(myvarset);
         if (max != -1 && n > max) {
             n = max;
         }
         BigInteger[] res = new BigInteger[n];
-        BDDIterator it = bdd.iterator(myvarset);
+        BDDIterator it = that.iterator(myvarset);
         myvarset.free();
         for (int i = 0; i < n; i++) {
             res[i] = it.nextValue(this);