+
Point of view
All features
deferred class INTEGRAL
Summary
top
General integer abstraction for both integers and naturals.
Direct parents
Inherit list: COMPARABLE
Insert list: NUMERIC, PLATFORM
Known children
Inherit list: INTEGER_GENERAL
Overview
top
Features
{ANY}
Conversions:
{ANY}
Bitwise Logical Operators:
{ANY}
  • bit_test (idx: INTEGER_8): BOOLEAN
    The value of the idx-ith bit (the right-most bit is at index 0).
  • bit_set (idx: INTEGER_8): INTEGRAL
    The value of the idx-ith bit (the right-most bit is at index 0).
  • bit_reset (idx: INTEGER_8): INTEGRAL
    The value of the idx-ith bit (the right-most bit is at index 0).
  • infix "|>>" (s: INTEGER_8): INTEGRAL
    Shift by s positions right (sign bit copied) bits falling off the end are lost.
  • bit_shift_right (s: INTEGER_8): INTEGRAL
    Shift by s positions right (sign bit copied) bits falling off the end are lost.
  • infix "|>>>" (s: INTEGER_8): INTEGRAL
    Shift by s positions right (sign bit not copied) bits falling off the end are lost.
  • bit_shift_right_unsigned (s: INTEGER_8): INTEGRAL
    Shift by s positions right (sign bit not copied) bits falling off the end are lost.
  • infix "|<<" (s: INTEGER_8): INTEGRAL
    Shift by s positions left bits falling off the end are lost.
  • bit_shift_left (s: INTEGER_8): INTEGRAL
    Shift by s positions left bits falling off the end are lost.
  • infix "#>>" (s: INTEGER_8): INTEGRAL
    Rotate by s positions right.
  • bit_rotate_right (s: INTEGER_8): INTEGRAL
    Rotate by s positions right.
  • infix "#<<" (s: INTEGER_8): INTEGRAL
    Rotate by s positions left.
  • bit_rotate_left (s: INTEGER_8): INTEGRAL
    Rotate by s positions left.
  • bit_rotate (s: INTEGER_8): INTEGRAL
    Rotate by s positions (positive s shifts right, negative left
  • prefix "~": INTEGRAL
    One's complement of Current.
  • bit_not: INTEGRAL
    One's complement of Current.
  • infix "&" (other: INTEGRAL): INTEGRAL
    Bitwise logical and of Current with other.
  • bit_and (other: INTEGRAL): INTEGRAL
    Bitwise logical and of Current with other.
  • infix "|" (other: INTEGRAL): INTEGRAL
    Bitwise logical inclusive or of Current with other.
  • bit_or (other: INTEGRAL): INTEGRAL
    Bitwise logical inclusive or of Current with other.
  • bit_xor (other: INTEGRAL): INTEGRAL
    Bitwise logical exclusive or of Current with other.
  • bit_shift (s: INTEGER_8): INTEGRAL
    Shift by s positions (positive s shifts right (sign bit copied), negative shifts left bits falling off the end are lost).
  • bit_shift_unsigned (s: INTEGER_8): INTEGRAL
    Shift by s positions (positive s shifts right (sign bit not copied), negative left bits falling off the end are lost).
Miscellaneous:
{ANY}
Modular arithmetic (these wrap around on overflow)
{ANY}
  • infix "#+" (other: INTEGRAL): INTEGRAL
  • prefix "#-": INTEGRAL
  • infix "#-" (other: INTEGRAL): INTEGRAL
  • infix "#*" (other: INTEGRAL): INTEGRAL
  • infix "#//" (other: INTEGRAL): INTEGRAL
    Integer division of Current by other.
  • infix "#\\" (other: INTEGRAL): INTEGRAL
    Remainder of the integer division of Current by other.
{}
{ANY}
  • is_equal (other: INTEGRAL): BOOLEAN
    Is other attached to an object considered equal to current object?
  • in_range (lower: INTEGRAL, upper: INTEGRAL): BOOLEAN
    Return True if Current is in range [lower..upper]
    See also min, max, compare.
  • compare (other: INTEGRAL): INTEGER_32
    If current object equal to other, 0 if smaller, -1; if greater, 1.
  • three_way_comparison (other: INTEGRAL): INTEGER_32
    If current object equal to other, 0 if smaller, -1; if greater, 1.
  • min (other: INTEGRAL): INTEGRAL
    Minimum of Current and other.
  • max (other: INTEGRAL): INTEGRAL
    Maximum of Current and other.
  • bounded_by (a_min: INTEGRAL, a_max: INTEGRAL): INTEGRAL
    A value that is equal to Current if it is between the limits set by a_min and a_max.
{ANY}
  • one: INTEGRAL
    Neutral element for "*" and "/".
  • zero: INTEGRAL
    Neutral element for "+" and "-".
{ANY}
Maximum:
{}
Minimum:
{}
Bits:
{}
infix "+" (other: INTEGRAL): INTEGRAL
deferred function
{ANY}
top
Sum with other (commutative).
infix "-" (other: INTEGRAL): INTEGRAL
deferred function
{ANY}
top
Result of subtracting other.
infix "*" (other: INTEGRAL): INTEGRAL
deferred function
{ANY}
top
Product by other.
infix "/" (other: INTEGRAL): REAL_64
deferred function
{ANY}
top
Division by other.
infix "//" (other: INTEGRAL): INTEGRAL
deferred function
{ANY}
top
Quotient of the Euclidian division of Current by other.
infix "\\" (other: INTEGRAL): INTEGRAL
deferred function
{ANY}
top
Remainder of the Euclidian division of Current by other.
infix "^" (exp: INTEGRAL): INTEGER_64
deferred function
{ANY}
top
Integer power of Current by other
abs: INTEGRAL
deferred function
{ANY}
top
Absolute value of Current.
infix "<" (other: INTEGRAL): BOOLEAN
deferred function
{ANY}
top
Is Current strictly less than other?
infix "<=" (other: INTEGRAL): BOOLEAN
deferred function
{ANY}
top
infix ">" (other: INTEGRAL): BOOLEAN
deferred function
{ANY}
top
infix ">=" (other: INTEGRAL): BOOLEAN
deferred function
{ANY}
top
prefix "+": INTEGRAL
deferred function
{ANY}
top
Unary plus of Current.
prefix "-": INTEGRAL
deferred function
{ANY}
top
Unary minus of Current.
is_odd: BOOLEAN
deferred function
{ANY}
top
Is odd?
is_even: BOOLEAN
deferred function
{ANY}
top
Is even?
sqrt: REAL_64
deferred function
{ANY}
top
Square root of Current.
log: REAL_64
deferred function
{ANY}
top
Natural Logarithm of Current.
log10: REAL_64
deferred function
{ANY}
top
Base-10 Logarithm of Current.
gcd (other: INTEGRAL): INTEGRAL
deferred function
{ANY}
top
Greatest Common Divisor of Current and other.
lcm (other: INTEGRAL): INTEGRAL
effective function
{ANY}
top
Least Common Multiple of Current and other.
to_string: STRING
deferred function
{ANY}
top
The decimal view of Current into a new allocated STRING.
to_unicode_string: UNICODE_STRING
deferred function
{ANY}
top
The decimal view of Current into a new allocated UNICODE_STRING.
to_boolean: BOOLEAN
deferred function
{ANY}
top
Return False for 0, otherwise True.
to_number: NUMBER
deferred function
{ANY}
top
Convert Current into a new allocated NUMBER.
append_in (buffer: STRING)
deferred procedure
{ANY}
top
Append in the buffer the equivalent of to_string.
append_in_unicode (buffer: UNICODE_STRING)
deferred procedure
{ANY}
top
Append in the buffer the equivalent of to_unicode_string.
to_string_format (s: INTEGER_32): STRING
deferred function
{ANY}
top
Same as to_string but the result is on s character and the number is right aligned.
to_unicode_string_format (s: INTEGER_32): UNICODE_STRING
deferred function
{ANY}
top
Same as to_unicode_string but the result is on s character and the number is right aligned.
append_in_format (buffer: STRING, s: INTEGER_32)
deferred procedure
{ANY}
top
Append in the buffer the equivalent of to_string_format.
append_in_unicode_format (buffer: UNICODE_STRING, s: INTEGER_32)
deferred procedure
{ANY}
top
Append in the buffer the equivalent of to_unicode_string_format.
digit: CHARACTER
deferred function
{ANY}
top
Legacy synonym for decimal_digit.
is_decimal_digit: BOOLEAN
deferred function
{ANY}
top
decimal_digit: CHARACTER
deferred function
{ANY}
top
Gives the corresponding CHARACTER for range 0..9.
is_hexadecimal_digit: BOOLEAN
deferred function
{ANY}
top
hexadecimal_digit: CHARACTER
deferred function
{ANY}
top
Gives the corresponding CHARACTER for range 0..15.
to_character: CHARACTER
deferred function
{ANY}
top
Return the corresponding ASCII character.
to_octal_in (buffer: STRING)
deferred procedure
{ANY}
top
Append in the buffer the equivalent of to_octal.
to_octal: STRING
deferred function
{ANY}
top
The octal view of Current into a new allocated STRING.
to_hexadecimal: STRING
deferred function
{ANY}
top
The hexadecimal view of Current into a new allocated STRING.
to_hexadecimal_in (buffer: STRING)
deferred procedure
{ANY}
top
Append in the buffer the equivalent of to_hexadecimal.
bit_test (idx: INTEGER_8): BOOLEAN
deferred function
{ANY}
top
The value of the idx-ith bit (the right-most bit is at index 0).
bit_set (idx: INTEGER_8): INTEGRAL
deferred function
{ANY}
top
The value of the idx-ith bit (the right-most bit is at index 0).
bit_reset (idx: INTEGER_8): INTEGRAL
deferred function
{ANY}
top
The value of the idx-ith bit (the right-most bit is at index 0).
infix "|>>" (s: INTEGER_8): INTEGRAL
deferred function
{ANY}
top
Shift by s positions right (sign bit copied) bits falling off the end are lost.
bit_shift_right (s: INTEGER_8): INTEGRAL
deferred function
{ANY}
top
Shift by s positions right (sign bit copied) bits falling off the end are lost.
infix "|>>>" (s: INTEGER_8): INTEGRAL
deferred function
{ANY}
top
Shift by s positions right (sign bit not copied) bits falling off the end are lost.
bit_shift_right_unsigned (s: INTEGER_8): INTEGRAL
deferred function
{ANY}
top
Shift by s positions right (sign bit not copied) bits falling off the end are lost.
infix "|<<" (s: INTEGER_8): INTEGRAL
deferred function
{ANY}
top
Shift by s positions left bits falling off the end are lost.
bit_shift_left (s: INTEGER_8): INTEGRAL
deferred function
{ANY}
top
Shift by s positions left bits falling off the end are lost.
infix "#>>" (s: INTEGER_8): INTEGRAL
deferred function
{ANY}
top
Rotate by s positions right.
bit_rotate_right (s: INTEGER_8): INTEGRAL
deferred function
{ANY}
top
Rotate by s positions right.
infix "#<<" (s: INTEGER_8): INTEGRAL
deferred function
{ANY}
top
Rotate by s positions left.
bit_rotate_left (s: INTEGER_8): INTEGRAL
deferred function
{ANY}
top
Rotate by s positions left.
bit_rotate (s: INTEGER_8): INTEGRAL
deferred function
{ANY}
top
Rotate by s positions (positive s shifts right, negative left
See also bit_rotate_right and bit_rotate_left.
prefix "~": INTEGRAL
deferred function
{ANY}
top
One's complement of Current.
bit_not: INTEGRAL
deferred function
{ANY}
top
One's complement of Current.
infix "&" (other: INTEGRAL): INTEGRAL
deferred function
{ANY}
top
Bitwise logical and of Current with other.
bit_and (other: INTEGRAL): INTEGRAL
deferred function
{ANY}
top
Bitwise logical and of Current with other.
infix "|" (other: INTEGRAL): INTEGRAL
deferred function
{ANY}
top
Bitwise logical inclusive or of Current with other.
bit_or (other: INTEGRAL): INTEGRAL
deferred function
{ANY}
top
Bitwise logical inclusive or of Current with other.
bit_xor (other: INTEGRAL): INTEGRAL
deferred function
{ANY}
top
Bitwise logical exclusive or of Current with other.
bit_shift (s: INTEGER_8): INTEGRAL
deferred function
{ANY}
top
Shift by s positions (positive s shifts right (sign bit copied), negative shifts left bits falling off the end are lost).
bit_shift_unsigned (s: INTEGER_8): INTEGRAL
deferred function
{ANY}
top
Shift by s positions (positive s shifts right (sign bit not copied), negative left bits falling off the end are lost).
sign: INTEGER_8
deferred function
{ANY}
top
Sign of Current (0 or -1 or 1).
divisible (other: INTEGRAL): BOOLEAN
deferred function
{ANY}
top
May Current be divided by other ?
is_a_power_of_2: BOOLEAN
deferred function
{ANY}
top
Is Current a power of 2?
infix "#+" (other: INTEGRAL): INTEGRAL
deferred function
{ANY}
top
prefix "#-": INTEGRAL
deferred function
{ANY}
top
infix "#-" (other: INTEGRAL): INTEGRAL
deferred function
{ANY}
top
infix "#*" (other: INTEGRAL): INTEGRAL
deferred function
{ANY}
top
infix "#//" (other: INTEGRAL): INTEGRAL
deferred function
{ANY}
top
Integer division of Current by other.
infix "#\\" (other: INTEGRAL): INTEGRAL
deferred function
{ANY}
top
Remainder of the integer division of Current by other.
bit_count: INTEGER_8
deferred function
{}
top
Well, it is 8 for INTEGER_8, 16 for INTEGER_16 and so on.
is_equal (other: INTEGRAL): BOOLEAN
effective function
{ANY}
top
Is other attached to an object considered equal to current object?
in_range (lower: INTEGRAL, upper: INTEGRAL): BOOLEAN
effective function
{ANY}
top
Return True if Current is in range [lower..upper]
See also min, max, compare.
compare (other: INTEGRAL): INTEGER_32
effective function
{ANY}
top
If current object equal to other, 0 if smaller, -1; if greater, 1.
three_way_comparison (other: INTEGRAL): INTEGER_32
effective function
{ANY}
top
If current object equal to other, 0 if smaller, -1; if greater, 1.
min (other: INTEGRAL): INTEGRAL
effective function
{ANY}
top
Minimum of Current and other.
max (other: INTEGRAL): INTEGRAL
effective function
{ANY}
top
Maximum of Current and other.
bounded_by (a_min: INTEGRAL, a_max: INTEGRAL): INTEGRAL
effective function
{ANY}
top
A value that is equal to Current if it is between the limits set by a_min and a_max.
one: INTEGRAL
deferred function
{ANY}
top
Neutral element for "*" and "/".
zero: INTEGRAL
deferred function
{ANY}
top
Neutral element for "+" and "-".
hash_code: INTEGER_32
deferred function
{ANY}
top
The hash-code value of Current.
Maximum_character_code: INTEGER_16
{}
top
Largest supported code for CHARACTER values.
Maximum_integer_8: INTEGER_8
is 127
constant attribute
{}
top
Largest supported value of type INTEGER_8.
Maximum_integer_16: INTEGER_16
is 32767
constant attribute
{}
top
Largest supported value of type INTEGER_16.
Maximum_integer: INTEGER_32
is 2147483647
constant attribute
{}
top
Largest supported value of type INTEGER/INTEGER_32.
Maximum_integer_32: INTEGER_32
is 2147483647
constant attribute
{}
top
Largest supported value of type INTEGER/INTEGER_32.
Maximum_integer_64: INTEGER_64
is 9223372036854775807
constant attribute
{}
top
Largest supported value of type INTEGER_64.
Maximum_real_32: REAL_32
is {REAL_32 3.4028234663852885981170418348451692544e+38}
constant attribute
{}
top
Largest non-special (no NaNs nor infinity) supported value of type REAL_32.
Maximum_real: REAL_64
{}
top
Largest non-special (no NaNs nor infinity) supported value of type REAL.
Maximum_real_64: REAL_64
{}
top
Largest non-special (no NaNs nor infinity) supported value of type REAL.
Maximum_real_80: REAL_EXTENDED
{}
top
Largest supported value of type REAL_80.
Minimum_character_code: INTEGER_16
{}
top
Smallest supported code for CHARACTER values.
Minimum_integer_8: INTEGER_8
is -128
constant attribute
{}
top
Smallest supported value of type INTEGER_8.
Minimum_integer_16: INTEGER_16
is -32768
constant attribute
{}
top
Smallest supported value of type INTEGER_16.
Minimum_integer: INTEGER_32
is -2147483648
constant attribute
{}
top
Smallest supported value of type INTEGER/INTEGER_32.
Minimum_integer_32: INTEGER_32
is -2147483648
constant attribute
{}
top
Smallest supported value of type INTEGER/INTEGER_32.
Minimum_integer_64: INTEGER_64
is -9223372036854775808
constant attribute
{}
top
Smallest supported value of type INTEGER_64.
Minimum_real_32: REAL_32
is {REAL_32 -3.40282346638528859811704183484516925440e+38}
constant attribute
{}
top
Smallest non-special (no NaNs nor infinity) supported value of type REAL_32.
Minimum_real: REAL_64
{}
top
Smallest non-special (no NaNs nor infinity) supported value of type REAL.
Minimum_real_64: REAL_64
{}
top
Smallest non-special (no NaNs nor infinity) supported value of type REAL.
Minimum_real_80: REAL_64
{}
top
Smallest supported value of type REAL_80.
Boolean_bits: INTEGER_32
{}
top
Number of bits in a value of type BOOLEAN.
Character_bits: INTEGER_32
{}
top
Number of bits in a value of type CHARACTER.
Integer_bits: INTEGER_32
{}
top
Number of bits in a value of type INTEGER.
Real_bits: INTEGER_32
is 64
constant attribute
{}
top
Number of bits in a value of type REAL.
Pointer_bits: INTEGER_32
{}
top
Number of bits in a value of type POINTER.