Class Unsigned128BitType

java.lang.Object

net.imglib2.type.numeric.complex.AbstractComplexType<Unsigned128BitType>

net.imglib2.type.numeric.real.AbstractRealType<Unsigned128BitType>

net.imglib2.type.numeric.integer.AbstractIntegerType<Unsigned128BitType>

net.imglib2.type.numeric.integer.Unsigned128BitType

All Implemented Interfaces:

Comparable<Unsigned128BitType>, NativeType<Unsigned128BitType>, ComplexType<Unsigned128BitType>, IntegerType<Unsigned128BitType>, NumericType<Unsigned128BitType>, RealType<Unsigned128BitType>, Add<Unsigned128BitType>, Div<Unsigned128BitType>, Mul<Unsigned128BitType>, MulFloatingPoint, Pow<Unsigned128BitType>, PowFloatingPoint, SetOne, SetZero, Sub<Unsigned128BitType>, ValueEquals<Unsigned128BitType>, Type<Unsigned128BitType>

public class Unsigned128BitType
extends AbstractIntegerType<Unsigned128BitType>
implements NativeType<Unsigned128BitType>

A Type with a bit depth of 128. Each value is stored in two adjacent long in an array, with the lower long first, then the upper long. Currently the math methods defined in the superinterface NumericType are implemented using BigInteger and BigDecimal. This class is not Thread-safe; do a copy() first to operate on a different Thread.

Field Summary

Fields

Modifier and Type	Field	Description
protected final byte[]	bytes
protected LongAccess	dataAccess
private final Index	i
protected final NativeImg<?, ? extends LongAccess>	img
private static final NativeTypeFactory<Unsigned128BitType, LongAccess>	typeFactory

Constructor Summary

Constructors

Constructor	Description
Unsigned128BitType()
Unsigned128BitType(long lower, long upper)
Unsigned128BitType(BigInteger value)
Unsigned128BitType(LongAccess access)
Unsigned128BitType(NativeImg<?, ? extends LongAccess> bitStorage)

Method Summary

Modifier and Type	Method	Description
void	add(Unsigned128BitType t)	Relies on BigInteger.add(BigInteger).
int	compareTo(Unsigned128BitType t)
Unsigned128BitType	copy()	Creates a new Type variable that has the value of this Type
Unsigned128BitType	createVariable()	Creates a new Type variable which can only store one value.
void	dec()
void	div(Unsigned128BitType t)	Relies on BigInteger.divide(BigInteger).
Unsigned128BitType	duplicateTypeOnSameNativeImg()	Creates a new NativeType which stores in the same physical array.
boolean	equals(Object obj)
BigInteger	get()
BigInteger	getBigInteger()
int	getBitsPerPixel()
Fraction	getEntitiesPerPixel()	Get the number of entities in the storage array required to store one pixel value.
int	getInteger()	Return the lowest 32 bits, like BigInteger.intValue().
long	getIntegerLong()	Return the lowest 64 bits, like BigInteger.intValue().
BigInteger	getMaxBigIntegerValue()	The true maximum value, unlike getMaxValue() which cannot represent it in a double.
double	getMaxValue()	The maximum value that can be stored is Math.pow(2, 128) -1, which cannot be represented with precision using a double
double	getMinValue()
NativeTypeFactory<Unsigned128BitType, LongAccess>	getNativeTypeFactory()
double	getRealDouble()
float	getRealFloat()
int	hashCode()
void	inc()
Index	index()	Get the (modifiable) index into the current data array.
private final void	intoBytes(long lower, long upper)
void	mul(double c)	Implemented using BigDecimal.multiply(BigDecimal) and BigDecimal.toBigInteger().
void	mul(float c)	See mul(double).
void	mul(Unsigned128BitType t)	Relies on BigInteger.multiply(BigInteger).
void	pow(double power)
void	pow(Unsigned128BitType t)
void	set(byte[] bytes)	The first byte is the most significant byte, like in BigInteger.toByteArray().
void	set(long lower, long upper)
void	set(BigInteger value)
void	setBigInteger(BigInteger b)
void	setInteger(int value)
void	setInteger(long value)
void	setOne()
void	setReal(double real)
void	setReal(float real)
void	setZero()
void	sub(Unsigned128BitType t)	Relies on BigInteger.subtract(BigInteger).
String	toString()
void	updateContainer(Object c)	This method is used by an accessor (e.g., a Cursor) to request an update of the current data array.
boolean	valueEquals(Unsigned128BitType t)

Methods inherited from class AbstractIntegerType

getMinIncrement

Methods inherited from class AbstractRealType

getImaginaryDouble, getImaginaryFloat, getPhaseDouble, getPhaseFloat, getPowerDouble, getPowerFloat, set, setImaginary, setImaginary

Methods inherited from class AbstractComplexType

