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

import edu.rit.pj.reduction.ObjectOp;
import edu.rit.pj.reduction.Op;
import edu.rit.pj.reduction.SharedObjectArray;

import edu.rit.util.Range;

/**
 * Class SharedObjectArrayBuf provides a buffer for a multiple thread safe
 * array of object items sent or received using the Message Protocol (MP).
 * The array element stride may be 1 or greater than 1. While an instance of
 * class SharedObjectArrayBuf may be constructed directly, normally you will
 * use a factory method in class {@linkplain edu.rit.mp.ObjectBuf
 * ObjectBuf}. See that class for further information.
 *
 * @param    Data type of the objects in the buffer.
 *
 * @author  Alan Kaminsky
 * @version 26-Oct-2007
 */
public class SharedObjectArrayBuf
	extends ObjectBuf
	{

// Hidden data members.

	SharedObjectArray myArray;
	Range myRange;
	int myArrayOffset;
	int myStride;

// Exported constructors.

	/**
	 * Construct a new shared object array buffer.
	 *
	 * @param  theArray  Shared array.
	 * @param  theRange  Range of array elements to include in the buffer.
	 */
	public SharedObjectArrayBuf
		(SharedObjectArray theArray,
		 Range theRange)
		{
		super (theRange.length());
		myArray = theArray;
		myRange = theRange;
		myArrayOffset = theRange.lb();
		myStride = theRange.stride();
		}

// 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 T get
		(int i)
		{
		return myArray.get (myArrayOffset+i*myStride);
		}

	/**
	 * 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,
		 T item)
		{
		myArray.set (myArrayOffset+i*myStride, item);
		mySerializedItems = null;
		}

	/**
	 * 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 SharedObjectArrayReductionBuf
			(myArray, myRange, (ObjectOp) op);
		}

	}