note description: "References to objects containing an unsigned integer value coded on 32 bits." library: "Free implementation of ELKS library" status: "See notice at end of class." legal: "See notice at end of class." date: "$Date: 2018-11-14 14:40:16 +0000 (Wed, 14 Nov 2018) $" revision: "$Revision: 102456 $" class NATURAL_32_REF inherit NUMERIC rename quotient as integer_quotient alias "//", opposite as unapplicable_opposite redefine out, is_equal end COMPARABLE redefine out, is_equal end HASHABLE redefine is_hashable, out, is_equal end create default_create feature -- Access item: NATURAL_32 -- Value. hash_code: INTEGER_32 -- Hash code value. do Result := (item & 2147483647).to_integer_32 end sign: INTEGER_32 -- Sign value (0 or 1). do if item > 0 then Result := 1 end ensure three_way: Result = three_way_comparison (zero) end one: like Current -- Neutral element for "*" and "/". do create Result Result.set_item (1) end zero: like Current -- Neutral element for "+" and "-". do create Result Result.set_item (0) end ascii_char: CHARACTER_8 obsolete "Use `to_character_8' instead. [2017-05-31]" -- ASCII character corresponding to item value. require valid_character_code: is_valid_character_8_code do Result := item.to_character_8 end Min_value: NATURAL_32 = 0 Max_value: NATURAL_32 = 4294967295 -- Minimum and Maximum value hold in item. feature -- Comparison is_less alias "<" (other: like Current): BOOLEAN -- Is current integer less than other? do Result := item < other.item end is_equal (other: like Current): BOOLEAN -- Is other attached to an object of the same type -- as current object and identical to it? do Result := other.item = item end feature -- Element change set_item (i: NATURAL_32) -- Make i the item value. do item := i ensure item_set: item = i end feature -- Status report divisible (other: like Current): BOOLEAN -- May current object be divided by other? 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? 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_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 is_valid_character_8_code: BOOLEAN -- Does current object represent a CHARACTER_8? do Result := item <= {CHARACTER_8}.max_value.to_natural_32 ensure in_bounds: Result = (item >= {CHARACTER_8}.min_value.to_natural_32 and item <= {CHARACTER_8}.max_value.to_natural_32) end is_valid_character_32_code: BOOLEAN -- Does current object represent a CHARACTER_32? do Result := True ensure in_bounds: Result = (item >= {CHARACTER_32}.min_value and item <= {CHARACTER_32}.max_value) end feature -- Basic operations plus alias "+" (other: like Current): like Current -- Sum with other. do create Result Result.set_item (item + other.item) end minus alias "-" (other: like Current): like Current -- Result of subtracting other. do create Result Result.set_item (item - other.item) end product alias "*" (other: like Current): like Current -- Product by other. do create Result Result.set_item (item * other.item) end quotient alias "/" (other: like Current): REAL_64 -- Division by other. require other_exists: other /= Void good_divisor: divisible (other) do Result := item / other.item end identity alias "+": like Current -- Unary plus. do create Result Result.set_item (+ item) end unapplicable_opposite: like Current -- Unary minus. do Result := Current ensure then not_applicable: False end integer_quotient alias "//" (other: like Current): like Current -- Integer division of Current by other. do create Result Result.set_item (item // other.item) 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 power alias "^" (other: REAL_64): REAL_64 -- Integer power of Current by other. do Result := item ^ other end feature {NONE} -- Initialization make_from_reference (v: NATURAL_32_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 to_reference: NATURAL_32_REF -- Associated reference of Current. do create Result Result.set_item (item) ensure to_reference_not_void: Result /= Void end frozen to_boolean: BOOLEAN -- True if not zero. do Result := item /= 0 end as_natural_8: NATURAL_8 -- item converted into a NATURAL_8 value. do Result := item.as_natural_8 end as_natural_16: NATURAL_16 -- item converted into a NATURAL_16 value. do Result := item.as_natural_16 end as_natural_32: NATURAL_32 -- item converted into a NATURAL_32 value. do Result := item.as_natural_32 end as_natural_64: NATURAL_64 -- item converted into a NATURAL_64 value. do Result := item.as_natural_64 end as_integer_8: INTEGER_8 -- item converted into an INTEGER_8 value. do Result := item.as_integer_8 end as_integer_16: INTEGER_16 -- item converted into an INTEGER_16 value. do Result := item.as_integer_16 end as_integer_32: INTEGER_32 -- item converted into an INTEGER_32 value. do Result := item.as_integer_32 end as_integer_64: INTEGER_64 -- item converted into an INTEGER_64 value. do Result := item.as_integer_64 end frozen to_natural_8: NATURAL_8 -- item converted into a NATURAL_8 value. require not_too_big: item <= {NATURAL_8}.max_value.to_natural_32 do Result := as_natural_8 end frozen to_natural_16: NATURAL_16 -- item converted into a NATURAL_16 value. require not_too_big: item <= {NATURAL_16}.max_value.to_natural_32 do Result := as_natural_16 end frozen to_natural_32: NATURAL_32 -- item converted into a NATURAL_32 value. do Result := item end frozen to_natural_64: NATURAL_64 -- item converted into a NATURAL_64 value. do Result := as_natural_64 end frozen to_integer_8: INTEGER_8 -- item converted into an INTEGER_8 value. require not_too_big: item <= {INTEGER_8}.max_value.to_natural_32 do Result := as_integer_8 end frozen to_integer_16: INTEGER_16 -- item converted into an INTEGER_16 value. require not_too_big: item <= {INTEGER_16}.max_value.to_natural_32 do Result := as_integer_16 end frozen to_integer_32: INTEGER_32 -- item converted into an INTEGER_32 value. require not_too_big: item <= {INTEGER_32}.max_value.to_natural_32 do Result := as_integer_32 end frozen to_integer_64: INTEGER_64 -- item converted into an INTEGER_64 value. do Result := as_integer_64 end to_real_32: REAL_32 -- item converted into a REAL_32. do Result := item.to_real_32 end to_real_64: REAL_64 -- item converted into a REAL_64. do Result := item.to_real_64 end to_hex_string: STRING_8 -- item converted into a hexadecimal string. local i: INTEGER_32 val: NATURAL_32 do from i := {PLATFORM}.natural_32_bits // 4 create Result.make_filled ('0', i) val := item 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 = {PLATFORM}.integer_32_bits // 4 end to_hex_character: CHARACTER_8 -- item converted into a hexadecimal character. require in_bounds: 0 <= item 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_character: CHARACTER_8 obsolete "Use `to_character_8' instead. [2017-05-31]" -- ASCII character corresponding to item value. require valid_character: is_valid_character_8_code do Result := item.to_character_8 end to_character_8: CHARACTER_8 -- ASCII character corresponding to item value. require valid_character: is_valid_character_8_code do Result := item.to_character_8 end to_character_32: CHARACTER_32 -- CHARACTER_32 corresponding to item value. require valid_character: is_valid_character_32_code do Result := item.to_character_32 end feature -- Bit operations bit_and 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_or 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 bit_xor (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 bit_not: like Current -- One's complement of Current. do create Result Result.set_item (item.bit_not) ensure bit_not_not_void: Result /= Void end frozen bit_shift (n: INTEGER_32): NATURAL_32 -- Current shifted from n position to right if n positive, -- to left otherwise. require n_less_or_equal_to_32: n <= 32 n_greater_or_equal_to_minus_32: n >= -32 do if n > 0 then Result := bit_shift_right (n).item else Result := bit_shift_left (- n).item end end bit_shift_left alias "|<<" (n: INTEGER_32): like Current -- Current shifted from n position to left. require n_nonnegative: n >= 0 n_less_or_equal_to_32: n <= 32 do create Result Result.set_item (item.bit_shift_left (n)) ensure bit_shift_left_not_void: Result /= Void end bit_shift_right alias "|>>" (n: INTEGER_32): like Current -- Current shifted from n position to right. require n_nonnegative: n >= 0 n_less_or_equal_to_32: n <= 32 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_32: n < 32 do Result := item & ((1).to_natural_32 |<< n) /= 0 end frozen set_bit (b: BOOLEAN; n: INTEGER_32): NATURAL_32 -- Copy of current with n-th position -- set to 1 if b, 0 otherwise. require n_nonnegative: n >= 0 n_less_than_32: n < 32 do if b then Result := item | ((1).to_natural_32 |<< n) else Result := item & ((1).to_natural_32 |<< n).bit_not end end frozen set_bit_with_mask (b: BOOLEAN; m: NATURAL_32): NATURAL_32 -- 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 out: STRING_8 -- Printable representation of value. do create Result.make (20) Result.append_natural_32 (item) end note copyright: "Copyright (c) 1984-2018, 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 NATURAL_32_REF
Generated by ISE EiffelStudio