note description: "SET data structure for both specification and implementation." author: "JSO and JW" class SET [G -> attached ANY] create make_empty, make_from_array, make_one convert make_from_array ({ARRAY [G]}), as_array: {ARRAY [G]} feature {NONE} -- Initialization default_create -- Process instances of classes with no creation clause. -- (Default: do nothing.) -- (from ANY) do end feature -- Access generating_type: TYPE [detachable SET [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 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: SET [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 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: SET [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 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 -- 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: SET [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: SET [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: SET [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: SET [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: SET [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: SET [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 SET [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 SET [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 {SET} -- Implementation imp: ARRAYED_LIST [G] item_imp: detachable CELL [G] set_imp (other_imp: like imp) do imp := other_imp if not imp.object_comparison then imp.compare_objects end end Void_item once item_imp := Void end feature -- Commands for implementation difference (other: like Current) -- Subtract the current set by 'other'. do across other as it loop subtract (it.item) end Void_item ensure definition: old Current.deep_twin ~ Current |\/| (old Current.deep_twin |/\| other) end extend (g: G) -- Extend the current set by 'g'. do if not has (g) then imp.extend (g) end Void_item ensure case_of_no_extension: (old Current.deep_twin).has (g) implies old Current.deep_twin ~ Current case_of_extension: not (old Current.deep_twin).has (g) implies old Current.deep_twin ~ Current - g end intersect (other: like Current) -- Intersect current set with 'other'. do from imp.start until imp.after loop if not other.has (imp.item) then imp.remove else imp.forth end end Void_item ensure Current |<: old Current.deep_twin Current |<: other definition: hold_count (agent in_both_set (?, old Current.deep_twin, other)) = count end subtract (g: G) -- Subtract the current set by 'g'. do from imp.start until imp.after loop if imp.item ~ g then imp.remove else imp.forth end end Void_item ensure case_of_subtraction: (old Current.deep_twin).has (g) implies old Current.deep_twin ~ Current + g case_of_no_subtraction: not (old Current.deep_twin).has (g) implies old Current.deep_twin ~ Current end union (other: like Current) -- Extend the current set by 'other'. do across other as it loop extend (it.item) end Void_item ensure old Current.deep_twin |<: Current other |<: Current definition: hold_count (agent in_either_set (?, old Current.deep_twin, other)) = count end feature -- Constructor make_empty -- Initialize an empty set. do create imp.make (0) imp.compare_objects ensure is_empty end make_from_array (a: ARRAY [G]) do make_empty across a as it loop extend (it.item) end imp.compare_objects ensure all_items_are_intended: across Current as it all a.has (it.item) end all_intended_items_added: across a as it all Current.has (it.item) end end make_one (a_singleton: G) -- make a singleton set do make_empty extend (a_singleton) ensure count = 1 has (a_singleton) end feature -- Conversion to array. -- as_array: ARRAY[G] -- do -- create Result.make_empty -- across -- Current as c -- loop -- Result.force (c.item, Result.upper + 1) -- end ---- Result.compare_objects -- ensure -- Current ~ create {SET[G]}.make_from_array (Result) -- -- why does this fail in {REL}.t8 -- end as_array: ARRAY [G] do create Result.make_from_array (imp.to_array) Result.compare_objects end feature -- Debug output debug_output: STRING_8 -- String that should be displayed in debugger to represent Current. do Result := out ensure -- from DEBUG_OUTPUT result_not_void: Result /= Void end out: STRING_8 -- New string containing terse printable representation -- of current object local i: INTEGER_32 do create Result.make_empty Result.append ("{ ") from i := imp.Lower until i > imp.upper loop check attached {G} imp [i] as e then Result.append (e.out) end if i < imp.upper then Result.append (", ") end i := i + 1 end Result.append (" }") ensure -- from ANY out_not_void: Result /= Void end feature -- Equality is_equal (other: like Current): BOOLEAN -- Is curren set equal to 'other'? require -- from ANY other_not_void: other /= Void do Result := # Current = # other and then other |<: Current and then Current |<: other ensure -- from ANY symmetric: Result implies other ~ Current consistent: standard_is_equal (other) implies Result ensure then Result = (Current |<: other and then other |<: Current) end feature -- Iteration new_cursor: ITERATION_CURSOR [G] -- Fresh cursor associated with current structure do Result := imp.new_cursor ensure -- from ITERABLE result_attached: Result /= Void 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 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 -- Quantifiers comprehension alias "|" (exp: PREDICATE [G]): like Current -- Largest subset of the current set whose elements satisfy exp -- e.g. for set: MSL_SET[STRING], -- (set | agent {STRING}.has_substring ("xy")) = {g:set | g.has_substring("xy")} local i: INTEGER_32 imp_item: G do create Result.make_empty from i := imp.Lower until i > imp.upper loop imp_item := imp [i] if exp.item ([imp_item]) then Result.extend (imp_item) end i := i + 1 end Result.Void_item ensure current_set_unchanged: Current ~ old Current.deep_twin is_subset: Result |<: Current all_satisfying_exp: Result.hold_count (exp) = # Result consistent_satisfying_items: Current.hold_count (exp) = # Result end hold_count (exp: PREDICATE [G]): INTEGER_32 -- How many items satisfying exp are in Current? local i: INTEGER_32 do from i := imp.Lower until i > imp.upper loop if exp.item ([imp [i]]) then Result := Result + 1 end i := i + 1 end ensure current_set_unchanged: Current ~ old Current.deep_twin maximum_result: Result <= count end feature -- Queries for specification. count alias "#": INTEGER_32 -- Return the cardinality of the set. do Result := imp.count ensure current_set_unchanged: Current ~ old Current.deep_twin definition: Result = hold_count (agent g_to_true) end differenced alias "|\" (other: like Current): like Current -- Return a new set representing the difference between Current and 'other'. local new_imp: ARRAYED_LIST [G] do create new_imp.make (0) across imp as src loop if not other.has (src.item) then new_imp.extend (src.item) end end create Result.make_empty Result.set_imp (new_imp) Result.Void_item ensure current_set_unchanged: Current ~ old Current.deep_twin definition: Current ~ Result |\/| (Current |/\| other) end extended alias "+" (g: G): like Current -- Return a new set representing the addtion of current and 'g'. do create Result.make_empty Result.set_imp (Current.imp.twin) Result.extend (g) Result.Void_item ensure current_set_unchanged: Current ~ old Current.deep_twin case_of_no_extension: has (g) implies Current ~ Result case_of_extension: not has (g) implies Current ~ Result - g end has (g: G): BOOLEAN -- Does the set contain 'g'? do Result := (imp.has (g)) ensure current_set_unchanged: Current ~ old Current.deep_twin definition_1: Result = (hold_count (agent eq (?, g)) = 1) definition_2: Result = across Current as it some it.item ~ g end end intersected alias "|/\|" (other: like Current): like Current -- Return a new set representing the intersection of current and 'other'. do create Result.make_empty across other as it loop if has (it.item) then Result.extend (it.item) end end Result.Void_item ensure current_set_unchanged: Current ~ old Current.deep_twin items_from_both_set: across Result as it all Current.has (it.item) and other.has (it.item) end end is_empty: BOOLEAN -- Is the set empty? do Result := (count = 0) ensure current_set_unchanged: Current ~ old Current.deep_twin Result = (# Current = 0) end is_subset_of alias "|<:" (other: like Current): BOOLEAN local i: INTEGER_32 do from Result := True i := imp.Lower until not Result or else i > imp.upper loop Result := other.has (imp [i]) i := i + 1 end ensure current_set_unchanged: Current ~ old Current.deep_twin Result = across Current as cur all other.has (cur.item) end end subtracted alias "-" (g: G): like Current -- Return a new set representing the difference between Current and 'other'. do create Result.make_empty Result.set_imp (Current.imp.twin) Result.subtract (g) Result.Void_item ensure current_set_unchanged: Current ~ old Current.deep_twin case_of_subtraction: has (g) implies Current ~ Result + g case_of_no_subtraction: not has (g) implies Current ~ Result end unioned alias "|\/|" (other: like Current): like Current -- Return a new set representing the union of current and 'other'. do create Result.make_empty Result.set_imp (Current.imp.twin) across other as it loop Result.extend (it.item) end Result.Void_item ensure current_set_unchanged: Current ~ old Current.deep_twin items_from_either_set: across Result as it all Current.has (it.item) or other.has (it.item) end end feature -- Query and command for arbitrary set members choose_item -- Choose an arbitrary element of the -- set and store it in item require not is_empty do create item_imp.put (imp [count]) ensure has (item) chosen end chosen: BOOLEAN do Result := attached item_imp end item: G -- Return an arbitrary member from the set. require not is_empty chosen do check attached item_imp as l_item then Result := l_item.item end ensure has (Result) end remove_item -- Remove an arbitrary member (i.e., 'item') from the set. require not is_empty chosen do imp.go_i_th (count) imp.remove item_imp := Void ensure Current ~ old Current.deep_twin - old item not chosen 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 feature {SET} -- agent functions eq (v1, v2: G): BOOLEAN do Result := v1 ~ v2 end g_to_true (v: G): BOOLEAN do Result := True ensure definition: Result end in_both_set (g: G; s1, s2: SET [G]): BOOLEAN do Result := s1.has (g) and then s2.has (g) end in_either_set (g: G; s1, s2: SET [G]): BOOLEAN do Result := s1.has (g) or else s2.has (g) end invariant imp.object_comparison no_duplicates: across imp.Lower |..| imp.upper as i all across imp.Lower |..| imp.upper as j all imp [i.item] ~ imp [j.item] implies i.item = j.item end end -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) end -- class SET
Generated by ISE EiffelStudio