note description: "Routines that ought to be in class INTEGER" library: "Gobo Eiffel Kernel Library" copyright: "Copyright (c) 1999-2018, Eric Bezault and others" license: "MIT License" date: "$Date: 2019-02-07 22:54:15 +0000 (Thu, 07 Feb 2019) $" revision: "$Revision: 102807 $" class interface KL_INTEGER_ROUTINES create default_create -- Process instances of classes with no creation clause. -- (Default: do nothing.) -- (from ANY) feature -- Access Any_: KL_ANY_ROUTINES -- Routines that ought to be in class ANY -- (from KL_IMPORTED_ANY_ROUTINES) ensure -- from KL_IMPORTED_ANY_ROUTINES instance_free: class any_routines_not_void: Result /= Void generating_type: TYPE [detachable KL_INTEGER_ROUTINES] -- Type of current object -- (type of which it is a direct instance) -- (from ANY) ensure -- from ANY generating_type_not_void: Result /= Void generator: STRING_8 -- Name of current object's generating class -- (base class of the type of which it is a direct instance) -- (from ANY) ensure -- from ANY generator_not_void: Result /= Void generator_not_empty: not Result.is_empty Platform: KL_PLATFORM -- Platform-dependent properties -- (from KL_SHARED_PLATFORM) ensure -- from KL_SHARED_PLATFORM instance_free: class platform_not_void: Result /= Void String_: KL_STRING_ROUTINES -- Routines that ought to be in class STRING -- (from KL_IMPORTED_STRING_ROUTINES) ensure -- from KL_IMPORTED_STRING_ROUTINES instance_free: class string_routines_not_void: Result /= Void 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) 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) 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) 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)) frozen is_deep_equal (other: KL_INTEGER_ROUTINES): BOOLEAN -- Are Current and other attached to isomorphic object structures? -- (from ANY) require -- from ANY other_not_void: other /= Void 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) is_equal (other: KL_INTEGER_ROUTINES): BOOLEAN -- Is other attached to an object considered -- equal to current object? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY symmetric: Result implies other ~ Current consistent: standard_is_equal (other) implies Result 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) 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)) frozen standard_is_equal (other: KL_INTEGER_ROUTINES): 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 ensure -- from ANY same_type: Result implies same_type (other) symmetric: Result implies other.standard_is_equal (Current) 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 is_even (an_int: INTEGER_32): BOOLEAN -- Is an_int an even integer? ensure instance_free: class definition: Result = (an_int \\ 2 = 0) 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 ensure -- from ANY definition: Result = (conforms_to (other) and other.conforms_to (Current)) feature -- Conversion to_character (an_int: INTEGER_32): CHARACTER_8 -- Character whose code is an_int require an_int_large_enough: an_int >= Platform.Minimum_character_code an_int_small_enough: an_int <= Platform.Maximum_character_code ensure instance_free: class valid_character_code: Result.code = an_int to_decimal (an_int: INTEGER_32): STRING_8 -- Decimal representation of an_int; -- Return a new string at each call. ensure instance_free: class decimal_not_void: Result /= Void is_string: Any_.same_types (Result, "") to_hexadecimal (an_int: INTEGER_32; uppercase: BOOLEAN): STRING_8 -- Hexadecimal representation of an_int; -- Return a new string at each call. require an_int_positive: an_int >= 0 ensure instance_free: class hexadecimal_not_void: Result /= Void is_string: Any_.same_types (Result, "") to_integer (an_int: INTEGER_32): INTEGER_32 -- Return an_int; -- This can be used to force integer manifest constants to -- be of INTEGER type -- some versions of SmartEiffel use -- the smallest possible INTEGER_* type. A manifest array -- can thus be forced to be of type ARRAY [INTEGER]. ensure instance_free: class definition: Result = an_int to_integer_8 (an_int: INTEGER_32): INTEGER_8 -- Convert to INTEGER_8 require an_int_large_enouh: an_int >= -128 an_int_small_enouh: an_int <= 127 ensure instance_free: class to_octal (an_int: INTEGER_32): STRING_8 -- Octal representation of an_int; -- Return a new string at each call. require an_int_positive: an_int >= 0 ensure instance_free: class octal_not_void: Result /= Void is_string: Any_.same_types (Result, "") feature -- Duplication copy (other: KL_INTEGER_ROUTINES) -- 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) ensure -- from ANY is_equal: Current ~ other frozen deep_copy (other: KL_INTEGER_ROUTINES) -- Effect equivalent to that of: -- copy (other . deep_twin) -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY deep_equal: deep_equal (Current, other) frozen deep_twin: KL_INTEGER_ROUTINES -- New object structure recursively duplicated from Current. -- (from ANY) ensure -- from ANY deep_twin_not_void: Result /= Void deep_equal: deep_equal (Current, Result) frozen standard_copy (other: KL_INTEGER_ROUTINES) -- 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) ensure -- from ANY is_standard_equal: standard_is_equal (other) frozen standard_twin: KL_INTEGER_ROUTINES -- New object field-by-field identical to other. -- Always uses default copying semantics. -- (from ANY) ensure -- from ANY standard_twin_not_void: Result /= Void equal: standard_equal (Result, Current) frozen twin: KL_INTEGER_ROUTINES -- New object equal to Current -- twin calls copy; to change copying/twinning semantics, redefine copy. -- (from ANY) ensure -- from ANY twin_not_void: Result /= Void is_equal: Result ~ Current feature -- Basic operations frozen default: detachable KL_INTEGER_ROUTINES -- Default value of object's type -- (from ANY) frozen default_pointer: POINTER -- Default value of type POINTER -- (Avoid the need to write p.default for -- some p of type POINTER.) -- (from ANY) ensure -- from ANY instance_free: class default_rescue -- Process exception for routines with no Rescue clause. -- (Default: do nothing.) -- (from ANY) frozen do_nothing -- Execute a null action. -- (from ANY) ensure -- from ANY instance_free: class feature -- Operation(s) bit_and (m, n: INTEGER_32): INTEGER_32 -- Bitwise 'and' between m and n ensure instance_free: class bit_not (n: INTEGER_32): INTEGER_32 -- Bitwise 'not' of n ensure instance_free: class bit_or (m, n: INTEGER_32): INTEGER_32 -- Bitwise 'or' between m and n ensure instance_free: class bit_shift_left (m, n: INTEGER_32): INTEGER_32 -- m shifted n bits to left; -- Note: The new bits added on the right are 0. require thirty_two_bit_shift: 0 <= n and n < 32 ensure instance_free: class bit_shift_right (m, n: INTEGER_32): INTEGER_32 -- m shifted n bits to right; -- Note: If the first bit of m is set (i.e. the sign bit), then -- the new bits added on the left are 1; otherwise they are 0. require thirty_two_bit_shift: 0 <= n and n < 32 ensure instance_free: class bit_xor (m, n: INTEGER_32): INTEGER_32 -- Bitwise 'xor' between m and n ensure instance_free: class div (x, n: INTEGER_32): INTEGER_32 -- Integer division of x by n -- (Use ISO C99 specification) require divisible: n /= 0 overflow: x = Platform.Minimum_integer implies n /= -1 ensure instance_free: class definition: Result * n + mod (x, n) = x mod (x, n: INTEGER_32): INTEGER_32 -- Reminder of the integer division of x by n -- (Use ISO C99 specification) require divisible: n /= 0 ensure instance_free: class definition1: n /= Platform.Minimum_integer implies Result.abs < n.abs definition2: n = Platform.Minimum_integer implies Result.abs <= Platform.Maximum_integer iso_c99: Result /= 0 implies Result.sign = x.sign power (x, n: INTEGER_32): INTEGER_32 -- Integer x to the power of n (x ^ n) require positive_n: n >= 0 ensure instance_free: class zero_power_n: x = 0 and n /= 0 implies Result = 0 x_power_0: n = 0 implies Result = 1 recursive_definition: n > 0 implies (Result = x * power (x, n - 1)) feature -- Output append_decimal_integer (an_int: INTEGER_32; a_string: STRING_8) -- Append decimal representation of an_int to a_string. -- Note: works even when a_string is a UC_STRING. require a_string_not_void: a_string /= Void ensure instance_free: class append_hexadecimal_integer (an_int: INTEGER_32; a_string: STRING_8; uppercase: BOOLEAN) -- Append a hexadecimal representation of an_int to a_string. -- Note: works even when a_string is a UC_STRING. require an_int_positive: an_int >= 0 a_string_not_void: a_string /= Void ensure instance_free: class append_octal_integer (an_int: INTEGER_32; a_string: STRING_8) -- Append octal representation of an_int to a_string. -- Note: works even when a_string is a UC_STRING. require an_int_positive: an_int >= 0 a_string_not_void: a_string /= Void ensure instance_free: class Io: STD_FILES -- Handle to standard file setup -- (from ANY) ensure -- from ANY instance_free: class io_not_void: Result /= Void out: STRING_8 -- New string containing terse printable representation -- of current object -- (from ANY) ensure -- from ANY out_not_void: Result /= Void print (o: detachable ANY) -- Write terse external representation of o -- on standard output. -- (from ANY) ensure -- from ANY instance_free: class frozen tagged_out: STRING_8 -- New string containing terse printable representation -- of current object -- (from ANY) ensure -- from ANY tagged_out_not_void: Result /= Void feature -- Platform Operating_environment: OPERATING_ENVIRONMENT -- Objects available from the operating system -- (from ANY) ensure -- from ANY instance_free: class operating_environment_not_void: Result /= Void invariant -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) end -- class KL_INTEGER_ROUTINES
Generated by ISE EiffelStudio