note description: "References to objects containing an integer value coded on 8 bits" library: "Free implementation of ELKS library" status: "See notice at end of class." legal: "See notice at end of class." date: "$Date: 2020-05-19 14:18:09 +0000 (Tue, 19 May 2020) $" revision: "$Revision: 104255 $" class INTEGER_8_REF create default_create feature {NONE} -- Initialization default_create -- Process instances of classes with no creation clause. -- (Default: do nothing.) -- (from ANY) do end feature -- Access ascii_char: CHARACTER_8 obsolete "Use to_character_8 instead. [2017-05-31]" -- Returns corresponding ASCII character to item value. require valid_character_code: is_valid_character_8_code do Result := item.to_character_8 end generating_type: TYPE [detachable INTEGER_8_REF] -- Type of current object -- (type of which it is a direct instance) -- (from ANY) external "built_in" ensure -- from ANY generating_type_not_void: Result /= Void end generator: STRING_8 -- Name of current object's generating class -- (base class of the type of which it is a direct instance) -- (from ANY) external "built_in" ensure -- from ANY generator_not_void: Result /= Void generator_not_empty: not Result.is_empty end hash_code: INTEGER_32 -- Hash code value do Result := item.to_integer.hash_code ensure -- from HASHABLE good_hash_value: Result >= 0 end item: INTEGER_8 -- Integer value Max_value: INTEGER_8 = 127 -- Minimum and Maximum value hold in item. Min_value: INTEGER_8 = -128 one: like Current -- Neutral element for "*" and "/" do create Result; Result.set_item (1) ensure -- from NUMERIC result_exists: Result /= Void end sign: INTEGER_8 -- Sign value (0, -1 or 1) do if item > 0 then Result := 1 elseif item < 0 then Result := -1 end ensure three_way: Result.to_integer_32 = three_way_comparison (zero) end zero: like Current -- Neutral element for "+" and "-" do create Result; Result.set_item (0) ensure -- from NUMERIC result_exists: Result /= Void end feature -- Comparison frozen deep_equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void -- or attached to isomorphic object structures? -- (from ANY) do if a = Void then Result := b = Void else Result := b /= Void and then a.is_deep_equal (b) end ensure -- from ANY instance_free: class shallow_implies_deep: standard_equal (a, b) implies Result both_or_none_void: (a = Void) implies (Result = (b = Void)) same_type: (Result and (a /= Void)) implies (b /= Void and then a.same_type (b)) symmetric: Result implies deep_equal (b, a) end frozen equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void or attached -- to objects considered equal? -- (from ANY) do if a = Void then Result := b = Void else Result := b /= Void and then a.is_equal (b) end ensure -- from ANY instance_free: class definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.is_equal (b)) end frozen is_deep_equal alias "≡≡≡" (other: INTEGER_8_REF): BOOLEAN -- Are Current and other attached to isomorphic object structures? -- (from ANY) require -- from ANY other_not_void: other /= Void external "built_in" ensure -- from ANY shallow_implies_deep: standard_is_equal (other) implies Result same_type: Result implies same_type (other) symmetric: Result implies other.is_deep_equal (Current) end is_equal (other: like Current): BOOLEAN -- Is other attached to an object of the same type -- as current object and identical to it? require -- from ANY other_not_void: other /= Void do Result := other.item = item ensure -- from ANY symmetric: Result implies other ~ Current consistent: standard_is_equal (other) implies Result ensure then -- from COMPARABLE trichotomy: Result = (not (Current < other) and not (other < Current)) end is_greater alias ">" (other: INTEGER_8_REF): BOOLEAN -- Is current object greater than other? -- (from COMPARABLE) require -- from PART_COMPARABLE other_exists: other /= Void do Result := other < Current ensure then -- from COMPARABLE definition: Result = (other < Current) end is_greater_equal alias ">=" alias "≥" (other: INTEGER_8_REF): BOOLEAN -- Is current object greater than or equal to other? -- (from COMPARABLE) require -- from PART_COMPARABLE other_exists: other /= Void do Result := not (Current < other) ensure then -- from COMPARABLE definition: Result = (other <= Current) end is_less alias "<" (other: like Current): BOOLEAN -- Is current integer less than other? require -- from PART_COMPARABLE other_exists: other /= Void do Result := item < other.item ensure then -- from COMPARABLE asymmetric: Result implies not (other < Current) end is_less_equal alias "<=" alias "≤" (other: INTEGER_8_REF): BOOLEAN -- Is current object less than or equal to other? -- (from COMPARABLE) require -- from PART_COMPARABLE other_exists: other /= Void do Result := not (other < Current) ensure then -- from COMPARABLE definition: Result = ((Current < other) or (Current ~ other)) end max alias "∨" (other: INTEGER_8_REF): INTEGER_8_REF -- The greater of current object and other -- (from COMPARABLE) require -- from COMPARABLE other_exists: other /= Void do if Current >= other then Result := Current else Result := other end ensure -- from COMPARABLE current_if_not_smaller: Current >= other implies Result = Current other_if_smaller: Current < other implies Result = other end min alias "∧" (other: INTEGER_8_REF): INTEGER_8_REF -- The smaller of current object and other -- (from COMPARABLE) require -- from COMPARABLE other_exists: other /= Void do if Current <= other then Result := Current else Result := other end ensure -- from COMPARABLE current_if_not_greater: Current <= other implies Result = Current other_if_greater: Current > other implies Result = other end frozen standard_equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void or attached to -- field-by-field identical objects of the same type? -- Always uses default object comparison criterion. -- (from ANY) do if a = Void then Result := b = Void else Result := b /= Void and then a.standard_is_equal (b) end ensure -- from ANY instance_free: class definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.standard_is_equal (b)) end frozen standard_is_equal alias "≜" (other: INTEGER_8_REF): BOOLEAN -- Is other attached to an object of the same type -- as current object, and field-by-field identical to it? -- (from ANY) require -- from ANY other_not_void: other /= Void external "built_in" ensure -- from ANY same_type: Result implies same_type (other) symmetric: Result implies other.standard_is_equal (Current) end three_way_comparison alias "⋚" (other: INTEGER_8_REF): INTEGER_32 -- If current object equal to other, 0; -- if smaller, -1; if greater, 1 -- (from COMPARABLE) require -- from COMPARABLE other_exists: other /= Void do if Current < other then Result := -1 elseif other < Current then Result := 1 end ensure -- from COMPARABLE equal_zero: (Result = 0) = (Current ~ other) smaller_negative: (Result = -1) = (Current < other) greater_positive: (Result = 1) = (Current > other) end feature -- Status report conforms_to (other: ANY): BOOLEAN -- Does type of current object conform to type -- of other (as per Eiffel: The Language, chapter 13)? -- (from ANY) require -- from ANY other_not_void: other /= Void external "built_in" end divisible (other: like Current): BOOLEAN -- May current object be divided by other? require -- from NUMERIC other_exists: other /= Void do Result := other.item /= 0 ensure then value: Result = (other.item /= 0) end exponentiable (other: NUMERIC): BOOLEAN -- May current object be elevated to the power other? require -- from NUMERIC other_exists: other /= Void do if attached {INTEGER_32_REF} other as integer_value then Result := integer_value.item >= 0 or item /= 0 elseif attached {REAL_32_REF} other as real_value then Result := real_value.item >= 0.0 or item /= 0 elseif attached {REAL_64_REF} other as double_value then Result := double_value.item >= 0.0 or item /= 0 end ensure then safe_values: ((other.conforms_to (0) and item /= 0) or (other.conforms_to (0.0) and item > 0)) implies Result end is_hashable: BOOLEAN -- May current object be hashed? -- (True if it is not its type's default.) do Result := item /= 0 end is_valid_character_32_code: BOOLEAN -- Does current object represent a CHARACTER_32? do Result := item >= 0 ensure in_bounds: Result = (item >= 0 and item.to_natural_32 >= {CHARACTER_32}.min_value and item.to_natural_32 <= {CHARACTER_32}.max_value) end is_valid_character_8_code: BOOLEAN -- Does current object represent a CHARACTER_8? do Result := item.to_integer_32 >= {CHARACTER_8}.min_value ensure in_bounds: Result = (item.to_integer_32 >= {CHARACTER_8}.min_value and item.to_integer_32 <= {CHARACTER_8}.max_value) end is_valid_character_code: BOOLEAN obsolete "Use `is_valid_character_8_code' instead. [2017-05-31]" -- Does current object represent a CHARACTER_8? do Result := is_valid_character_8_code end same_type (other: ANY): BOOLEAN -- Is type of current object identical to type of other? -- (from ANY) require -- from ANY other_not_void: other /= Void external "built_in" ensure -- from ANY definition: Result = (conforms_to (other) and other.conforms_to (Current)) end feature -- Element change set_item (i: INTEGER_8) -- Make i the item value. do item := i ensure item_set: item = i end feature {NONE} -- Conversion make_from_reference (v: INTEGER_8_REF) -- Initialize Current with v.item. require v_not_void: v /= Void do set_item (v.item) ensure item_set: item = v.item end feature -- Conversion as_integer_16: INTEGER_16 -- Convert item into an INTEGER_16 value. do Result := item.as_integer_16 end as_integer_32: INTEGER_32 -- Convert item into an INTEGER_32 value. do Result := item.as_integer_32 end as_integer_64: INTEGER_64 -- Convert item into an INTEGER_64 value. do Result := item.as_integer_64 end as_integer_8: INTEGER_8 -- Convert item into an INTEGER_8 value. do Result := item.as_integer_8 end as_natural_16: NATURAL_16 -- Convert item into an NATURAL_16 value. do Result := item.as_natural_16 end as_natural_32: NATURAL_32 -- Convert item into an NATURAL_32 value. do Result := item.as_natural_32 end as_natural_64: NATURAL_64 -- Convert item into an NATURAL_64 value. do Result := item.as_natural_64 end as_natural_8: NATURAL_8 -- Convert item into an NATURAL_8 value. do Result := item.as_natural_8 end frozen to_boolean: BOOLEAN -- True if not zero. do Result := item /= 0 end to_character: CHARACTER_8 obsolete "Use `to_character_8' instead. [2017-05-31]" -- Returns corresponding ASCII character to item value. require valid_character: is_valid_character_8_code do Result := item.to_character_8 end to_character_32: CHARACTER_32 -- Associated character in 32 bit version. require valid_character: is_valid_character_32_code do Result := item.to_character_32 end to_character_8: CHARACTER_8 -- Associated character in 8 bit version. require valid_character: is_valid_character_8_code do Result := item.to_character_8 end to_double: REAL_64 -- Convert item into a REAL_64 do Result := item.to_double end to_hex_character: CHARACTER_8 -- Convert item into an hexadecimal character. require in_bounds: 0 <= item.to_integer_32 and item <= 15 local i: INTEGER_32 do i := item.to_integer_32 Result := if i <= 9 then '0' else 'A' - 10 end + i ensure valid_character: ("0123456789ABCDEF").has (Result) end to_hex_string: STRING_8 -- Convert item into an hexadecimal string. local i, val: INTEGER_32 do from i := {PLATFORM}.integer_8_bits // 4 create Result.make_filled ('0', i) val := item.to_integer_32 until i = 0 loop Result.put ((val & 15).to_hex_character, i) val := val |>> 4 i := i - 1 end ensure result_not_void: Result /= Void result_valid_count: Result.count = 2 end frozen to_integer: INTEGER_32 -- Convert item into an INTEGER_32 value. -- Was declared in INTEGER_8_REF as synonym of to_integer_32. do Result := as_integer_32 end frozen to_integer_16: INTEGER_16 -- Convert item into an INTEGER_16 value. do Result := as_integer_16 end frozen to_integer_32: INTEGER_32 -- Convert item into an INTEGER_32 value. -- Was declared in INTEGER_8_REF as synonym of to_integer. do Result := as_integer_32 end frozen to_integer_64: INTEGER_64 -- Convert item into an INTEGER_64 value. do Result := as_integer_64 end frozen to_integer_8: INTEGER_8 -- Return item. do Result := item end frozen to_natural_16: NATURAL_16 -- Convert item into an NATURAL_16 value. require item_non_negative: item >= 0 do Result := as_natural_16 end frozen to_natural_32: NATURAL_32 -- Convert item into an NATURAL_32 value. require item_non_negative: item >= 0 do Result := as_natural_32 end frozen to_natural_64: NATURAL_64 -- Convert item into an NATURAL_64 value. require item_non_negative: item >= 0 do Result := as_natural_64 end frozen to_natural_8: NATURAL_8 -- Convert item into an NATURAL_8 value. require item_non_negative: item >= 0 do Result := as_natural_8 end to_real: REAL_32 -- Convert item into a REAL_32 do Result := item.to_real end to_reference: INTEGER_8_REF -- Associated reference of Current do create Result; Result.set_item (item) ensure to_reference_not_void: Result /= Void end feature -- Duplication frozen clone (other: detachable ANY): like other obsolete "Use `twin' instead. [2017-05-31]" -- Void if other is void; otherwise new object -- equal to other -- -- For non-void other, clone calls copy; -- to change copying/cloning semantics, redefine copy. -- (from ANY) do if other /= Void then Result := other.twin end ensure -- from ANY instance_free: class equal: Result ~ other end copy (other: INTEGER_8_REF) -- Update current object using fields of object attached -- to other, so as to yield equal objects. -- (from ANY) require -- from ANY other_not_void: other /= Void type_identity: same_type (other) external "built_in" ensure -- from ANY is_equal: Current ~ other end frozen deep_clone (other: detachable ANY): like other obsolete "Use `deep_twin' instead. [2017-05-31]" -- Void if other is void: otherwise, new object structure -- recursively duplicated from the one attached to other -- (from ANY) do if other /= Void then Result := other.deep_twin end ensure -- from ANY instance_free: class deep_equal: deep_equal (other, Result) end frozen deep_copy (other: INTEGER_8_REF) -- Effect equivalent to that of: -- copy (other . deep_twin) -- (from ANY) require -- from ANY other_not_void: other /= Void do copy (other.deep_twin) ensure -- from ANY deep_equal: deep_equal (Current, other) end frozen deep_twin: INTEGER_8_REF -- New object structure recursively duplicated from Current. -- (from ANY) external "built_in" ensure -- from ANY deep_twin_not_void: Result /= Void deep_equal: deep_equal (Current, Result) end frozen standard_clone (other: detachable ANY): like other obsolete "Use `standard_twin' instead. [2017-05-31]" -- Void if other is void; otherwise new object -- field-by-field identical to other. -- Always uses default copying semantics. -- (from ANY) do if other /= Void then Result := other.standard_twin end ensure -- from ANY instance_free: class equal: standard_equal (Result, other) end frozen standard_copy (other: INTEGER_8_REF) -- Copy every field of other onto corresponding field -- of current object. -- (from ANY) require -- from ANY other_not_void: other /= Void type_identity: same_type (other) external "built_in" ensure -- from ANY is_standard_equal: standard_is_equal (other) end frozen standard_twin: INTEGER_8_REF -- New object field-by-field identical to other. -- Always uses default copying semantics. -- (from ANY) external "built_in" ensure -- from ANY standard_twin_not_void: Result /= Void equal: standard_equal (Result, Current) end frozen twin: INTEGER_8_REF -- New object equal to Current -- twin calls copy; to change copying/twinning semantics, redefine copy. -- (from ANY) external "built_in" ensure -- from ANY twin_not_void: Result /= Void is_equal: Result ~ Current end feature -- Basic operations abs: INTEGER_8 -- Absolute value do Result := abs_ref.item ensure non_negative: Result >= 0 same_absolute_value: (Result = item) or (Result = - item) end frozen as_attached: attached INTEGER_8_REF obsolete "Remove calls to this feature. [2017-05-31]" -- Attached version of Current. -- (Can be used during transitional period to convert -- non-void-safe classes to void-safe ones.) -- (from ANY) do Result := Current end frozen default: detachable INTEGER_8_REF -- Default value of object's type -- (from ANY) do end frozen default_pointer: POINTER -- Default value of type POINTER -- (Avoid the need to write p.default for -- some p of type POINTER.) -- (from ANY) do ensure -- from ANY instance_free: class end default_rescue -- Process exception for routines with no Rescue clause. -- (Default: do nothing.) -- (from ANY) do end frozen do_nothing -- Execute a null action. -- (from ANY) do ensure -- from ANY instance_free: class end identity alias "+": like Current -- Unary plus do create Result; Result.set_item (+ item) ensure -- from NUMERIC result_exists: Result /= Void end integer_quotient alias "//" (other: like Current): like Current -- Integer division of Current by other require -- from NUMERIC other_exists: other /= Void good_divisor: divisible (other) do create Result; Result.set_item (item // other.item) ensure -- from NUMERIC result_exists: Result /= Void end integer_remainder alias "\\" (other: like Current): like Current -- Remainder of the integer division of Current by other require other_exists: other /= Void good_divisor: divisible (other) do create Result; Result.set_item (item \\ other.item) ensure result_exists: Result /= Void end interval alias "|..|" (other: INTEGER_32): INTEGER_INTERVAL -- Interval from current element to other -- (empty if other less than current integer) do create Result.make (item.to_integer_32, other) end minus alias "-" alias "−" (other: like Current): like Current -- Result of subtracting other require -- from NUMERIC other_exists: other /= Void do create Result; Result.set_item (item - other.item) ensure -- from NUMERIC result_exists: Result /= Void end opposite alias "-" alias "−": like Current -- Unary minus do create Result; Result.set_item (- item) ensure -- from NUMERIC result_exists: Result /= Void end plus alias "+" (other: like Current): like Current -- Sum with other require -- from NUMERIC other_exists: other /= Void do create Result; Result.set_item (item + other.item) ensure -- from NUMERIC result_exists: Result /= Void commutative: Result ~ (other + Current) end power alias "^" (other: REAL_64): REAL_64 -- Integer power of Current by other do Result := item ^ other end product alias "*" alias "×" (other: like Current): like Current -- Product by other require -- from NUMERIC other_exists: other /= Void do create Result; Result.set_item (item * other.item) ensure -- from NUMERIC result_exists: Result /= Void end quotient alias "/" alias "÷" (other: like Current): REAL_64 -- Division by other require other_exists: other /= Void good_divisor: divisible (other) do Result := item / other.item end feature {NONE} -- Implementation abs_ref: like Current -- Absolute value do if item >= 0 then Result := Current else Result := - Current end ensure result_exists: Result /= Void same_absolute_value: (Result ~ Current) or (Result ~ - Current) end feature -- Bit operations bit_and alias "&" alias "⊗" (i: like Current): like Current -- Bitwise and between Current' and i. require i_not_void: i /= Void do create Result; Result.set_item (item.bit_and (i.item)) ensure bitwise_and_not_void: Result /= Void end bit_not alias "⊝": like Current -- One's complement of Current. do create Result; Result.set_item (item.bit_not) ensure bit_not_not_void: Result /= Void end bit_or alias "|" alias "⦶" (i: like Current): like Current -- Bitwise or between Current' and i. require i_not_void: i /= Void do create Result; Result.set_item (item.bit_or (i.item)) ensure bitwise_or_not_void: Result /= Void end frozen bit_shift (n: INTEGER_32): INTEGER_8 -- Shift Current from n position to right if n positive, -- to left otherwise. require n_less_or_equal_to_8: n <= 8 n_greater_or_equal_to_minus_8: n >= -8 do if n > 0 then Result := bit_shift_right (n).item else Result := bit_shift_left (- n).item end end bit_shift_left alias "|<<" alias "⧀" (n: INTEGER_32): like Current -- Shift Current from n position to left. require n_nonnegative: n >= 0 n_less_or_equal_to_8: n <= 8 do create Result; Result.set_item (item.bit_shift_left (n)) ensure bit_shift_left_not_void: Result /= Void end bit_shift_right alias "|>>" alias "⧁" (n: INTEGER_32): like Current -- Shift Current from n position to right. require n_nonnegative: n >= 0 n_less_or_equal_to_8: n <= 8 do create Result; Result.set_item (item.bit_shift_right (n)) ensure bit_shift_right_not_void: Result /= Void end frozen bit_test (n: INTEGER_32): BOOLEAN -- Test n-th position of Current. require n_nonnegative: n >= 0 n_less_than_8: n < 8 do Result := item & ((1).to_integer_8 |<< n) /= 0 end bit_xor alias "⊕" (i: like Current): like Current -- Bitwise xor between Current' and i. require i_not_void: i /= Void do create Result; Result.set_item (item.bit_xor (i.item)) ensure bitwise_xor_not_void: Result /= Void end frozen set_bit (b: BOOLEAN; n: INTEGER_32): INTEGER_8 -- Copy of current with n-th position -- set to 1 if b, 0 otherwise. require n_nonnegative: n >= 0 n_less_than_8: n < 8 do if b then Result := item | ((1).to_integer_8 |<< n) else Result := item & ((1).to_integer_8 |<< n).bit_not end end frozen set_bit_with_mask (b: BOOLEAN; m: INTEGER_8): INTEGER_8 -- Copy of current with all 1 bits of m set to 1 -- if b, 0 otherwise. do if b then Result := item | m else Result := item & m.bit_not end end feature -- Output Io: STD_FILES -- Handle to standard file setup -- (from ANY) once create Result; Result.set_output_default ensure -- from ANY instance_free: class io_not_void: Result /= Void end out: STRING_8 -- Printable representation of integer value require -- from DEBUG_OUTPUT True require -- from ANY True do create Result.make (4); Result.append_integer_8 (item) ensure -- from DEBUG_OUTPUT result_not_void: Result /= Void ensure -- from ANY out_not_void: Result /= Void end print (o: detachable ANY) -- Write terse external representation of o -- on standard output. -- (from ANY) local s: READABLE_STRING_8 do if attached o then s := o.out if attached {READABLE_STRING_32} s as s32 then Io.put_string_32 (s32) elseif attached {READABLE_STRING_8} s as s8 then Io.put_string (s8) else Io.put_string_32 (s.as_string_32) end end ensure -- from ANY instance_free: class end frozen tagged_out: STRING_8 -- New string containing terse printable representation -- of current object -- (from ANY) external "built_in" ensure -- from ANY tagged_out_not_void: Result /= Void end feature -- Platform Operating_environment: OPERATING_ENVIRONMENT -- Objects available from the operating system -- (from ANY) once create Result ensure -- from ANY instance_free: class operating_environment_not_void: Result /= Void end feature {NONE} -- Retrieval frozen internal_correct_mismatch -- Called from runtime to perform a proper dynamic dispatch on correct_mismatch -- from MISMATCH_CORRECTOR. -- (from ANY) local l_msg: STRING_32 l_exc: EXCEPTIONS do if attached {MISMATCH_CORRECTOR} Current as l_corrector then l_corrector.correct_mismatch else create l_msg.make_from_string ("Mismatch: ".as_string_32) create l_exc; l_msg.append (generating_type.name_32); l_exc.raise_retrieval_exception (l_msg) end end invariant sign_times_abs: sign * abs = item -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) -- from COMPARABLE irreflexive_comparison: not (Current < Current) note copyright: "Copyright (c) 1984-2020, Eiffel Software and others" license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)" source: "[ Eiffel Software 5949 Hollister Ave., Goleta, CA 93117 USA Telephone 805-685-1006, Fax 805-685-6869 Website http://www.eiffel.com Customer support http://support.eiffel.com ]" end -- class INTEGER_8_REF
Generated by ISE EiffelStudio