//******************************************************************************
//
// File:    BooleanItemBuf.java
// Package: edu.rit.mp.buf
// Unit:    Class edu.rit.mp.buf.BooleanItemBuf
//
// 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.mp.buf;

import edu.rit.mp.Buf;
import edu.rit.mp.BooleanBuf;

import edu.rit.pj.reduction.BooleanOp;
import edu.rit.pj.reduction.Op;

import java.nio.ByteBuffer;

/**
 * Class BooleanItemBuf provides a buffer for a single Boolean item sent or
 * received using the Message Protocol (MP). While an instance of class
 * BooleanItemBuf may be constructed directly, normally you will use a factory
 * method in class {@linkplain edu.rit.mp.BooleanBuf BooleanBuf}. See that class
 * for further information.
 *
 * @author  Alan Kaminsky
 * @version 25-Oct-2007
 */
public class BooleanItemBuf
	extends BooleanBuf
	{

// Exported data members.

	/**
	 * Boolean item to be sent or received.
	 */
	public boolean item;

// Exported constructors.

	/**
	 * Construct a new Boolean item buffer.
	 */
	public BooleanItemBuf()
		{
		super (1);
		}

	/**
	 * Construct a new Boolean item buffer with the given initial value.
	 *
	 * @param  item  Initial value of the {@link #item} field.
	 */
	public BooleanItemBuf
		(boolean item)
		{
		super (1);
		this.item = item;
		}

// Exported operations.

	/**
	 * Obtain the given item from this buffer.
	 * 

	 * The get() method must not block the calling thread; if it does,
	 * all message I/O in MP will be blocked.
	 *
	 * @param  i  Item index in the range 0 .. length()-1.
	 *
	 * @return  Item at index i.
	 */
	public boolean get
		(int i)
		{
		return this.item;
		}

	/**
	 * Store the given item in this buffer.
	 * 

	 * The put() method must not block the calling thread; if it does,
	 * all message I/O in MP will be blocked.
	 *
	 * @param  i     Item index in the range 0 .. length()-1.
	 * @param  item  Item to be stored at index i.
	 */
	public void put
		(int i,
		 boolean item)
		{
		this.item = item;
		}

	/**
	 * Create a buffer for performing parallel reduction using the given binary
	 * operation. The results of the reduction are placed into this buffer.
	 *
	 * @param  op  Binary operation.
	 *
	 * @exception  ClassCastException
	 *     (unchecked exception) Thrown if this buffer's element data type and
	 *     the given binary operation's argument data type are not the same.
	 */
	public Buf getReductionBuf
		(Op op)
		{
		return new BooleanItemReductionBuf (this, (BooleanOp) op);
		}

// Hidden operations.

	/**
	 * Send as many items as possible from this buffer to the given byte
	 * buffer.
	 * 

	 * The sendItems() method must not block the calling thread; if it
	 * does, all message I/O in MP will be blocked.
	 *
	 * @param  i       Index of first item to send, in the range 0 ..
	 *                 length-1.
	 * @param  buffer  Byte buffer.
	 *
	 * @return  Number of items sent.
	 */
	protected int sendItems
		(int i,
		 ByteBuffer buffer)
		{
		if (buffer.remaining() >= 1)
			{
			buffer.put (this.item ? (byte) 1 : (byte) 0);
			return 1;
			}
		else
			{
			return 0;
			}
		}

	/**
	 * Receive as many items as possible from the given byte buffer to this
	 * buffer.
	 * 

	 * The receiveItems() method must not block the calling thread; if
	 * it does, all message I/O in MP will be blocked.
	 *
	 * @param  i       Index of first item to receive, in the range 0 ..
	 *                 length-1.
	 * @param  num     Maximum number of items to receive.
	 * @param  buffer  Byte buffer.
	 *
	 * @return  Number of items received.
	 */
	protected int receiveItems
		(int i,
		 int num,
		 ByteBuffer buffer)
		{
		if (num >= 1 && buffer.remaining() >= 1)
			{
			this.item = buffer.get() != 0;
			return 1;
			}
		else
			{
			return 0;
			}
		}

	}