Class UnsignedLongType

java.lang.Object

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

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

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

net.imglib2.type.numeric.integer.GenericLongType<UnsignedLongType>

net.imglib2.type.numeric.integer.UnsignedLongType

All Implemented Interfaces:

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

Direct Known Subclasses:

VolatileUnsignedLongType.WrappedUnsignedLongType

public class UnsignedLongType
extends GenericLongType<UnsignedLongType>

TODO

Field Summary

Fields

Modifier and Type	Field	Description
private static final double	MAX_LONG_PLUS_ONE
private static final double	MAX_VALUE_PLUS_ONE
private static final NativeTypeFactory<UnsignedLongType, LongAccess>	typeFactory

Fields inherited from class GenericLongType

dataAccess, i, img

Constructor Summary

Constructors

Constructor	Description
UnsignedLongType()
UnsignedLongType(long value)
UnsignedLongType(BigInteger value)
UnsignedLongType(LongAccess access)
UnsignedLongType(NativeImg<?, ? extends LongAccess> img)

Method Summary

Modifier and Type	Method	Description
void	add(UnsignedLongType c)
static final int	compare(long a, long b)	Deprecated. Use Long.compareUnsigned(long, long) instead.
int	compareTo(UnsignedLongType other)
UnsignedLongType	copy()	Creates a new Type variable that has the value of this Type
UnsignedLongType	createVariable()	Creates a new Type variable which can only store one value.
void	dec()
void	div(UnsignedLongType c)
static final long	divide(long d1, long d2)	Unsigned division of d1 by d2.
(package private) static long	doubleToUnsignedLong(double real)
UnsignedLongType	duplicateTypeOnSameNativeImg()	Creates a new NativeType which stores in the same physical array.
long	get()	This method returns the value of the UnsignedLongType as a signed long.
BigInteger	getBigInteger()	This method returns the unsigned representation of this UnsignedLongType as a BigInteger.
int	getInteger()
long	getIntegerLong()
BigInteger	getMaxBigIntegerValue()	Returns the true maximum value as a BigInteger, since it cannot be precisely represented as a double.
double	getMaxValue()	The maximum value that can be stored is Math.pow( 2, 64 ) - 1, which can't be represented with exact precision using a double
double	getMinValue()
NativeTypeFactory<UnsignedLongType, LongAccess>	getNativeTypeFactory()
double	getRealDouble()
float	getRealFloat()
void	inc()
void	mul(double c)
void	mul(float c)
void	mul(UnsignedLongType c)
void	set(long value)
void	set(BigInteger bi)
void	setBigInteger(BigInteger b)
void	setInteger(int f)
void	setInteger(long f)
void	setOne()
void	setReal(double real)
void	setReal(float real)
void	setZero()
void	sub(UnsignedLongType c)
String	toString()
(package private) static double	unsignedLongToDouble(long l)

Methods inherited from class GenericLongType

equals, getBitsPerPixel, getEntitiesPerPixel, getLong, getValue, hashCode, index, set, setLong, setValue, updateContainer, valueEquals

Methods inherited from class AbstractIntegerType

getMinIncrement

Methods inherited from class AbstractRealType

getImaginaryDouble, getImaginaryFloat, getPhaseDouble, getPhaseFloat, getPowerDouble, getPowerFloat, pow, pow, 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 Pow

pow

Methods inherited from interface PowFloatingPoint

pow

Field Details

MAX_VALUE_PLUS_ONE

private static final double MAX_VALUE_PLUS_ONE

MAX_LONG_PLUS_ONE

private static final double MAX_LONG_PLUS_ONE

typeFactory

private static final NativeTypeFactory<UnsignedLongType, LongAccess> typeFactory

Constructor Details

UnsignedLongType

public UnsignedLongType(NativeImg<?, ? extends LongAccess> img)

UnsignedLongType

public UnsignedLongType(long value)

UnsignedLongType

public UnsignedLongType(BigInteger value)

UnsignedLongType

public UnsignedLongType(LongAccess access)

UnsignedLongType

public UnsignedLongType()

Method Details

duplicateTypeOnSameNativeImg

public UnsignedLongType duplicateTypeOnSameNativeImg()

Description copied from interface: NativeType

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

Returns:

a new NativeType instance working on the same NativeImg

getNativeTypeFactory

public NativeTypeFactory<UnsignedLongType, LongAccess> getNativeTypeFactory()

Specified by:

