//******************************************************************************
//
// File: SharedFloat.java
// Package: edu.rit.pj.reduction
// Unit: Class edu.rit.pj.reduction.SharedFloat
//
// 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 SharedFloat provides a reduction variable for a value of type
* float.
*
* Class SharedFloat is multiple thread safe. The methods use lock-free atomic
* compare-and-set.
*
* Note: Class SharedFloat is implemented using class
* java.util.concurrent.atomic.AtomicInteger. The float value is stored as an
* int whose bit pattern is the same as the float value.
*
* @author Alan Kaminsky
* @version 07-Jun-2007
*/
public class SharedFloat
extends Number
{
// Hidden data members.
private AtomicInteger myValue;
// Exported constructors.
/**
* Construct a new float reduction variable with the initial value 0.
*/
public SharedFloat()
{
myValue = new AtomicInteger (Float.floatToIntBits (0.0f));
}
/**
* Construct a new float reduction variable with the given initial value.
*
* @param initialValue Initial value.
*/
public SharedFloat
(float initialValue)
{
myValue = new AtomicInteger (Float.floatToIntBits (initialValue));
}
// Exported operations.
/**
* Returns this reduction variable's current value.
*
* @return Current value.
*/
public float get()
{
return Float.intBitsToFloat (myValue.get());
}
/**
* Set this reduction variable to the given value.
*
* @param value New value.
*/
public void set
(float value)
{
myValue.set (Float.floatToIntBits (value));
}
/**
* Set this reduction variable to the given value and return the previous
* value.
*
* @param value New value.
*
* @return Previous value.
*/
public float getAndSet
(float value)
{
return Float.intBitsToFloat
(myValue.getAndSet (Float.floatToIntBits (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
(float expect,
float update)
{
return myValue.compareAndSet
(Float.floatToIntBits (expect), Float.floatToIntBits (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
(float expect,
float update)
{
return myValue.weakCompareAndSet
(Float.floatToIntBits (expect), Float.floatToIntBits (update));
}
/**
* Add one to this reduction variable and return the previous value.
*
* @return Previous value.
*/
public float getAndIncrement()
{
for (;;)
{
int oldvalueInt = myValue.get();
float oldvalue = Float.intBitsToFloat (oldvalueInt);
float newvalue = oldvalue + 1.0f;
int newvalueInt = Float.floatToIntBits (newvalue);
if (myValue.compareAndSet (oldvalueInt, newvalueInt))
{
return oldvalue;
}
}
}
/**
* Subtract one from this reduction variable and return the previous value.
*
* @return Previous value.
*/
public float getAndDecrement()
{
for (;;)
{
int oldvalueInt = myValue.get();
float oldvalue = Float.intBitsToFloat (oldvalueInt);
float newvalue = oldvalue - 1.0f;
int newvalueInt = Float.floatToIntBits (newvalue);
if (myValue.compareAndSet (oldvalueInt, newvalueInt))
{
return oldvalue;
}
}
}
/**
* Add the given value to this reduction variable and return the previous
* value.
*
* @param value Value to add.
*
* @return Previous value.
*/
public float getAndAdd
(float value)
{
for (;;)
{
int oldvalueInt = myValue.get();
float oldvalue = Float.intBitsToFloat (oldvalueInt);
float newvalue = oldvalue + value;
int newvalueInt = Float.floatToIntBits (newvalue);
if (myValue.compareAndSet (oldvalueInt, newvalueInt))
{
return oldvalue;
}
}
}
/**
* Add one to this reduction variable and return the new value.
*
* @return New value.
*/
public float incrementAndGet()
{
for (;;)
{
int oldvalueInt = myValue.get();
float oldvalue = Float.intBitsToFloat (oldvalueInt);
float newvalue = oldvalue + 1.0f;
int newvalueInt = Float.floatToIntBits (newvalue);
if (myValue.compareAndSet (oldvalueInt, newvalueInt))
{
return newvalue;
}
}
}
/**
* Subtract one from this reduction variable and return the new value.
*
* @return New value.
*/
public float decrementAndGet()
{
for (;;)
{
int oldvalueInt = myValue.get();
float oldvalue = Float.intBitsToFloat (oldvalueInt);
float newvalue = oldvalue - 1.0f;
int newvalueInt = Float.floatToIntBits (newvalue);
if (myValue.compareAndSet (oldvalueInt, newvalueInt))
{
return newvalue;
}
}
}
/**
* Add the given value to this reduction variable and return the new value.
*
* @param value Value to add.
*
* @return New value.
*/
public float addAndGet
(float value)
{
for (;;)
{
int oldvalueInt = myValue.get();
float oldvalue = Float.intBitsToFloat (oldvalueInt);
float newvalue = oldvalue + value;
int newvalueInt = Float.floatToIntBits (newvalue);
if (myValue.compareAndSet (oldvalueInt, newvalueInt))
{
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 float reduce
(float value,
FloatOp op)
{
for (;;)
{
int oldvalueInt = myValue.get();
float oldvalue = Float.intBitsToFloat (oldvalueInt);
float newvalue = op.op (oldvalue, value);
int newvalueInt = Float.floatToIntBits (newvalue);
if (myValue.compareAndSet (oldvalueInt, newvalueInt))
{
return newvalue;
}
}
}
/**
* Returns a string version of this reduction variable.
*
* @return String version.
*/
public String toString()
{
return Float.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();
}
}
Ads help maintain this website.