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 Type
    Method
    Description
    int
    add(int s0, int s1)
     
    int
    bits()
     
    int
    compare(int s0, int s1)
    Compare the serial numbers s0 and s1.
    int
    distance(int s0, int s1)
    Calculate the signed distance between s0 and s1.
    default int
    distanceUnsigned(int s0, int s1)
    Calculate the unsigned distance between s0 and s1.
    boolean
    inRange(int s)
    Determine serial number validity.

  • Method Details

    • add

      int add(int s0, int s1)
      Parameters:
      s0 - A serial number
      s1 - 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 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

      int distance(int s0, int s1)
      Calculate the signed distance between s0 and s1.
      Parameters:
      s0 - A serial number
      s1 - A serial number
      Returns:
      The distance

    • distanceUnsigned

      default int distanceUnsigned(int s0, int s1)
      Calculate the unsigned distance between s0 and s1.
      Parameters:
      s0 - A serial number
      s1 - A serial number
      Returns:
      The distance

    • inRange

      boolean inRange(int s)
      Determine serial number validity.
      Parameters:
      s - A serial number
      Returns:
      true iff s0 is in the range [0, (2 ^ bits()) - 1]