Module com.io7m.jserial.core

Package com.io7m.jserial.core

Class SerialNumber48

java.lang.Object

com.io7m.jserial.core.SerialNumber48

All Implemented Interfaces:

SerialNumberLongType

public final class SerialNumber48
extends Object
implements SerialNumberLongType

An implementation of 48-bit serial number arithmetic.

Method Summary

Modifier and Type	Method	Description
long	add(long s0, long s1)
int	bits()
long	compare(long s0, long s1)	Compare the serial numbers s0 and s1.
long	distance(long s0, long s1)	Calculate the signed distance between s0 and s1.
static SerialNumberLongType	get()
boolean	inRange(long s0)	Determine serial number validity.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.io7m.jserial.core.SerialNumberLongType

distanceUnsigned

Method Detail

get

public static SerialNumberLongType get()

Returns:

A serial number calculator

add

public long add(long s0,
                long s1)

Specified by:

add in interface SerialNumberLongType

Parameters:

s0 - A serial number

s1 - A serial number

Returns:

s0 + s1

bits

public int bits()

Specified by:

bits in interface SerialNumberLongType

Returns:

The number of bits used

distance

public long distance(long s0,
                     long s1)

Description copied from interface: SerialNumberLongType

Calculate the signed distance between s0 and s1.

Specified by:

distance in interface SerialNumberLongType

Parameters:

s0 - A serial number

s1 - A serial number

Returns:

The distance

compare

public long compare(long s0,
                    long s1)

Description copied from interface: SerialNumberLongType

Compare the serial numbers s0 and s1.

Specified by:

compare in interface SerialNumberLongType

Parameters:

s0 - A serial number

s1 - A serial number

Returns:

0 if the serial numbers are equal, a value less than 0 if s0 < s1, or a value greater than 0 if s0 > s1

inRange

public boolean inRange(long s0)

Description copied from interface: SerialNumberLongType

Determine serial number validity.

Specified by:

inRange in interface SerialNumberLongType

Parameters:

s0 - A serial number

Returns:

true iff s0 is in the range [0, (2 ^ bits()) - 1]