complexConjugate, setComplexNumber, setComplexNumber

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ComplexType

complexConjugate, getImaginaryDouble, getImaginaryFloat, getPhaseDouble, getPhaseFloat, getPowerDouble, getPowerFloat, setComplexNumber, setComplexNumber, setImaginary, setImaginary

Methods inherited from interface NativeType

decIndex, decIndex, getIndex, incIndex, incIndex, updateIndex

Methods inherited from interface Type

set

Field Details

i

private final Index i

img

protected final NativeImg<?, ? extends LongAccess> img

bytes

protected final byte[] bytes

dataAccess

protected LongAccess dataAccess

typeFactory

private static final NativeTypeFactory<Unsigned128BitType, LongAccess> typeFactory

Constructor Details

Unsigned128BitType

public Unsigned128BitType(NativeImg<?, ? extends LongAccess> bitStorage)

Unsigned128BitType

public Unsigned128BitType(long lower,
 long upper)

Unsigned128BitType

public Unsigned128BitType(BigInteger value)

Unsigned128BitType

public Unsigned128BitType(LongAccess access)

Unsigned128BitType

public Unsigned128BitType()

Method Details

updateContainer

public void updateContainer(Object c)

Description copied from interface: NativeType

This method is used by an accessor (e.g., a Cursor) to request an update of the current data array.

As an example consider a CellCursor moving on a CellImg. The cursor maintains a NativeType which provides access to the image data. When the cursor moves from one cell to the next, the underlying data array of the NativeType must be switched to the data array of the new cell.

To achieve this, the CellCursor calls updateContainer() with itself as the argument. updateContainer() in turn will call NativeImg.update(Object) on it's container, passing along the reference to the cursor. In this example, the container would be a CellImg. While the NativeType does not know about the type of the cursor, the container does. CellImg knows that it is passed a CellCursor instance, which can be used to figure out the current cell and the underlying data array, which is then returned to the NativeType.

The idea behind this concept is maybe not obvious. The NativeType knows which basic type is used (float, int, byte, ...). However, it does not know how the data is stored (ArrayImg, CellImg, ...). This prevents the need for multiple implementations of NativeType .

Specified by:

updateContainer in interface NativeType<Unsigned128BitType>

Parameters:

c - reference to an accessor which can be passed on to the container (which will know what to do with it).

index

public Index index()

Description copied from interface: NativeType

Get the (modifiable) index into the current data array. The returned instance will always be the same for the same Type.

Specified by:

index in interface NativeType<Unsigned128BitType>

duplicateTypeOnSameNativeImg

public Unsigned128BitType duplicateTypeOnSameNativeImg()

Description copied from interface: NativeType

Creates a new NativeType which stores in the same physical array. This is only used internally.

Specified by:

duplicateTypeOnSameNativeImg in interface NativeType<Unsigned128BitType>

Returns:

a new NativeType instance working on the same NativeImg

getNativeTypeFactory

public NativeTypeFactory<Unsigned128BitType, LongAccess> getNativeTypeFactory()

Specified by:

getNativeTypeFactory in interface NativeType<Unsigned128BitType>

intoBytes

private final void intoBytes(long lower,
 long upper)

set

public void set(byte[] bytes)

The first byte is the most significant byte, like in BigInteger.toByteArray(). Only the last 16 bytes are read, if there are more.

get

public BigInteger get()

set

public void set(BigInteger value)

set

public void set(long lower,
 long upper)

getInteger

public int getInteger()

Return the lowest 32 bits, like BigInteger.intValue().

Specified by:

getInteger in interface IntegerType<Unsigned128BitType>

getIntegerLong

public long getIntegerLong()

Return the lowest 64 bits, like BigInteger.intValue().

Specified by:

getIntegerLong in interface IntegerType<Unsigned128BitType>

getBigInteger

public BigInteger getBigInteger()

Specified by:

getBigInteger in interface IntegerType<Unsigned128BitType>

getRealFloat

public float getRealFloat()

Specified by:

getRealFloat in interface ComplexType<Unsigned128BitType>

Overrides:

getRealFloat in class AbstractIntegerType<Unsigned128BitType>

getRealDouble

public double getRealDouble()

Specified by:

getRealDouble in interface ComplexType<Unsigned128BitType>

Overrides:

getRealDouble in class AbstractIntegerType<Unsigned128BitType>

setInteger

public void setInteger(int value)

Specified by:

setInteger in interface IntegerType<Unsigned128BitType>

setInteger

public void setInteger(long value)

Specified by:

setInteger in interface IntegerType<Unsigned128BitType>

setBigInteger

public void setBigInteger(BigInteger b)

Specified by:

setBigInteger in interface IntegerType<Unsigned128BitType>

setReal

public void setReal(float real)

Specified by:

setReal in interface ComplexType<Unsigned128BitType>

