Package com.io7m.jserial.core
Interface SerialNumberIntType
- All Known Implementing Classes:
SerialNumber16
,SerialNumber24
,SerialNumber8
public interface SerialNumberIntType
The type of serial number arithmetic functions that are implemented using
31
bits or fewer.-
Method Summary
Modifier and TypeMethodDescriptionint
add
(int s0, int s1) int
bits()
int
compare
(int s0, int s1) Compare the serial numberss0
ands1
.int
distance
(int s0, int s1) Calculate the signed distance betweens0
ands1
.default int
distanceUnsigned
(int s0, int s1) Calculate the unsigned distance betweens0
ands1
.boolean
inRange
(int s) Determine serial number validity.
-
Method Details
-
add
int add(int s0, int s1) - Parameters:
s0
- A serial numbers1
- A serial number- Returns:
s0 + s1
-
bits
int bits()- Returns:
- The number of bits used
-
compare
int compare(int s0, int s1) Compare the serial numberss0
ands1
.- Parameters:
s0
- A serial numbers1
- A serial number- Returns:
0
if the serial numbers are equal, a value less than0
ifs0 < s1
, or a value greater than0
ifs0 > s1
-
distance
int distance(int s0, int s1) Calculate the signed distance betweens0
ands1
.- Parameters:
s0
- A serial numbers1
- A serial number- Returns:
- The distance
-
distanceUnsigned
default int distanceUnsigned(int s0, int s1) Calculate the unsigned distance betweens0
ands1
.- Parameters:
s0
- A serial numbers1
- A serial number- Returns:
- The distance
-
inRange
boolean inRange(int s) Determine serial number validity.- Parameters:
s
- A serial number- Returns:
true
iffs0
is in the range[0, (2 ^ bits()) - 1]
-