getNativeTypeFactory in interface NativeType<UnsignedLongType>

Specified by:

getNativeTypeFactory in class GenericLongType<UnsignedLongType>

mul

public void mul(float c)

Specified by:

mul in interface MulFloatingPoint

Overrides:

mul in class GenericLongType<UnsignedLongType>

mul

public void mul(double c)

Specified by:

mul in interface MulFloatingPoint

Overrides:

mul in class GenericLongType<UnsignedLongType>

add

public void add(UnsignedLongType c)

Specified by:

add in interface Add<UnsignedLongType>

Overrides:

add in class GenericLongType<UnsignedLongType>

div

public void div(UnsignedLongType c)

Specified by:

div in interface Div<UnsignedLongType>

Overrides:

div in class GenericLongType<UnsignedLongType>

See Also:

• divide(long, long)

divide

public static final long divide(long d1,
 long d2)

Unsigned division of d1 by d2. See "Division by Invariant Integers using Multiplication", by Torbjorn Granlund and Peter L. Montgomery, 1994. http://gmplib.org/~tege/divcnst-pldi94.pdf

Throws:

ArithmeticException - when c equals zero.

mul

public void mul(UnsignedLongType c)

Specified by:

mul in interface Mul<UnsignedLongType>

Overrides:

mul in class GenericLongType<UnsignedLongType>

sub

public void sub(UnsignedLongType c)

Specified by:

sub in interface Sub<UnsignedLongType>

Overrides:

sub in class GenericLongType<UnsignedLongType>

setOne

public void setOne()

Specified by:

setOne in interface SetOne

Overrides:

setOne in class GenericLongType<UnsignedLongType>

setZero

public void setZero()

Specified by:

setZero in interface SetZero

Overrides:

setZero in class GenericLongType<UnsignedLongType>

inc

public void inc()

Specified by:

inc in interface RealType<UnsignedLongType>

Overrides:

inc in class GenericLongType<UnsignedLongType>

dec

public void dec()

Specified by:

dec in interface RealType<UnsignedLongType>

Overrides:

dec in class GenericLongType<UnsignedLongType>

toString

public String toString()

Overrides:

toString in class GenericLongType<UnsignedLongType>

get

public long get()

This method returns the value of the UnsignedLongType as a signed long. To get the unsigned value, use getBigInteger().

getBigInteger

public BigInteger getBigInteger()

This method returns the unsigned representation of this UnsignedLongType as a BigInteger.

set

public void set(long value)

getInteger

public int getInteger()

getIntegerLong

public long getIntegerLong()

setInteger

public void setInteger(int f)

setInteger

public void setInteger(long f)

setBigInteger

public void setBigInteger(BigInteger b)

setReal

public void setReal(double real)

Specified by:

setReal in interface ComplexType<UnsignedLongType>

Overrides:

setReal in class AbstractIntegerType<UnsignedLongType>

doubleToUnsignedLong

static long doubleToUnsignedLong(double real)

setReal

public void setReal(float real)

Specified by:

setReal in interface ComplexType<UnsignedLongType>

Overrides:

setReal in class AbstractIntegerType<UnsignedLongType>

set

public void set(BigInteger bi)

getMaxValue

public double getMaxValue()

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

getMaxBigIntegerValue

public BigInteger getMaxBigIntegerValue()

Returns the true maximum value as a BigInteger, since it cannot be precisely represented as a double.

getMinValue

public double getMinValue()

compare

@Deprecated
public static final int compare(long a,
 long b)

Deprecated.

Use Long.compareUnsigned(long, long) instead.

createVariable

public UnsignedLongType createVariable()

Description copied from interface: Type

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

Returns:

a new Type variable

copy

public UnsignedLongType copy()

Description copied from interface: Type

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

Returns:

a new Type variable

getRealFloat

public float getRealFloat()

Specified by:

getRealFloat in interface ComplexType<UnsignedLongType>

Overrides:

getRealFloat in class AbstractIntegerType<UnsignedLongType>

getRealDouble

public double getRealDouble()

Specified by:

getRealDouble in interface ComplexType<UnsignedLongType>

Overrides:

getRealDouble in class AbstractIntegerType<UnsignedLongType>

unsignedLongToDouble

static double unsignedLongToDouble(long l)

compareTo

public int compareTo(UnsignedLongType other)

Specified by:

compareTo in interface Comparable<UnsignedLongType>

Overrides:

compareTo in class GenericLongType<UnsignedLongType>