/*******************************************************************************
    * SAT4J: a SATisfiability library for Java Copyright (C) 2004-2008 Daniel Le Berre
    *
    * All rights reserved. This program and the accompanying materials
    * are made available under the terms of the Eclipse Public License v1.0
    * which accompanies this distribution, and is available at
    * http://www.eclipse.org/legal/epl-v10.html
    *
    * Alternatively, the contents of this file may be used under the terms of
   * either the GNU Lesser General Public License Version 2.1 or later (the
   * "LGPL"), in which case the provisions of the LGPL are applicable instead
   * of those above. If you wish to allow use of your version of this file only
   * under the terms of the LGPL, and not to allow others to use your version of
   * this file under the terms of the EPL, indicate your decision by deleting
   * the provisions above and replace them with the notice and other provisions
   * required by the LGPL. If you do not delete the provisions above, a recipient
   * may use your version of this file under the terms of the EPL or the LGPL.
   * 
   * Based on the original MiniSat specification from:
   * 
   * An extensible SAT solver. Niklas Een and Niklas Sorensson. Proceedings of the
   * Sixth International Conference on Theory and Applications of Satisfiability
   * Testing, LNCS 2919, pp 502-518, 2003.
   *
   * See www.minisat.se for the original solver in C++.
   * 
   *******************************************************************************/
  package org.sat4j.minisat.constraints.cnf;
  
  import static org.sat4j.core.LiteralsUtils.neg;
  
  import java.io.Serializable;
  
  import org.sat4j.minisat.core.Constr;
  import org.sat4j.minisat.core.ILits;
  import org.sat4j.minisat.core.UnitPropagationListener;
  import org.sat4j.specs.IVecInt;
  
  /**
   * Lazy data structure for clause using the Head Tail data structure from SATO,
   * The original scheme is improved by avoiding moving pointers to literals but
   * moving the literals themselves.
   * 
   * We suppose here that the clause contains at least 3 literals. Use the
   * BinaryClause or UnaryClause clause data structures to deal with binary and
   * unit clauses.
   * 
   * @author leberre
   * @see BinaryClause
   * @see UnitClause
   * @since 2.1
   */
  public abstract class HTClause implements Constr, Serializable {
  
  	private static final long serialVersionUID = 1L;
  
  	protected double activity;
  
  	protected final int[] middleLits;
  
  	protected final ILits voc;
  
  	protected int head;
  
  	protected int tail;
  
  	/**
  	 * Creates a new basic clause
  	 * 
  	 * @param voc
  	 *            the vocabulary of the formula
  	 * @param ps
  	 *            A VecInt that WILL BE EMPTY after calling that method.
  	 */
  	public HTClause(IVecInt ps, ILits voc) {
  		assert ps.size() > 1;
  		head = ps.get(0);
  		tail = ps.last();
  		final int size = ps.size() - 2;
  		assert size > 0;
  		middleLits = new int[size];
  		System.arraycopy(ps.toArray(), 1, middleLits, 0, size);
  		ps.clear();
  		assert ps.size() == 0;
  		this.voc = voc;
  		activity = 0;
  	}
  
  	/*
  	 * (non-Javadoc)
  	 * 
  	 * @see Constr#calcReason(Solver, Lit, Vec)
  	 */
  	public void calcReason(int p, IVecInt outReason) {
  		if (voc.isFalsified(head)) {
  			outReason.push(neg(head));
  		}
  		final int[] mylits = middleLits;
  		for (int i = 0; i < mylits.length; i++) {
 			if (voc.isFalsified(mylits[i])) {
 				outReason.push(neg(mylits[i]));
 			}
 		}
 		if (voc.isFalsified(tail)) {
 			outReason.push(neg(tail));
 		}
 	}
 
 	/*
 	 * (non-Javadoc)
 	 * 
 	 * @see Constr#remove(Solver)
 	 */
 	public void remove(UnitPropagationListener upl) {
 		voc.watches(neg(head)).remove(this);
 		voc.watches(neg(tail)).remove(this);
 	}
 
 	/*
 	 * (non-Javadoc)
 	 * 
 	 * @see Constr#simplify(Solver)
 	 */
 	public boolean simplify() {
 		if (voc.isSatisfied(head) || voc.isSatisfied(tail)) {
 			return true;
 		}
 		for (int i = 0; i < middleLits.length; i++) {
 			if (voc.isSatisfied(middleLits[i])) {
 				return true;
 			}
 		}
 		return false;
 	}
 
 	public boolean propagate(UnitPropagationListener s, int p) {
 
 		if (head == neg(p)) {
 			final int[] mylits = middleLits;
 			int temphead = 0;
 			// moving head on the right
 			while (temphead < mylits.length
 					&& voc.isFalsified(mylits[temphead])) {
 				temphead++;
 			}
 			assert temphead <= mylits.length;
 			if (temphead == mylits.length) {
 				voc.watch(p, this);
 				return s.enqueue(tail, this);
 			}
 			head = mylits[temphead];
 			mylits[temphead] = neg(p);
 			voc.watch(neg(head), this);
 			return true;
 		}
 		assert tail == neg(p);
 		final int[] mylits = middleLits;
 		int temptail = mylits.length - 1;
 		// moving tail on the left
 		while (temptail >= 0 && voc.isFalsified(mylits[temptail])) {
 			temptail--;
 		}
 		assert -1 <= temptail;
 		if (-1 == temptail) {
 			voc.watch(p, this);
 			return s.enqueue(head, this);
 		}
 		tail = mylits[temptail];
 		mylits[temptail] = neg(p);
 		voc.watch(neg(tail), this);
 		return true;
 	}
 
 	/*
 	 * For learnt clauses only @author leberre
 	 */
 	public boolean locked() {
 		return voc.getReason(head) == this || voc.getReason(tail) == this;
 	}
 
 	/**
 	 * @return the activity of the clause
 	 */
 	public double getActivity() {
 		return activity;
 	}
 
 	@Override
 	public String toString() {
 		StringBuffer stb = new StringBuffer();
 		stb.append(Lits.toString(head));
 		stb.append("["); //$NON-NLS-1$
 		stb.append(voc.valueToString(head));
 		stb.append("]"); //$NON-NLS-1$
 		stb.append(" "); //$NON-NLS-1$
 		for (int i = 0; i < middleLits.length; i++) {
 			stb.append(Lits.toString(middleLits[i]));
 			stb.append("["); //$NON-NLS-1$
 			stb.append(voc.valueToString(middleLits[i]));
 			stb.append("]"); //$NON-NLS-1$
 			stb.append(" "); //$NON-NLS-1$
 		}
 		stb.append(Lits.toString(tail));
 		stb.append("["); //$NON-NLS-1$
 		stb.append(voc.valueToString(tail));
 		stb.append("]"); //$NON-NLS-1$
 		return stb.toString();
 	}
 
 	/**
 	 * Return the ith literal of the clause. Note that the order of the literals
 	 * does change during the search...
 	 * 
 	 * @param i
 	 *            the index of the literal
 	 * @return the literal
 	 */
 	public int get(int i) {
 		if (i == 0)
 			return head;
 		if (i == middleLits.length + 1)
 			return tail;
 		return middleLits[i - 1];
 	}
 
 	/**
 	 * @param d
 	 */
 	public void rescaleBy(double d) {
 		activity *= d;
 	}
 
 	public int size() {
 		return middleLits.length + 2;
 	}
 
 	public void assertConstraint(UnitPropagationListener s) {
 		assert voc.isUnassigned(head);
 		boolean ret = s.enqueue(head, this);
 		assert ret;
 	}
 
 	public ILits getVocabulary() {
 		return voc;
 	}
 
 	public int[] getLits() {
 		int[] tmp = new int[size()];
 		System.arraycopy(middleLits, 0, tmp, 1, middleLits.length);
 		tmp[0] = head;
 		tmp[tmp.length - 1] = tail;
 		return tmp;
 	}
 
 	@Override
 	public boolean equals(Object obj) {
 		if (obj == null)
 			return false;
 		try {
 			HTClause wcl = (HTClause) obj;
 			if (wcl.head != head || wcl.tail != tail) {
 				return false;
 			}
 			if (middleLits.length != wcl.middleLits.length)
 				return false;
 			boolean ok;
 			for (int lit : middleLits) {
 				ok = false;
 				for (int lit2 : wcl.middleLits)
 					if (lit == lit2) {
 						ok = true;
 						break;
 					}
 				if (!ok)
 					return false;
 			}
 			return true;
 		} catch (ClassCastException e) {
 			return false;
 		}
 	}
 
 	@Override
 	public int hashCode() {
 		long sum = head + tail;
 		for (int p : middleLits) {
 			sum += p;
 		}
 		return (int) sum / middleLits.length;
 	}
 }