edu.rit.pj.reduction
Class SharedShort

java.lang.Object
  java.lang.Number
      edu.rit.pj.reduction.SharedShort

All Implemented Interfaces:

Serializable

public class SharedShort
extends Number

Class SharedShort provides a reduction variable for a value of type short.

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

Note: Class SharedShort is implemented using class java.util.concurrent.atomic.AtomicInteger. The short value is stored as an int whose values are restricted to the range of type short.

See Also:

Serialized Form

Constructor Summary

SharedShort()
Construct a new short reduction variable with the initial value 0.

SharedShort(short initialValue)
Construct a new short reduction variable with the given initial value.

Method Summary

short	addAndGet(short value) Add the given value to this reduction variable and return the new value.
boolean	compareAndSet(short expect, short update) Atomically set this reduction variable to the given updated value if the current value equals the expected value.
short	decrementAndGet() Subtract one from this reduction variable and return the new value.
double	doubleValue() Returns this reduction variable's current value converted to type double.
float	floatValue() Returns this reduction variable's current value converted to type float.
short	get() Returns this reduction variable's current value.
short	getAndAdd(short value) Add the given value to this reduction variable and return the previous value.
short	getAndDecrement() Subtract one from this reduction variable and return the previous value.
short	getAndIncrement() Add one to this reduction variable and return the previous value.
short	getAndSet(short value) Set this reduction variable to the given value and return the previous value.
short	incrementAndGet() Add one to this reduction variable and return the new value.
int	intValue() Returns this reduction variable's current value converted to type int.
long	longValue() Returns this reduction variable's current value converted to type long.
short	reduce(short value, ShortOp op) Combine this reduction variable with the given value using the given operation.
void	set(short value) Set this reduction variable to the given value.
String	toString() Returns a string version of this reduction variable.
boolean	weakCompareAndSet(short expect, short update) Atomically set this reduction variable to the given updated value if the current value equals the expected value.

Methods inherited from class java.lang.Number

byteValue, shortValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SharedShort

public SharedShort()

Construct a new short reduction variable with the initial value 0.

SharedShort

public SharedShort(short initialValue)

Construct a new short reduction variable with the given initial value.

Parameters:

initialValue - Initial value.

Method Detail

get

public short get()

Returns this reduction variable's current value.

Returns:

Current value.

set

public void set(short value)

Set this reduction variable to the given value.

Parameters:

value - New value.

getAndSet

public short getAndSet(short value)

Set this reduction variable to the given value and return the previous value.

Parameters:

value - New value.

Returns:

Previous value.

compareAndSet

public boolean compareAndSet(short expect,
                             short update)

Atomically set this reduction variable to the given updated value if the current value equals the expected value.

Parameters:

expect - Expected value.

update - Updated value.

Returns:

True if the update happened, false otherwise.

weakCompareAndSet

public boolean weakCompareAndSet(short expect,
                                 short update)

Atomically set this reduction variable to the given updated value if the current value equals the expected value. May fail spuriously.

Parameters:

expect - Expected value.

update - Updated value.

Returns:

True if the update happened, false otherwise.

getAndIncrement

public short getAndIncrement()

Add one to this reduction variable and return the previous value.

Returns:

Previous value.

getAndDecrement

public short getAndDecrement()

Subtract one from this reduction variable and return the previous value.

Returns:

Previous value.

getAndAdd

public short getAndAdd(short value)

Add the given value to this reduction variable and return the previous value.

Parameters:

value - Value to add.

Returns:

Previous value.

incrementAndGet

public short incrementAndGet()

Add one to this reduction variable and return the new value.

Returns:

New value.

decrementAndGet

public short decrementAndGet()

Subtract one from this reduction variable and return the new value.

Returns:

New value.

addAndGet

public short addAndGet(short value)

Add the given value to this reduction variable and return the new value.

Parameters:

value - Value to add.

Returns:

New value.

reduce

public short reduce(short value,
                    ShortOp op)

Combine this reduction variable with the given value using the given operation. The result is stored back into this reduction variable and is returned.

Parameters:

value - Value.

op - Binary operation.

Returns:

(This variable) op (value).

toString

public String toString()

Returns a string version of this reduction variable.

Overrides:

toString in class Object

Returns:

String version.

intValue

public int intValue()

Returns this reduction variable's current value converted to type int.

Specified by:

intValue in class Number

Returns:

Current value.

longValue

public long longValue()

Returns this reduction variable's current value converted to type long.

Specified by:

longValue in class Number

Returns:

Current value.

floatValue

public float floatValue()

Returns this reduction variable's current value converted to type float.

Specified by:

floatValue in class Number

Returns:

Current value.

doubleValue

public double doubleValue()

Returns this reduction variable's current value converted to type double.

Specified by:

doubleValue in class Number

Returns:

Current value.