Overrides:

setReal in class AbstractIntegerType<Unsigned128BitType>

setReal

public void setReal(double real)

Specified by:

setReal in interface ComplexType<Unsigned128BitType>

Overrides:

setReal in class AbstractIntegerType<Unsigned128BitType>

getMaxValue

public double getMaxValue()

The maximum value that can be stored is Math.pow(2, 128) -1, which cannot be represented with precision using a double

Specified by:

getMaxValue in interface RealType<Unsigned128BitType>

getMaxBigIntegerValue

public BigInteger getMaxBigIntegerValue()

The true maximum value, unlike getMaxValue() which cannot represent it in a double.

getMinValue

public double getMinValue()

Specified by:

getMinValue in interface RealType<Unsigned128BitType>

createVariable

public Unsigned128BitType createVariable()

Description copied from interface: Type

Creates a new Type variable which can only store one value.

Specified by:

createVariable in interface Type<Unsigned128BitType>

Returns:

a new Type variable

copy

public Unsigned128BitType copy()

Description copied from interface: Type

Creates a new Type variable that has the value of this Type

Specified by:

copy in interface Type<Unsigned128BitType>

Returns:

a new Type variable

getEntitiesPerPixel

public Fraction getEntitiesPerPixel()

Description copied from interface: NativeType

Get the number of entities in the storage array required to store one pixel value. A pixel value may be spread over several or less than one entity. For example, a complex number may require 2 entries of a float[] array to store one pixel. Or a 12-bit type might need 12/64th entries of a long[] array.

Specified by:

getEntitiesPerPixel in interface NativeType<Unsigned128BitType>

Returns:

the number of storage type entities required to store one pixel value.

getBitsPerPixel

public int getBitsPerPixel()

Specified by:

getBitsPerPixel in interface RealType<Unsigned128BitType>

inc

public void inc()

Specified by:

inc in interface RealType<Unsigned128BitType>

Overrides:

inc in class AbstractIntegerType<Unsigned128BitType>

dec

public void dec()

Specified by:

dec in interface RealType<Unsigned128BitType>

Overrides:

dec in class AbstractIntegerType<Unsigned128BitType>

setZero

public void setZero()

Specified by:

setZero in interface SetZero

Overrides:

setZero in class AbstractIntegerType<Unsigned128BitType>

setOne

public void setOne()

Specified by:

setOne in interface SetOne

Overrides:

setOne in class AbstractIntegerType<Unsigned128BitType>

mul

public void mul(float c)

See mul(double).

Specified by:

mul in interface MulFloatingPoint

Overrides:

mul in class AbstractRealType<Unsigned128BitType>

mul

public void mul(double c)

Implemented using BigDecimal.multiply(BigDecimal) and BigDecimal.toBigInteger().

Specified by:

mul in interface MulFloatingPoint

Overrides:

mul in class AbstractRealType<Unsigned128BitType>

add

public void add(Unsigned128BitType t)

Relies on BigInteger.add(BigInteger).

Specified by:

add in interface Add<Unsigned128BitType>

Overrides:

add in class AbstractRealType<Unsigned128BitType>

sub

public void sub(Unsigned128BitType t)

Relies on BigInteger.subtract(BigInteger).

Specified by:

sub in interface Sub<Unsigned128BitType>

Overrides:

sub in class AbstractRealType<Unsigned128BitType>

mul

public void mul(Unsigned128BitType t)

Relies on BigInteger.multiply(BigInteger).

Specified by:

mul in interface Mul<Unsigned128BitType>

Overrides:

mul in class AbstractRealType<Unsigned128BitType>

div

public void div(Unsigned128BitType t)

Relies on BigInteger.divide(BigInteger).

Specified by:

div in interface Div<Unsigned128BitType>

Overrides:

div in class AbstractRealType<Unsigned128BitType>

pow

public void pow(Unsigned128BitType t)

Specified by:

pow in interface Pow<Unsigned128BitType>

Overrides:

pow in class AbstractRealType<Unsigned128BitType>

pow

public void pow(double power)

Specified by:

pow in interface PowFloatingPoint

Overrides:

pow in class AbstractRealType<Unsigned128BitType>

compareTo

public int compareTo(Unsigned128BitType t)

Specified by:

compareTo in interface Comparable<Unsigned128BitType>

Overrides:

compareTo in class AbstractIntegerType<Unsigned128BitType>

valueEquals

public boolean valueEquals(Unsigned128BitType t)

Specified by:

valueEquals in interface ValueEquals<Unsigned128BitType>

Overrides:

valueEquals in class AbstractIntegerType<Unsigned128BitType>

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractIntegerType<Unsigned128BitType>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractIntegerType<Unsigned128BitType>

toString

public String toString()

Overrides:

toString in class AbstractIntegerType<Unsigned128BitType>