FactorTable.java

/*
 * Copyright (c) 2015, SRI International
 * All rights reserved.
 * Licensed under the The BSD 3-Clause License;
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 * 
 * http://opensource.org/licenses/BSD-3-Clause
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 
 * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 * 
 * Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 * 
 * Neither the name of the aic-praise nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.sri.ai.praise.lang.grounded.markov;

import java.util.ArrayList;
import java.util.List;

import com.google.common.annotations.Beta;
import com.sri.ai.praise.lang.grounded.common.FunctionTable;

/**
 * A table representation of a factor for use in a Markov Network.
 * 
 * @author oreilly
 *
 */
@Beta
public class FactorTable {
	private List<Integer> variableIndexes;
	private FunctionTable functionTable;
	
	public FactorTable(List<Integer> variableIndexes, FunctionTable table) {
		this.variableIndexes = new ArrayList<>(variableIndexes);
		this.functionTable   = table;
		
		if (functionTable.numberVariables() != this.variableIndexes.size()) {
			throw new IllegalArgumentException("Function table's # vars "+functionTable.numberVariables()+" does not match # of variable indexes "+this.variableIndexes.size());
		}
	}
	
	public List<Integer> getVariableIndexes() {
		return variableIndexes;
	}
	
	public FunctionTable getTable() {
		return functionTable;
	}
	
	@Override
	public boolean equals(Object obj) {
		if (obj != null && obj instanceof FactorTable) {
			FactorTable other = (FactorTable) obj;
			return this.variableIndexes.equals(other.variableIndexes) && this.functionTable.equals(other.functionTable);
		}
		return false;
	}
	
	@Override
	public int hashCode() {
		return this.variableIndexes.hashCode() + this.functionTable.hashCode();
	}
}