Automatic generation produced by ISE Eiffel

Classes Clusters Cluster hierarchy Chart Relations Flat contracts Go to:
note description: "Sorted sets implemented as binary search trees" library: "Free implementation of ELKS library" legal: "See notice at end of class." status: "See notice at end of class." names: binary_search_tree_set, set, binary_search_tree representation: recursive, array access: membership, min, max contents: generic date: "$Date: 2021-06-18 08:58:32 -0800 (Fri, 18 Jun 2021) $" revision: "$Revision: 105547 $" class interface BINARY_SEARCH_TREE_SET [G -> COMPARABLE] create make -- Create set. make_from_iterable (other: ITERABLE [G]) -- Create a set with all items obtained from other. convert make_from_iterable ({ARRAY [G]}) feature -- Access generating_type: TYPE [detachable BINARY_SEARCH_TREE_SET [G]] -- 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 index_of (v: like item; i: INTEGER_32): INTEGER_32 -- Index of i-th occurrence of v. -- 0 if none. -- (Reference or object equality, -- based on `object_comparison`.) -- (from LINEAR) require -- from LINEAR positive_occurrences: i > 0 ensure -- from LINEAR non_negative_result: Result >= 0 item_for_iteration: G -- Item at current position -- (from LINEAR) require -- from LINEAR not_off: not off occurrences (v: like item): INTEGER_32 -- Number of times v appears. -- (Reference or object equality, -- based on `object_comparison`.) -- (from LINEAR) feature -- Measurement count: INTEGER_32 -- Number of items in tree require -- from SET True item: G -- Current item require -- from TRAVERSABLE not_off: not off require -- from TRAVERSABLE_SUBSET not_off: not off cs_max: like item -- Maximum item -- (from COMPARABLE_STRUCT) require -- from COMPARABLE_STRUCT min_max_available max: like item -- Maximum item in tree require -- from COMPARABLE_SET not_empty: not is_empty min: like item -- Minimum item in tree require -- from COMPARABLE_SET not_empty: not is_empty cs_min: like item -- Minimum item -- (from COMPARABLE_STRUCT) require -- from COMPARABLE_STRUCT min_max_available min_max_available: BOOLEAN -- Can min and max be computed? -- (from COMPARABLE_STRUCT) ensure -- from COMPARABLE_STRUCT Result implies not is_empty 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) disjoint (other: TRAVERSABLE_SUBSET [G]): BOOLEAN -- Do current set and other have no -- items in common? -- (from TRAVERSABLE_SUBSET) require -- from SUBSET set_exists: other /= Void same_rule: object_comparison = other.object_comparison 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 alias "≡≡≡" (other: BINARY_SEARCH_TREE_SET [G]): 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: BINARY_SEARCH_TREE_SET [G]): 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 is_subset alias "" (other: TRAVERSABLE_SUBSET [G]): BOOLEAN -- Is current set a subset of other? -- (from TRAVERSABLE_SUBSET) require -- from SUBSET set_exists: other /= Void same_rule: object_comparison = other.object_comparison is_superset alias "" (other: SUBSET [G]): BOOLEAN -- Is current set a superset of other? -- (from SUBSET) require -- from SUBSET set_exists: other /= Void same_rule: object_comparison = other.object_comparison 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 alias "" (other: BINARY_SEARCH_TREE_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 ensure -- from ANY same_type: Result implies same_type (other) symmetric: Result implies other.standard_is_equal (Current) feature -- Status report after: BOOLEAN -- Is there no valid cursor position to the right of cursor? before: BOOLEAN -- Is there no valid cursor position to the left of cursor? 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 exhausted: BOOLEAN -- Has structure been completely explored? -- (from LINEAR) ensure -- from LINEAR exhausted_when_off: off implies Result Extendible: BOOLEAN = True -- Can new items be added? (Answer: yes.) has alias "" (v: like item): BOOLEAN -- Is there a node with item v in tree? -- (Reference or object equality, -- based on `object_comparison`.) require -- from CONTAINER True ensure -- from CONTAINER not_found_in_empty: Result implies not is_empty is_empty: BOOLEAN -- Is set empty? require -- from CONTAINER True is_inserted (v: G): BOOLEAN -- Has v been inserted by the most recent insertion? -- (By default, the value returned is equivalent to calling -- has (v). However, descendants might be able to provide more -- efficient implementations.) -- (from COLLECTION) object_comparison: BOOLEAN -- Must search operations use `equal` rather than = -- for comparing references? (Default: no, use =.) -- (from CONTAINER) off: BOOLEAN -- Is there no current item? -- `off` only if tree `is_empty` or if -- it is `before` or `after`. require -- from TRAVERSABLE True require -- from TRAVERSABLE_SUBSET True Prunable: BOOLEAN = True -- Can items be removed? (Answer: yes.) 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 -- Status setting compare_objects -- Ensure that future search operations will use `equal` -- rather than = for comparing references. -- (from CONTAINER) require -- from CONTAINER changeable_comparison_criterion: changeable_comparison_criterion ensure -- from CONTAINER object_comparison compare_references -- Ensure that future search operations will use = -- rather than `equal` for comparing references. -- (from CONTAINER) require -- from CONTAINER changeable_comparison_criterion: changeable_comparison_criterion ensure -- from CONTAINER reference_comparison: not object_comparison feature -- Cursor movement back -- Move cursor to previous node. require -- from BILINEAR not_before: not before finish -- Move cursor to last node. forth -- Move cursor to next node. require -- from LINEAR not_after: not after require -- from TRAVERSABLE_SUBSET not_after: not after search (v: like item) -- Move to first position (at or after current -- position) where `item` and v are equal. -- If structure does not include v ensure that -- `exhausted` will be true. -- (Reference or object equality, -- based on `object_comparison`.) -- (from BILINEAR) ensure -- from LINEAR object_found: (not exhausted and object_comparison) implies v ~ item item_found: (not exhausted and not object_comparison) implies v = item start -- Move cursor to first node. require -- from TRAVERSABLE True require -- from TRAVERSABLE_SUBSET True feature -- Element change extend (v: like item) -- Put v at proper position in set -- (unless one already exists). -- Was declared in {BINARY_SEARCH_TREE_SET} as synonym of `put`. require -- from COLLECTION extendible: Extendible require else item_exists: v /= Void ensure -- from COLLECTION item_inserted: is_inserted (v) ensure then -- from SET in_set_already: old has (v) implies (count = old count) added_to_set: not old has (v) implies (count = old count + 1) fill (other: CONTAINER [G]) -- Fill with as many items of other as possible. -- The representations of other and current structure -- need not be the same. -- (from COLLECTION) require -- from COLLECTION other_not_void: other /= Void extendible: Extendible merge (other: CONTAINER [G]) -- Add all items of other. -- (from TRAVERSABLE_SUBSET) require -- from SUBSET set_exists: other /= Void same_rule: object_comparison = other.object_comparison put (v: like item) -- Put v at proper position in set -- (unless one already exists). -- Was declared in {BINARY_SEARCH_TREE_SET} as synonym of `extend`. require -- from COLLECTION extendible: Extendible require else item_exists: v /= Void ensure -- from COLLECTION item_inserted: is_inserted (v) ensure then -- from SET in_set_already: old has (v) implies (count = old count) added_to_set: not old has (v) implies (count = old count + 1) feature -- Removal changeable_comparison_criterion: BOOLEAN -- May `object_comparison` be changed? -- (Answer: only if set empty; otherwise insertions might -- introduce duplicates, destroying the set property.) -- (from SET) require -- from CONTAINER True ensure then -- from SET only_on_empty: Result = is_empty prune (v: like item) -- Remove v. require -- from COLLECTION prunable: Prunable ensure then -- from SET removed_count_change: old has (v) implies (count = old count - 1) not_removed_no_count_change: not old has (v) implies (count = old count) item_deleted: not has (v) prune_all (v: G) -- Remove all occurrences of v. -- (Reference or object equality, -- based on `object_comparison`.) -- (from COLLECTION) require -- from COLLECTION prunable: Prunable ensure -- from COLLECTION no_more_occurrences: not has (v) remove -- Remove current item. require -- from TRAVERSABLE_SUBSET not_off: not off wipe_out -- Remove all items. require -- from COLLECTION prunable: Prunable ensure -- from COLLECTION wiped_out: is_empty feature -- Conversion linear_representation: LINEAR [G] -- Representation as a linear structure -- (from LINEAR) require -- from CONTAINER True feature -- Duplication copy (other: BINARY_SEARCH_TREE_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) ensure -- from ANY is_equal: Current ~ other frozen deep_copy (other: BINARY_SEARCH_TREE_SET [G]) -- 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: BINARY_SEARCH_TREE_SET [G] -- 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: BINARY_SEARCH_TREE_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) ensure -- from ANY is_standard_equal: standard_is_equal (other) frozen standard_twin: BINARY_SEARCH_TREE_SET [G] -- 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: BINARY_SEARCH_TREE_SET [G] -- 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 BINARY_SEARCH_TREE_SET [G] -- 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 intersect (other: TRAVERSABLE_SUBSET [G]) -- Remove all items not in other. -- No effect if other `is_empty`. -- (from TRAVERSABLE_SUBSET) require -- from SUBSET set_exists: other /= Void same_rule: object_comparison = other.object_comparison ensure -- from SUBSET is_subset_other: is_subset (other) subtract (other: TRAVERSABLE_SUBSET [G]) -- Remove all items also in other. -- (from TRAVERSABLE_SUBSET) require -- from SUBSET set_exists: other /= Void same_rule: object_comparison = other.object_comparison ensure -- from SUBSET is_disjoint: disjoint (other) symdif (other: TRAVERSABLE_SUBSET [G]) -- Remove all items also in other, and add all -- items of other not already present. -- (from TRAVERSABLE_SUBSET) require -- from SUBSET set_exists: other /= Void same_rule: object_comparison = other.object_comparison feature -- Inapplicable index: INTEGER_32 -- Index of current position -- (from COMPARABLE_STRUCT) feature -- Iteration do_all (action: PROCEDURE [G]) -- Apply action to every item. -- Semantics not guaranteed if action changes the structure; -- in such a case, apply iterator to clone of structure instead. -- (from LINEAR) require -- from TRAVERSABLE action_exists: action /= Void do_if (action: PROCEDURE [G]; test: FUNCTION [G, BOOLEAN]) -- Apply action to every item that satisfies test. -- Semantics not guaranteed if action or test changes the structure; -- in such a case, apply iterator to clone of structure instead. -- (from LINEAR) require -- from TRAVERSABLE action_exists: action /= Void test_exists: test /= Void for_all (test: FUNCTION [G, BOOLEAN]): BOOLEAN -- Is test true for all items? -- Semantics not guaranteed if test changes the structure; -- in such a case, apply iterator to clone of structure instead. -- (from LINEAR) require -- from TRAVERSABLE test_exists: test /= Void ensure then -- from LINEAR empty: is_empty implies Result new_cursor: ITERATION_CURSOR [G] -- Fresh cursor associated with current structure ensure -- from ITERABLE result_attached: Result /= Void there_exists (test: FUNCTION [G, BOOLEAN]): BOOLEAN -- Is test true for at least one item? -- Semantics not guaranteed if test changes the structure; -- in such a case, apply iterator to clone of structure instead. -- (from LINEAR) require -- from TRAVERSABLE test_exists: test /= Void feature -- Output 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 comparison_mode_equal: attached tree as t implies object_comparison = t.object_comparison -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) -- from COMPARABLE_STRUCT empty_constraint: min_max_available implies not is_empty -- from BILINEAR not_both: not (after and before) before_constraint: before implies off -- from LINEAR after_constraint: after implies off -- from TRAVERSABLE empty_constraint: is_empty implies off -- from TRAVERSABLE_SUBSET empty_definition: is_empty = (count = 0) count_range: count >= 0 note copyright: "Copyright (c) 1984-2021, 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 BINARY_SEARCH_TREE_SET
Classes Clusters Cluster hierarchy Chart Relations Flat contracts Go to:

-- Generated by Eiffel Studio --
For more details: eiffel.org