note description: "[ Trees where each node has a fixed number of children. The number of children is arbitrary but cannot be changed once the node has been created. ]" library: "Free implementation of ELKS library" legal: "See notice at end of class." status: "See notice at end of class." names: fixed_tree, tree, fixed_list representation: recursive, array access: cursor, membership contents: generic date: "$Date: 2018-12-15 18:06:16 +0000 (Sat, 15 Dec 2018) $" revision: "$Revision: 102608 $" class interface FIXED_TREE [G] create make (n: INTEGER_32; v: G) -- Create node with n void children and item v. require valid_number_of_children: n >= 0 ensure node_item: item = v node_arity: arity = 0 make_filled (n: INTEGER_32; v: G) -- Create node with n empty children and item v. require valid_number_of_children: n >= 0 has_default: ({G}).has_default ensure node_item: item = v node_arity: arity = n feature -- Access child_item: like item -- Item of active child. require -- from TREE readable: child_readable generating_type: TYPE [detachable FIXED_TREE [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 item: G -- Content of cell. -- (from CELL) left_sibling: like parent -- Left neighbor, if any. require -- from TREE is_not_root: not is_root ensure -- from TREE is_sibling: Result /= Void implies is_sibling (Result) right_is_current: (Result /= Void) implies (Result.right_sibling = Current) parent: detachable like Current -- Parent of current node. right_sibling: like parent -- Right neighbor, if any. require -- from TREE is_not_root: not is_root ensure -- from TREE is_sibling: Result /= Void implies is_sibling (Result) left_is_current: (Result /= Void) implies (Result.left_sibling = Current) feature -- Measurement count: INTEGER_32 -- Number of items -- (from TREE) 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 alias "≡≡≡" (other: FIXED_TREE [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: FIXED_TREE [G]): BOOLEAN -- Does other contain the same elements? -- (Reference or object equality, -- based on object_comparison.) -- (from TREE) require -- from ANY other_not_void: other /= Void ensure -- from ANY symmetric: Result implies other ~ Current consistent: standard_is_equal (other) implies Result node_is_equal (other: FIXED_TREE [G]): BOOLEAN -- Is other equal to Current? -- (from TREE) require -- from TREE other_not_void: other /= Void 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: FIXED_TREE [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 changeable_comparison_criterion: BOOLEAN -- May object_comparison be changed? -- (Answer: yes by default.) -- (from CONTAINER) child_contractable: BOOLEAN -- May items be removed? ensure Result = not child_off child_isfirst: BOOLEAN -- Is cursor under first child? -- (from TREE) ensure -- from TREE not_is_leaf: Result implies not is_leaf child_islast: BOOLEAN -- Is cursor under last child? -- (from TREE) ensure -- from TREE not_is_leaf: Result implies not is_leaf child_readable: BOOLEAN -- Is there a current child_item to be read? -- (from TREE) child_writable: BOOLEAN -- Is there a current child_item that may be modified? -- (from TREE) 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 Full: BOOLEAN = True -- Is tree full? has (v: G): BOOLEAN -- Does subtree include v? -- (Reference or object equality, -- based on object_comparison.) -- (from TREE) ensure -- from CONTAINER not_found_in_empty: Result implies not is_empty is_empty: BOOLEAN -- Is structure empty of items? -- (from TREE) is_leaf: BOOLEAN -- Are there no children? -- (from TREE) is_root: BOOLEAN -- Is there no parent? -- (from TREE) is_sibling (other: attached like parent): BOOLEAN -- Are current node and other siblings? -- (from TREE) require -- from TREE other_exists: other /= Void ensure -- from TREE not_root: Result implies not is_root other_not_root: Result implies not other.is_root same_parent: Result = not is_root and other.parent = parent object_comparison: BOOLEAN -- Must search operations use equal rather than = -- for comparing references? (Default: no, use =.) -- (from CONTAINER) Readable: BOOLEAN = True -- (from TREE) readable_child: BOOLEAN -- Is there a current child to be read? -- (from TREE) 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)) valid_cursor_index (i: INTEGER_32): BOOLEAN -- Is i correctly bounded for cursor movement? -- (from TREE) ensure -- from TREE valid_cursor_index_definition: Result = (i >= 0) and (i <= child_capacity + 1) Writable: BOOLEAN = True -- Is there a current item that may be modified? -- (from TREE) writable_child: BOOLEAN -- Is there a current child that may be modified? -- (from TREE) 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 -- Element change child_put (v: like item) -- Replace current child item with v -- Was declared in FIXED_TREE as synonym of child_replace. require -- from TREE child_writable: child_writable ensure -- from TREE item_inserted: child_item = v child_replace (v: like item) -- Replace current child item with v -- Was declared in FIXED_TREE as synonym of child_put. require -- from TREE child_writable: child_writable ensure -- from TREE item_inserted: child_item = v put (v: like item) -- Make v the cell's item. -- Was declared in CELL as synonym of replace. -- (from CELL) require -- from TREE is_writable: Writable ensure -- from TREE item_inserted: item = v ensure -- from CELL item_inserted: item = v put_child (n: like new_node) -- Make n the node's child. require -- from TREE non_void_argument: n /= Void require else not_full: arity < capacity ensure then child_replaced: n.parent = Current put_left (v: like item) -- Add v to the left of current node. require is_not_root: not is_root has_left_sibling: left_sibling /= Void ensure item_put: attached left_sibling as l and then l.item = v put_left_sibling (other: like new_node) -- Make other the left sibling of current node. require is_not_root: not is_root has_left_sibling: left_sibling /= Void ensure left_sibling_replaced: left_sibling = other put_right (v: like item) -- Add v to the right of current node. require is_not_root: not is_root has_right_sibling: right_sibling /= Void ensure item_put: attached right_sibling as r and then r.item = v put_right_sibling (other: like new_node) -- Make other the right sibling of current node. require is_not_root: not is_root has_right_sibling: right_sibling /= Void ensure right_sibling_replaced: right_sibling = other replace (v: like item) -- Make v the cell's item. -- Was declared in CELL as synonym of put. -- (from CELL) require -- from TREE is_writable: Writable ensure -- from TREE item_inserted: item = v ensure -- from CELL item_inserted: item = v replace_child (n: like new_node) -- Make n the node's child. require -- from TREE writable_child: writable_child ensure -- from TREE child_replaced: child = n ensure then child_replaced: n.parent = Current sprout -- Make current node a root. -- (from TREE) feature -- Removal forget_left -- Forget all left siblings. forget_right -- Forget all right siblings. remove_child -- Remove active child. ensure then child_removed: child = Void feature -- Conversion binary_representation: BINARY_TREE [G] -- Convert to binary tree representation: -- first child becomes left child, -- right sibling becomes right child. -- (from TREE) ensure -- from TREE result_is_root: Result.is_root result_has_no_right_child: not Result.has_right linear_representation: LINEAR [G] -- Representation as a linear structure -- (from TREE) feature -- Duplication copy (other: FIXED_TREE [G]) -- Copy contents from other. -- (from TREE) require -- from ANY other_not_void: other /= Void type_identity: same_type (other) ensure -- from ANY is_equal: Current ~ other frozen deep_copy (other: FIXED_TREE [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: FIXED_TREE [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: FIXED_TREE [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: FIXED_TREE [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: FIXED_TREE [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 FIXED_TREE [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 feature -- Access: chilldren arity: INTEGER_32 -- Number of children array_item (n: INTEGER_32): detachable like Current capacity: INTEGER_32 child: like parent -- Current child node require -- from TREE readable: readable_child child_after: BOOLEAN -- Is there no valid child position to the right of cursor? child_back -- Move cursor to previous child. child_before: BOOLEAN -- Is there no valid child position to the left of cursor? child_cursor: CURSOR -- Current cursor position child_finish -- Move cursor to last child. child_forth -- Move cursor to next child. child_go_i_th (i: INTEGER_32) -- Move cursor to i-th child. ensure then -- from TREE position: child_index = i child_go_to (p: CURSOR) -- Move cursor to position p. child_index: INTEGER_32 -- Index of current child ensure -- from TREE valid_index: Result >= 0 and Result <= arity + 1 child_off: BOOLEAN -- Is there no current child? child_start -- Move cursor to first child. first_child: like parent -- Leftmost child require -- from TREE is_not_leaf: not is_leaf index_of (v: like Current; i: INTEGER_32): INTEGER_32 last_child: like first_child -- Right most child require -- from TREE is_not_leaf: not is_leaf prune (n: like new_node) -- Remove n from the children. require -- from TREE is_child: n.parent = Current ensure -- from TREE n_is_root: n.is_root put_i_th (v: like Current; n: INTEGER_32) search_child (v: like Current) wipe_out -- Remove all children. ensure -- from TREE is_leaf: is_leaf feature -- Iteration new_cursor: TREE_ITERATION_CURSOR [G] -- Fresh cursor associated with current structure -- (from TREE) ensure -- from ITERABLE result_attached: Result /= 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 feature -- Redefinition child_capacity: INTEGER_32 -- Maximal number of children invariant -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) -- from TREE tree_consistency: child_readable implies (attached child as c and then c.parent = Current) leaf_definition: is_leaf = (arity = 0) child_off_definition: child_off = child_before or child_after child_before_definition: child_before = (child_index = 0) child_isfirst_definition: child_isfirst = (not is_leaf and child_index = 1) child_islast_definition: child_islast = (not is_leaf and child_index = child_capacity) child_after_definition: child_after = (child_index >= child_capacity + 1) note ca_ignore: "CA024", "CA024: use an across loop instead of a regular one" 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 FIXED_TREE
Generated by ISE EiffelStudio