//******************************************************************************
//
// File:    BooleanOp.java
// Package: edu.rit.pj.reduction
// Unit:    Class edu.rit.pj.reduction.BooleanOp
//
// This Java source file is copyright (C) 2007 by Alan Kaminsky. All rights
// reserved. For further information, contact the author, Alan Kaminsky, at
// ark@cs.rit.edu.
//
// This Java source file is part of the Parallel Java Library ("PJ"). PJ is free
// software; you can redistribute it and/or modify it under the terms of the GNU
// General Public License as published by the Free Software Foundation; either
// version 3 of the License, or (at your option) any later version.
//
// PJ 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 General Public License for more details.
//
// A copy of the GNU General Public License is provided in the file gpl.txt. You
// may also obtain a copy of the GNU General Public License on the World Wide
// Web at http://www.gnu.org/licenses/gpl.html.
//
//******************************************************************************

package edu.rit.pj.reduction;

/**
 * Class BooleanOp is the abstract base class for a binary operation on Boolean
 * values, used to do reduction in a parallel program.
 *
 * @author  Alan Kaminsky
 * @version 05-Jun-2007
 */
public abstract class BooleanOp
	extends Op
	{

// Hidden constructors.

	/**
	 * Construct a new Boolean binary operation.
	 */
	protected BooleanOp()
		{
		super();
		}

// Exported operations.

	/**
	 * Perform this binary operation.
	 *
	 * @param  x  First argument.
	 * @param  y  Second argument.
	 *
	 * @return  (x op y), where op stands for
	 *          this binary operation.
	 */
	public abstract boolean op
		(boolean x,
		 boolean y);

// Exported constants.

	/**
	 * The Boolean logical "and" binary operation.
	 */
	public static final BooleanOp AND =
		new BooleanOp()
			{
			public boolean op
				(boolean x,
				 boolean y)
				{
				return x & y;
				}
			};

	/**
	 * The Boolean logical "or" binary operation.
	 */
	public static final BooleanOp OR =
		new BooleanOp()
			{
			public boolean op
				(boolean x,
				 boolean y)
				{
				return x | y;
				}
			};

	/**
	 * The Boolean logical "exclusive or" binary operation.
	 */
	public static final BooleanOp XOR =
		new BooleanOp()
			{
			public boolean op
				(boolean x,
				 boolean y)
				{
				return x ^ y;
				}
			};

	}