UnsignedVariableBitLengthType (ImgLib2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imglib2.type.AbstractBitType<T>
- - net.imglib2.type.AbstractBit64Type<UnsignedVariableBitLengthType>
  - - net.imglib2.type.numeric.integer.UnsignedVariableBitLengthType

All Implemented Interfaces:

Comparable<UnsignedVariableBitLengthType>, NativeType<UnsignedVariableBitLengthType>, ComplexType<UnsignedVariableBitLengthType>, IntegerType<UnsignedVariableBitLengthType>, NumericType<UnsignedVariableBitLengthType>, RealType<UnsignedVariableBitLengthType>, Add<UnsignedVariableBitLengthType>, Div<UnsignedVariableBitLengthType>, Mul<UnsignedVariableBitLengthType>, MulFloatingPoint, Pow<UnsignedVariableBitLengthType>, PowFloatingPoint, SetOne, SetZero, Sub<UnsignedVariableBitLengthType>, ValueEquals<UnsignedVariableBitLengthType>, Type<UnsignedVariableBitLengthType>
```
public class UnsignedVariableBitLengthType
extends AbstractBit64Type<UnsignedVariableBitLengthType>
implements IntegerType<UnsignedVariableBitLengthType>
```
A Type with arbitrary bit depth up to maximum 64 bits. The behavior beyond 64 bits is undefined. The performance of this type is traded off for the gain in memory storage. The set(long) operation takes have the time as the get() operation. The performance may degrade very slightly with increasing bit depth, but the decrease is barely noticeable.

Author:

Albert Cardona, Stephan Preibisch

Field Summary
- Fields inherited from class net.imglib2.type.AbstractBitType
  dataAccess, i, img, nBits

Constructor Summary

Constructors
Constructor and Description
`UnsignedVariableBitLengthType(int nBits)`
`UnsignedVariableBitLengthType(LongAccess access, int nBits)`
`UnsignedVariableBitLengthType(long value, int nBits)`
`UnsignedVariableBitLengthType(NativeImg<?,? extends LongAccess> bitStorage, int nBits)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(UnsignedVariableBitLengthType t)`
`int`	`compareTo(UnsignedVariableBitLengthType t)`
`void`	`complexConjugate()`
`UnsignedVariableBitLengthType`	`copy()` Creates a new `Type` variable that has the value of this `Type`
`UnsignedVariableBitLengthType`	`createVariable()` Creates a new `Type` variable which can only store one value.
`void`	`dec()`
`void`	`div(UnsignedVariableBitLengthType t)`
`UnsignedVariableBitLengthType`	`duplicateTypeOnSameNativeImg()` Creates a new `NativeType` which stores in the same physical array.
`boolean`	`equals(Object obj)`
`long`	`get()`
`BigInteger`	`getBigInteger()`
`int`	`getBitsPerPixel()`
`double`	`getImaginaryDouble()`
`float`	`getImaginaryFloat()`
`int`	`getInteger()`
`long`	`getIntegerLong()`
`double`	`getMaxValue()` The maximum value that can be stored is `Math.pow(2, nBits) -1`.
`double`	`getMinIncrement()`
`double`	`getMinValue()`
`NativeTypeFactory<UnsignedVariableBitLengthType,LongAccess>`	`getNativeTypeFactory()`
`double`	`getPhaseDouble()`
`float`	`getPhaseFloat()`
`double`	`getPowerDouble()`
`float`	`getPowerFloat()`
`double`	`getRealDouble()`
`float`	`getRealFloat()`
`int`	`hashCode()`
`void`	`inc()`
`void`	`mul(double c)`
`void`	`mul(float c)`
`void`	`mul(UnsignedVariableBitLengthType t)`
`void`	`pow(double power)`
`void`	`pow(UnsignedVariableBitLengthType c)`
`void`	`set(long value)`
`void`	`set(UnsignedVariableBitLengthType c)` Sets the value of another `Type`.
`void`	`setBigInteger(BigInteger b)`
`void`	`setComplexNumber(double r, double i)`
`void`	`setComplexNumber(float r, float i)`
`void`	`setImaginary(double complex)`
`void`	`setImaginary(float complex)`
`void`	`setInteger(int f)`
`void`	`setInteger(long f)`
`void`	`setOne()`
`void`	`setReal(double real)`
`void`	`setReal(float real)`
`void`	`setZero()`
`void`	`sub(UnsignedVariableBitLengthType t)`
`String`	`toString()`
`boolean`	`valueEquals(UnsignedVariableBitLengthType t)` Default test at long precision.

Methods inherited from class net.imglib2.type.AbstractBit64Type
getBits, setBits

Methods inherited from class net.imglib2.type.AbstractBitType
getEntitiesPerPixel, index, updateContainer

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

Methods inherited from interface net.imglib2.type.NativeType
decIndex, decIndex, getIndex, incIndex, incIndex, updateIndex

- Constructor Detail
  - UnsignedVariableBitLengthType
```
public UnsignedVariableBitLengthType(NativeImg<?,? extends LongAccess> bitStorage,
                                     int nBits)
```
  - UnsignedVariableBitLengthType
```
public UnsignedVariableBitLengthType(long value,
                                     int nBits)
```
  - UnsignedVariableBitLengthType
```
public UnsignedVariableBitLengthType(LongAccess access,
                                     int nBits)
```
  - UnsignedVariableBitLengthType
```
public UnsignedVariableBitLengthType(int nBits)
```
- Method Detail
  - set
```
public void set(long value)
```
  - get
```
public long get()
```
  - set
```
public void set(UnsignedVariableBitLengthType c)
```
    Description copied from interface: Type
    
    Sets the value of another Type.
    
    Specified by:
    
    set in interface Type<UnsignedVariableBitLengthType>
    
    Parameters:
    
    c - the new value
  - duplicateTypeOnSameNativeImg
```
public UnsignedVariableBitLengthType 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<UnsignedVariableBitLengthType>
    
    Returns:
    
    a new NativeType instance working on the same NativeImg
  - getNativeTypeFactory
```
public NativeTypeFactory<UnsignedVariableBitLengthType,LongAccess> getNativeTypeFactory()
```
    Specified by:
    
    getNativeTypeFactory in interface NativeType<UnsignedVariableBitLengthType>
    
    Specified by:
    
    getNativeTypeFactory in class AbstractBitType<UnsignedVariableBitLengthType>
  - createVariable
```
public UnsignedVariableBitLengthType createVariable()
```
    Description copied from interface: Type
    
    Creates a new Type variable which can only store one value.
    
    Specified by:
    
    createVariable in interface Type<UnsignedVariableBitLengthType>
    
    Returns:
    
    a new Type variable
  - copy
```
public UnsignedVariableBitLengthType copy()
```
    Description copied from interface: Type
    
    Creates a new Type variable that has the value of this Type
    
    Specified by:
    
    copy in interface Type<UnsignedVariableBitLengthType>
    
    Returns:
    
    a new Type variable
  - div
```
public void div(UnsignedVariableBitLengthType t)
```
    Specified by:
    
    div in interface Div<UnsignedVariableBitLengthType>
    
    See Also:
    
    UnsignedLongType.divide(long, long)
  - mul
```
public void mul(float c)
```
    Specified by:
    
    mul in interface MulFloatingPoint
  - mul
```
public void mul(double c)
```
    Specified by:
    
    mul in interface MulFloatingPoint
  - getRealFloat
```
public float getRealFloat()
```
    Specified by:
    
    getRealFloat in interface ComplexType<UnsignedVariableBitLengthType>
  - getRealDouble
```
public double getRealDouble()
```
    Specified by:
    
    getRealDouble in interface ComplexType<UnsignedVariableBitLengthType>
  - setReal
```
public void setReal(float real)
```
    Specified by:
    
    setReal in interface ComplexType<UnsignedVariableBitLengthType>
  - setReal
```
public void setReal(double real)
```
    Specified by:
    
    setReal in interface ComplexType<UnsignedVariableBitLengthType>
  - setZero
```
public void setZero()
```
    Specified by:
    
    setZero in interface SetZero
  - setOne
```
public void setOne()
```
    Specified by:
    
    setOne in interface SetOne
  - getBitsPerPixel
```
public int getBitsPerPixel()
```
    Specified by:
    
    getBitsPerPixel in interface RealType<UnsignedVariableBitLengthType>
  - getMinIncrement
```
public double getMinIncrement()
```
    Specified by:
    
    getMinIncrement in interface RealType<UnsignedVariableBitLengthType>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getInteger
```
public int getInteger()
```
    Specified by:
    
    getInteger in interface IntegerType<UnsignedVariableBitLengthType>
  - getIntegerLong
```
public long getIntegerLong()
```
    Specified by:
    
    getIntegerLong in interface IntegerType<UnsignedVariableBitLengthType>
  - getBigInteger
```
public BigInteger getBigInteger()
```
    Specified by:
    
    getBigInteger in interface IntegerType<UnsignedVariableBitLengthType>
  - setInteger
```
public void setInteger(int f)
```
    Specified by:
    
    setInteger in interface IntegerType<UnsignedVariableBitLengthType>
  - setInteger
```
public void setInteger(long f)
```
    Specified by:
    
    setInteger in interface IntegerType<UnsignedVariableBitLengthType>
  - setBigInteger
```
public void setBigInteger(BigInteger b)
```
    Specified by:
    
    setBigInteger in interface IntegerType<UnsignedVariableBitLengthType>
  - getMaxValue
```
public double getMaxValue()
```
    The maximum value that can be stored is Math.pow(2, nBits) -1.
    
    Specified by:
    
    getMaxValue in interface RealType<UnsignedVariableBitLengthType>
  - getMinValue
```
public double getMinValue()
```
    Specified by:
    
    getMinValue in interface RealType<UnsignedVariableBitLengthType>
  - inc
```
public void inc()
```
    Specified by:
    
    inc in interface RealType<UnsignedVariableBitLengthType>
  - dec
```
public void dec()
```
    Specified by:
    
    dec in interface RealType<UnsignedVariableBitLengthType>
  - add
```
public void add(UnsignedVariableBitLengthType t)
```
    Specified by:
    
    add in interface Add<UnsignedVariableBitLengthType>
  - sub
```
public void sub(UnsignedVariableBitLengthType t)
```
    Specified by:
    
    sub in interface Sub<UnsignedVariableBitLengthType>
  - mul
```
public void mul(UnsignedVariableBitLengthType t)
```
    Specified by:
    
    mul in interface Mul<UnsignedVariableBitLengthType>
  - pow
```
public void pow(UnsignedVariableBitLengthType c)
```
    Specified by:
    
    pow in interface Pow<UnsignedVariableBitLengthType>
  - pow
```
public void pow(double power)
```
    Specified by:
    
    pow in interface PowFloatingPoint
  - getImaginaryFloat
```
public float getImaginaryFloat()
```
    Specified by:
    
    getImaginaryFloat in interface ComplexType<UnsignedVariableBitLengthType>
  - getImaginaryDouble
```
public double getImaginaryDouble()
```
    Specified by:
    
    getImaginaryDouble in interface ComplexType<UnsignedVariableBitLengthType>
  - setImaginary
```
public void setImaginary(float complex)
```
    Specified by:
    
    setImaginary in interface ComplexType<UnsignedVariableBitLengthType>
  - setImaginary
```
public void setImaginary(double complex)
```
    Specified by:
    
    setImaginary in interface ComplexType<UnsignedVariableBitLengthType>
  - getPhaseFloat
```
public float getPhaseFloat()
```
    Specified by:
    
    getPhaseFloat in interface ComplexType<UnsignedVariableBitLengthType>
  - getPhaseDouble
```
public double getPhaseDouble()
```
    Specified by:
    
    getPhaseDouble in interface ComplexType<UnsignedVariableBitLengthType>
  - getPowerFloat
```
public float getPowerFloat()
```
    Specified by:
    
    getPowerFloat in interface ComplexType<UnsignedVariableBitLengthType>
  - getPowerDouble
```
public double getPowerDouble()
```
    Specified by:
    
    getPowerDouble in interface ComplexType<UnsignedVariableBitLengthType>
  - setComplexNumber
```
public void setComplexNumber(float r,
                             float i)
```
    Specified by:
    
    setComplexNumber in interface ComplexType<UnsignedVariableBitLengthType>
  - setComplexNumber
```
public void setComplexNumber(double r,
                             double i)
```
    Specified by:
    
    setComplexNumber in interface ComplexType<UnsignedVariableBitLengthType>
  - complexConjugate
```
public void complexConjugate()
```
    Specified by:
    
    complexConjugate in interface ComplexType<UnsignedVariableBitLengthType>
  - compareTo
```
public int compareTo(UnsignedVariableBitLengthType t)
```
    Specified by:
    
    compareTo in interface Comparable<UnsignedVariableBitLengthType>
  - valueEquals
```
public boolean valueEquals(UnsignedVariableBitLengthType t)
```
    Default test at long precision. Please override for types longer than 64bit.
    
    Specified by:
    
    valueEquals in interface ValueEquals<UnsignedVariableBitLengthType>
    
    Parameters:
    
    t -
    
    Returns:
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class UnsignedVariableBitLengthType

Field Summary

Fields inherited from class net.imglib2.type.AbstractBitType

Constructor Summary

Method Summary

Methods inherited from class net.imglib2.type.AbstractBit64Type

Methods inherited from class net.imglib2.type.AbstractBitType

Methods inherited from class java.lang.Object

Methods inherited from interface net.imglib2.type.NativeType

Constructor Detail

UnsignedVariableBitLengthType

UnsignedVariableBitLengthType

UnsignedVariableBitLengthType

UnsignedVariableBitLengthType

Method Detail

set

get

set

duplicateTypeOnSameNativeImg

getNativeTypeFactory

createVariable

copy

div

mul

mul

getRealFloat

getRealDouble

setReal

setReal

setZero

setOne

getBitsPerPixel

getMinIncrement

toString

getInteger

getIntegerLong

getBigInteger

setInteger

setInteger

setBigInteger

getMaxValue

getMinValue

inc

dec

add

sub

mul

pow

pow

getImaginaryFloat

getImaginaryDouble

setImaginary

setImaginary

getPhaseFloat

getPhaseDouble

getPowerFloat

getPowerDouble

setComplexNumber

setComplexNumber

complexConjugate

compareTo

valueEquals

equals

hashCode