Module com.io7m.jserial.core

Package com.io7m.jserial.core

Interface SerialNumberLongType

All Known Implementing Classes:

SerialNumber32, SerialNumber40, SerialNumber48, SerialNumber56, SerialNumber62

public interface SerialNumberLongType

The type of serial number arithmetic functions that are implemented using 63 bits or fewer.

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.
default long	distanceUnsigned(long s0, long s1)	Calculate the unsigned distance between s0 and s1.
boolean	inRange(long s)	Determine serial number validity.

Method Detail

add

long add(long s0,
         long s1)

Parameters:

s0 - A serial number

s1 - A serial number

Returns:

s0 + s1

bits

int bits()

Returns:

The number of bits used

compare

long compare(long s0,
             long s1)

Compare the serial numbers s0 and s1.

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

distance

long distance(long s0,
              long s1)

Calculate the signed distance between s0 and s1.

Parameters:

s0 - A serial number

s1 - A serial number

Returns:

The distance

distanceUnsigned

default long distanceUnsigned(long s0,
                              long s1)

Calculate the unsigned distance between s0 and s1.

Parameters:

s0 - A serial number

s1 - A serial number

Returns:

The distance

inRange

boolean inRange(long s)

Determine serial number validity.

Parameters:

s - A serial number

Returns:

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