note description: "Routines that ought to be in class ARRAY" 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 KL_ARRAY_ROUTINES [G] create default_create feature -- Initialization make_empty_with_lower (min_index: INTEGER_32): ARRAY [G] -- Create an empty array with min_index as lower bound. local l_array: KL_ARRAY [G] do if min_index = 1 then create Result.make_empty else create l_array.make_empty l_array.new_rebase (min_index) create Result.make_from_array (l_array) end ensure instance_free: class array_not_void: Result /= Void lower_set: Result.lower = min_index is_empty: Result.is_empty end make_from_array (an_array: ARRAY [G]; min_index: INTEGER_32): ARRAY [G] -- Create a new array and initialize it -- with items from an_array. require an_array_not_void: an_array /= Void do Result := subarray (an_array, an_array.lower, an_array.upper, min_index) ensure instance_free: class array_not_void: Result /= Void lower_set: Result.lower = min_index count_set: Result.count = an_array.count same_items: across Result.lower |..| Result.upper as i all {KL_TYPE [G]}.same_objects (Result.item (i.item), an_array.item (i.item + an_array.lower - min_index)) end end feature {NONE} -- Initialization default_create -- Process instances of classes with no creation clause. -- (Default: do nothing.) -- (from ANY) do end feature -- Access Any_: KL_ANY_ROUTINES -- Routines that ought to be in class ANY -- (from KL_IMPORTED_ANY_ROUTINES) once create Result ensure -- from KL_IMPORTED_ANY_ROUTINES instance_free: class any_routines_not_void: Result /= Void end generating_type: TYPE [detachable KL_ARRAY_ROUTINES [G]] -- 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 subarray (an_array: ARRAY [G]; start_pos, end_pos, min_index: INTEGER_32): ARRAY [G] -- Array made up of items from an_array within -- bounds start_pos and end_pos -- Reasons why we don't use ARRAY.subarray directly: -- * ELKS ARRAY 2000 returns an 'ARRAY [G]' -- whereas ISE 5.4/5.5 return a 'like Current'. -- * ISE 5.4/5.5 does not allow subarrays of empty array, -- and does not work with empty subarrays. -- * This routine has an extra argument min_index compared -- to the one provided by ELKS and the various compilers. require an_array_not_void: an_array /= Void start_pos_large_enough: start_pos >= an_array.lower end_pos_small_enough: end_pos <= an_array.upper valid_bounds: start_pos <= end_pos + 1 do if end_pos < start_pos then Result := make_empty_with_lower (min_index) else create Result.make_filled (an_array.item (start_pos), min_index, min_index + end_pos - start_pos) subcopy (Result, an_array, start_pos, end_pos, min_index) end ensure instance_free: class array_not_void: Result /= Void lower_set: Result.lower = min_index count_set: Result.count = end_pos - start_pos + 1 same_items: across Result.lower |..| Result.upper as i all {KL_TYPE [G]}.same_objects (Result.item (i.item), an_array.item (i.item + start_pos - min_index)) end 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 (other: KL_ARRAY_ROUTINES [G]): 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: KL_ARRAY_ROUTINES [G]): BOOLEAN -- Is other attached to an object considered -- equal to current object? -- (from ANY) require -- from ANY other_not_void: other /= Void external "built_in" ensure -- from ANY symmetric: Result implies other ~ Current consistent: standard_is_equal (other) implies Result 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 (other: KL_ARRAY_ROUTINES [G]): 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 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 has (an_array: ARRAY [G]; v: G): BOOLEAN -- Does v appear in an_array (use '=' for item comparison). -- Reasons why we don't use ARRAY.has directly: -- * has is not in ELKS ARRAY 2000. -- * ISE may change this behavior with compare_objects. require an_array_not_void: an_array /= Void local i, nb: INTEGER_32 do from i := an_array.lower nb := an_array.upper until i > nb loop if an_array.item (i) = v then Result := True i := nb + 1 else i := i + 1 end end ensure instance_free: class end has_void (a_array: ARRAY [G]): BOOLEAN -- Does 'Void' appear in an_array (use '=' for item comparison). -- Reason why we don't use has (Void) directly: -- * the actual generic parameter may be attached and -- 'Void' would not conform to it. require a_array_not_void: a_array /= Void local i, nb: INTEGER_32 do if attached {ARRAY [detachable G]} a_array as l_array then from i := l_array.lower nb := l_array.upper until i > nb loop if l_array.item (i) = Void then Result := True i := nb + 1 else i := i + 1 end end end ensure instance_free: class 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 subcopy (an_array: ARRAY [G]; other: ARRAY [G]; start_pos, end_pos, index_pos: INTEGER_32) -- Copy items of other within bounds start_pos and end_pos -- to an_array starting at index index_pos. -- Reasons why we don't use ARRAY.subcopy directly: -- * subcopy is not in ELKS ARRAY 2000. require an_array_not_void: an_array /= Void other_not_void: other /= Void not_same: an_array /= other start_pos_large_enough: start_pos >= other.lower end_pos_small_enough: end_pos <= other.upper valid_bounds: start_pos <= end_pos + 1 index_pos_large_enough: index_pos >= an_array.lower enough_space: (an_array.upper - index_pos) >= (end_pos - start_pos) do if start_pos <= end_pos then an_array.subcopy (other, start_pos, end_pos, index_pos) end ensure instance_free: class copied: across 0 |..| (end_pos - start_pos) as i all {KL_TYPE [G]}.same_objects (an_array.item (index_pos + i.item), other.item (start_pos + i.item)) end end feature -- Resizing resize (an_array: ARRAY [G]; min_index, max_index: INTEGER_32) -- Rearrange array so that it can accommodate -- indices down to min_index and up to max_index. -- Do not lose any previously entered item. require an_array_not_void: an_array /= Void valid_min_index: min_index <= an_array.lower valid_max_index: max_index >= an_array.upper has_default: ({G}).has_default do resize_with_default (an_array, ({G}).default, min_index, max_index) ensure instance_free: class lower_set: an_array.lower = min_index upper_set: an_array.upper = max_index end resize_with_default (an_array: ARRAY [G]; a_default_value: G; min_index, max_index: INTEGER_32) -- Rearrange array so that it can accommodate -- indices down to min_index and up to max_index. -- Do not lose any previously entered item. require an_array_not_void: an_array /= Void valid_min_index: min_index <= an_array.lower valid_max_index: max_index >= an_array.upper do if min_index <= max_index then an_array.conservative_resize_with_default (a_default_value, min_index, max_index) end ensure instance_free: class lower_set: an_array.lower = min_index upper_set: an_array.upper = max_index 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 cloned_array (an_array: ARRAY [G]): ARRAY [G] -- Clone of an_array require an_array_not_void: an_array /= Void do Result := an_array.twin ensure instance_free: class cloned_not_void: Result /= Void same_type: Any_.same_types (Result, an_array) is_equal: Result.is_equal (an_array) end copy (other: KL_ARRAY_ROUTINES [G]) -- 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: KL_ARRAY_ROUTINES [G]) -- 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: KL_ARRAY_ROUTINES [G] -- 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: KL_ARRAY_ROUTINES [G]) -- 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: KL_ARRAY_ROUTINES [G] -- 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: KL_ARRAY_ROUTINES [G] -- 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 frozen as_attached: attached KL_ARRAY_ROUTINES [G] 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 KL_ARRAY_ROUTINES [G] -- 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 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 -- New string containing terse printable representation -- of current object -- (from ANY) do Result := tagged_out ensure -- from ANY out_not_void: Result /= Void end print (o: detachable ANY) -- Write terse external representation of o -- on standard output. -- (from ANY) do if o /= Void then Io.put_string (o.out) 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_8 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: ") create l_exc l_msg.append (generating_type.name) l_exc.raise_retrieval_exception (l_msg) end end invariant -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) end -- class KL_ARRAY_ROUTINES
Generated by ISE EiffelStudio