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, SetOne, SetZero, Sub<UnsignedLongType>, ValueEquals<UnsignedLongType>, Type<UnsignedLongType>

public class UnsignedLongType extends GenericLongType<UnsignedLongType>

TODO

Author:: Stephan Preibisch, Stephan Saalfeld, Albert Cardona, Mark Hiner

Field Summary

Fields inherited from class net.imglib2.type.numeric.integer.GenericLongType
dataAccess, 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)

int

compareTo(UnsignedLongType c)

UnsignedLongType

copy()

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

NativeImg<UnsignedLongType,? extends LongAccess>

createSuitableNativeImg(NativeImgFactory<UnsignedLongType> storageFactory, long[] dim)

The NativeType creates the NativeImg used for storing image data; based on the given storage strategy and its size.

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.

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()

int

hashCode()

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

setZero()

void

sub(UnsignedLongType c)

String

toString()

Methods inherited from class net.imglib2.type.numeric.integer.GenericLongType
decIndex, decIndex, getBitsPerPixel, getEntitiesPerPixel, getIndex, getLong, getValue, incIndex, incIndex, set, setLong, setValue, updateContainer, updateIndex, valueEquals

Methods inherited from class net.imglib2.type.numeric.integer.AbstractIntegerType
getMinIncrement, getRealDouble, getRealFloat, setReal, setReal

Methods inherited from class net.imglib2.type.numeric.real.AbstractRealType
equals, getImaginaryDouble, getImaginaryFloat, getPhaseDouble, getPhaseFloat, getPowerDouble, getPowerFloat, setImaginary, setImaginary

Methods inherited from class net.imglib2.type.numeric.complex.AbstractComplexType
complexConjugate, setComplexNumber, setComplexNumber

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.imglib2.type.numeric.ComplexType
complexConjugate, getImaginaryDouble, getImaginaryFloat, getPhaseDouble, getPhaseFloat, getPowerDouble, getPowerFloat, setComplexNumber, setComplexNumber, setImaginary, setImaginary

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
- createSuitableNativeImg
  
  public NativeImg<UnsignedLongType,? extends LongAccess> createSuitableNativeImg(NativeImgFactory<UnsignedLongType> storageFactory, long[] dim)
  
  Description copied from interface: NativeType
  
  The NativeType creates the NativeImg used for storing image data; based on the given storage strategy and its size. It basically only decides here which BasicType it uses (float, int, byte, bit, ...) and how many entities per pixel it needs (e.g. 2 floats per pixel for a complex number). This enables the separation of containers and the basic types.
  
  Parameters:
  
  storageFactory - which storage strategy is used
  
  dim - the dimensions
  
  Returns:
  
  the instantiated NativeImg where only the Type knows the BasicType it contains.
- 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
- 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>
- hashCode
  
  public int hashCode()
  
  Overrides:
  
  hashCode 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)
- 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()
- compareTo
  
  public int compareTo(UnsignedLongType c)
  
  Specified by:
  
  compareTo in interface Comparable<UnsignedLongType>
  
  Overrides:
  
  compareTo in class GenericLongType<UnsignedLongType>
- compare
  
  public static final int compare(long a, long b)
  
  Parameters:
  
  a -
  
  b -
  
  Returns:
  
  -1 if a < b, 0 if a == b, 1 if a > b.
- 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

Class UnsignedLongType

Field Summary

Fields inherited from class net.imglib2.type.numeric.integer.GenericLongType

Constructor Summary

Method Summary

Methods inherited from class net.imglib2.type.numeric.integer.GenericLongType

Methods inherited from class net.imglib2.type.numeric.integer.AbstractIntegerType

Methods inherited from class net.imglib2.type.numeric.real.AbstractRealType

Methods inherited from class net.imglib2.type.numeric.complex.AbstractComplexType

Methods inherited from class java.lang.Object

Methods inherited from interface net.imglib2.type.numeric.ComplexType

Constructor Details

UnsignedLongType

UnsignedLongType

UnsignedLongType

UnsignedLongType

UnsignedLongType

Method Details

createSuitableNativeImg

duplicateTypeOnSameNativeImg

mul

mul

add

div

divide

mul

sub

hashCode

setOne

setZero

inc

dec

toString

get

getBigInteger

set

getInteger

getIntegerLong

setInteger

setInteger

setBigInteger

set

getMaxValue

getMaxBigIntegerValue

getMinValue

compareTo

compare

createVariable

copy