jp.kobe_u.sugar.csp.BooleanVariable Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jsr331-sugar Show documentation
This is a JSR331 interface for the open source Java constraint programming library "Sugar" v. 2.1.3
The newest version!
package jp.kobe_u.sugar.csp;

import java.util.BitSet;

import jp.kobe_u.sugar.Logger;
import jp.kobe_u.sugar.SugarException;

/**
 * This class implements a boolean variable of CSP.
 * @see CSP
 * @author Naoyuki Tamura ([email protected])
 */
public class BooleanVariable implements Comparable {
    private static String AUX_NAME_PREFIX = "$B";
    private static int auxBooleanVariablesCount = 0;
    private String name;
    private boolean aux;
    private String comment = null;
    private int code;
    private boolean dominant;
    private boolean value;
    
    /**
     * Adds a new boolean variable with give name.
     * @param name the name of the boolean variable
     * @throws SugarException when the name is duplicated
     */
    public BooleanVariable(String name) throws SugarException {
        this.name = name;
        aux = false;
        if (name.startsWith(AUX_NAME_PREFIX)) {
            // Logger.println("c WARNING Auxiliary variable name found : " + name);
            int i = Integer.parseInt(name.substring(AUX_NAME_PREFIX.length()));
            if (i > auxBooleanVariablesCount)
                auxBooleanVariablesCount = i;
            aux = true;
        }
    }

    public BooleanVariable() throws SugarException {
        this.name = AUX_NAME_PREFIX + (++auxBooleanVariablesCount);
        aux = true;
    }
    
    /**
     * Returns the name of the boolean variable.
     * @return the name
     */
    public String getName() {
        return name;
    }

    /**
     * Returns true when the boolean variable is aux.
     * @return true when the boolean variable is aux
     */
    public boolean isAux() {
        return aux;
    }

    /**
     * Returns the comment set to the boolean variable.
     * @return the comment
     */
    public String getComment() {
        return comment;
    }

    /**
     * Sets the comment to the boolean variable.
     * @param comment the comment to set
     */
    public void setComment(String comment) {
        this.comment = comment;
    }

    /**
     * Returns the code value in the encoded representation. 
     * @return the code value in the encoded representation
     */
    public int getCode() {
        return code;
    }

    /**
     * Sets the code value in the encoded representation. 
     * @param code the code value
     */
    public void setCode(int code) {
        this.code = code;
    }

    public boolean isDominant() {
        return dominant;
    }

    public void setDominant(boolean dominant) {
        this.dominant = dominant;
    }

    /**
     * Returns the value of the boolean variable.
     * @return the value
     */
    public boolean getValue() {
        return value;
    }

    /**
     * Sets the value of the boolean variable.
     * @param value the value to set
     */
    public void setValue(boolean value) {
        this.value = value;
    }

    public int getSatVariablesSize() {
        return 1;
    }

    public void decode(BitSet satValues) {
        setValue(satValues.get(getCode()));
    }

    public int compareTo(BooleanVariable v) {
        if (this == v)
            return 0;
        if (v == null)
            return 1;
        return name.compareTo(v.name);
    }
    
    /* (non-Javadoc)
     * @see java.lang.Object#hashCode()
     */
    @Override
    public int hashCode() {
        final int PRIME = 31;
        int result = 1;
        result = PRIME * result + ((name == null) ? 0 : name.hashCode());
        return result;
    }

    /* (non-Javadoc)
     * @see java.lang.Object#equals(java.lang.Object)
     */
    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;
        if (getClass() != obj.getClass())
            return false;
        final BooleanVariable other = (BooleanVariable) obj;
        if (name == null) {
            if (other.name != null)
                return false;
        } else if (!name.equals(other.name))
            return false;
        return true;
    }

    /**
     * Returns the string representation of the boolean variable.
     * @return the string representation
     */
    @Override
    public String toString() {
        return "(bool " + name + ")";
    }

}