/*
 * BooleanStatistic.java
 *
 * Copyright (C) 2002-2006 Alexei Drummond and Andrew Rambaut
 *
 * This file is part of BEAST.
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership and licensing.
 *
 * BEAST is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 *  BEAST is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with BEAST; if not, write to the
 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
 * Boston, MA  02110-1301  USA
 */

package dr.inference.model;

/**
 * Abstract base class for boolean Statistics
 *
 * @version $Id: BooleanStatistic.java,v 1.2 2005/05/24 20:25:59 rambaut Exp $
 *
 * @author Andrew Rambaut
 */
public abstract class BooleanStatistic extends Statistic.Abstract {
	
	public BooleanStatistic(String name) { super(name); }
			
	/** @return 1.0 if the value of the attribute is equal to the testValue or 0.0 otherwise. */
	public double getStatisticValue(int dim) {
		if (getBoolean(dim))
			return 1.0;
		else
			return 0.0;
	}
	
	public abstract boolean getBoolean(int dim);
	
}

