//******************************************************************************
//
// File:    SharedCharacter.java
// Package: edu.rit.pj.reduction
// Unit:    Class edu.rit.pj.reduction.SharedCharacter
//
// 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;

import java.util.concurrent.atomic.AtomicInteger;

/**
 * Class SharedCharacter provides a reduction variable for a value of type
 * char.
 * 

 * Class SharedCharacter is multiple thread safe. The methods use lock-free
 * atomic compare-and-set.
 * 

 * Note: Class SharedCharacter is implemented using class
 * java.util.concurrent.atomic.AtomicInteger. The character value is stored as
 * an int whose values are restricted to the range of type
 * char.
 *
 * @author  Alan Kaminsky
 * @version 07-Jun-2007
 */
public class SharedCharacter
	extends Number
	{

// Hidden data members.

	private AtomicInteger myValue;

// Exported constructors.

	/**
	 * Construct a new character reduction variable with the initial value 0.
	 */
	public SharedCharacter()
		{
		myValue = new AtomicInteger();
		}

	/**
	 * Construct a new character reduction variable with the given initial
	 * value.
	 *
	 * @param  initialValue  Initial value.
	 */
	public SharedCharacter
		(char initialValue)
		{
		myValue = new AtomicInteger (initialValue);
		}

// Exported operations.

	/**
	 * Returns this reduction variable's current value.
	 *
	 * @return  Current value.
	 */
	public char get()
		{
		return (char) myValue.get();
		}

	/**
	 * Set this reduction variable to the given value.
	 *
	 * @param  value  New value.
	 */
	public void set
		(char value)
		{
		myValue.set (value);
		}

	/**
	 * Set this reduction variable to the given value and return the previous
	 * value.
	 *
	 * @param  value  New value.
	 *
	 * @return  Previous value.
	 */
	public char getAndSet
		(char value)
		{
		return (char) myValue.getAndSet (value);
		}

	/**
	 * Atomically set this reduction variable to the given updated value if the
	 * current value equals the expected value.
	 *
	 * @param  expect  Expected value.
	 * @param  update  Updated value.
	 *
	 * @return  True if the update happened, false otherwise.
	 */
	public boolean compareAndSet
		(char expect,
		 char update)
		{
		return myValue.compareAndSet (expect, update);
		}

	/**
	 * Atomically set this reduction variable to the given updated value if the
	 * current value equals the expected value. May fail spuriously.
	 *
	 * @param  expect  Expected value.
	 * @param  update  Updated value.
	 *
	 * @return  True if the update happened, false otherwise.
	 */
	public boolean weakCompareAndSet
		(char expect,
		 char update)
		{
		return myValue.weakCompareAndSet (expect, update);
		}

	/**
	 * Add one to this reduction variable and return the previous value.
	 *
	 * @return  Previous value.
	 */
	public char getAndIncrement()
		{
		for (;;)
			{
			char oldvalue = (char) myValue.get();
			char newvalue = (char) (oldvalue + 1);
			if (myValue.compareAndSet (oldvalue, newvalue)) return oldvalue;
			}
		}

	/**
	 * Subtract one from this reduction variable and return the previous value.
	 *
	 * @return  Previous value.
	 */
	public char getAndDecrement()
		{
		for (;;)
			{
			char oldvalue = (char) myValue.get();
			char newvalue = (char) (oldvalue - 1);
			if (myValue.compareAndSet (oldvalue, newvalue)) return oldvalue;
			}
		}

	/**
	 * Add the given value to this reduction variable and return the previous
	 * value.
	 *
	 * @param  value  Value to add.
	 *
	 * @return  Previous value.
	 */
	public char getAndAdd
		(char value)
		{
		for (;;)
			{
			char oldvalue = (char) myValue.get();
			char newvalue = (char) (oldvalue + value);
			if (myValue.compareAndSet (oldvalue, newvalue)) return oldvalue;
			}
		}

	/**
	 * Add one to this reduction variable and return the new value.
	 *
	 * @return  New value.
	 */
	public char incrementAndGet()
		{
		for (;;)
			{
			char oldvalue = (char) myValue.get();
			char newvalue = (char) (oldvalue + 1);
			if (myValue.compareAndSet (oldvalue, newvalue)) return newvalue;
			}
		}

	/**
	 * Subtract one from this reduction variable and return the new value.
	 *
	 * @return  New value.
	 */
	public char decrementAndGet()
		{
		for (;;)
			{
			char oldvalue = (char) myValue.get();
			char newvalue = (char) (oldvalue - 1);
			if (myValue.compareAndSet (oldvalue, newvalue)) return newvalue;
			}
		}

	/**
	 * Add the given value to this reduction variable and return the new value.
	 *
	 * @param  value  Value to add.
	 *
	 * @return  New value.
	 */
	public char addAndGet
		(char value)
		{
		for (;;)
			{
			char oldvalue = (char) myValue.get();
			char newvalue = (char) (oldvalue + value);
			if (myValue.compareAndSet (oldvalue, newvalue)) return newvalue;
			}
		}

	/**
	 * Combine this reduction variable with the given value using the given
	 * operation. The result is stored back into this reduction variable and is
	 * returned.
	 *
	 * @param  value  Value.
	 * @param  op     Binary operation.
	 *
	 * @return  (This variable) op (value).
	 */
	public char reduce
		(char value,
		 CharacterOp op)
		{
		for (;;)
			{
			char oldvalue = (char) myValue.get();
			char newvalue = op.op (oldvalue, value);
			if (myValue.compareAndSet (oldvalue, newvalue)) return newvalue;
			}
		}

	/**
	 * Returns a string version of this reduction variable.
	 *
	 * @return  String version.
	 */
	public String toString()
		{
		return Character.toString (get());
		}

	/**
	 * Returns this reduction variable's current value converted to type
	 * int.
	 *
	 * @return  Current value.
	 */
	public int intValue()
		{
		return (int) get();
		}

	/**
	 * Returns this reduction variable's current value converted to type
	 * long.
	 *
	 * @return  Current value.
	 */
	public long longValue()
		{
		return (long) get();
		}

	/**
	 * Returns this reduction variable's current value converted to type
	 * float.
	 *
	 * @return  Current value.
	 */
	public float floatValue()
		{
		return (float) get();
		}

	/**
	 * Returns this reduction variable's current value converted to type
	 * double.
	 *
	 * @return  Current value.
	 */
	public double doubleValue()
		{
		return (double) get();
		}

	}