Automatic generation produced by ISE Eiffel
indexing description: "[ Objects that are able to iterate over two-way chains, on which they can perform repeated actions and tests according to a number of predefined control structures such as ``if'', ``until'' and others. ]" status: "See notice at end of class" names: iterators, iteration, two_way_chain_iterators, two_way_chain_iteration traversal: sequential exploration: forward, backward date: "$Date: 2001-11-16 20:32:23 +0000 (Fri, 16 Nov 2001) $" revision: "$Revision: 51435 $" class interface TWO_WAY_CHAIN_ITERATOR [G] feature -- Initialization set (s: like target) -- Make s the new target of iterations. -- (from LINEAR_ITERATOR) require -- from ITERATOR target_exists: s /= void ensure -- from ITERATOR target = s target /= void feature -- Access item: G -- The item at cursor position in target -- (from LINEAR_ITERATOR) require -- from LINEAR_ITERATOR traversable_exists: target /= void item_tuple: TUPLE [G] -- Tuple containing a single element, -- the item at cursor position in target'' -- (from LINEAR_ITERATOR) target: CHAIN [G] feature -- Status report invariant_value: BOOLEAN -- Is the invariant satisfied? -- (Redefinitions of this feature will usually involve -- target; if so, make sure that the result is defined -- when `target = Void'.) -- (from ITERATOR) feature -- Cursor movement back -- Move cursor of target backward one position. exhausted: BOOLEAN -- Is target exhausted? -- (from LINEAR_ITERATOR) finish -- Move cursor of target to last position. forth -- Move to next position of target. -- (from LINEAR_ITERATOR) off: BOOLEAN -- Is position of target off? -- (from LINEAR_ITERATOR) start -- Move to first position of target. -- (from LINEAR_ITERATOR) feature -- Implementation internal_item_tuple: TUPLE [G] -- Field holding the last item of target -- (from LINEAR_ITERATOR) feature -- Iteration continue_for_back (action: PROCEDURE [ANY, TUPLE [G]]; n, k: INTEGER) -- Apply action to every k-th item, -- n times if possible. -- (from LINEAR_ITERATOR) require -- from LINEAR_ITERATOR valid_repetition: n >= 0 valid_skip: k >= 1 continue_for (action: PROCEDURE [ANY, TUPLE [G]]; n, k: INTEGER) -- Apply action to every k-th item, -- n times if possible. -- (from LINEAR_ITERATOR) require -- from LINEAR_ITERATOR valid_repetition: n >= 0 valid_skip: k >= 1 continue_search (test: FUNCTION [ANY, TUPLE [G], BOOLEAN]; b: BOOLEAN) -- Search the first item of target -- satisfying: test equals to b -- (from the current position of target). -- (from LINEAR_ITERATOR) ensure then -- from LINEAR_ITERATOR found: not exhausted = (b = test.item (item_tuple)) continue_search_back (test: FUNCTION [ANY, TUPLE [G], BOOLEAN]; b: BOOLEAN) -- Search the first item of target -- satisfying: test equals to b -- (from the current position of target). -- (from LINEAR_ITERATOR) ensure then -- from LINEAR_ITERATOR found: not exhausted = (b = test.item (item_tuple)) continue_until_back (action: PROCEDURE [ANY, TUPLE [G]]; test: FUNCTION [ANY, TUPLE [G], BOOLEAN]) -- Apply action to every item of target up to -- and including first one satisfying test. -- (from the current position of target). -- (from LINEAR_ITERATOR) require -- from LINEAR_ITERATOR invariant_satisfied: invariant_value ensure then -- from LINEAR_ITERATOR achieved: not exhausted implies test.item (item_tuple) continue_until (action: PROCEDURE [ANY, TUPLE [G]]; test: FUNCTION [ANY, TUPLE [G], BOOLEAN]) -- Apply action to every item of target up to -- and including first one satisfying test. -- (from the current position of target). -- (from LINEAR_ITERATOR) require -- from LINEAR_ITERATOR invariant_satisfied: invariant_value ensure then -- from LINEAR_ITERATOR achieved: not exhausted implies test.item (item_tuple) continue_while (action: PROCEDURE [ANY, TUPLE [G]]; test: FUNCTION [ANY, TUPLE [G], BOOLEAN]) -- Apply action to every item of target up to -- and including first one not satisfying test -- (from the current position of target). -- (from LINEAR_ITERATOR) require else -- from LINEAR_ITERATOR invariant_satisfied: invariant_value ensure then -- from LINEAR_ITERATOR finished: not exhausted implies not test.item (item_tuple) continue_while_back (action: PROCEDURE [ANY, TUPLE [G]]; test: FUNCTION [ANY, TUPLE [G], BOOLEAN]) -- Apply action to every item of target up to -- and including first one not satisfying test -- (from the current position of target). -- (from LINEAR_ITERATOR) require else -- from LINEAR_ITERATOR invariant_satisfied: invariant_value ensure then -- from LINEAR_ITERATOR finished: not exhausted implies not test.item (item_tuple) do_all (action: PROCEDURE [ANY, TUPLE [G]]) -- Apply action to every item of target. -- (from ITERATOR) require -- from ITERATOR action_exists: action /= void do_all_back (action: PROCEDURE [ANY, TUPLE [G]]) -- Apply action to every item of target. -- (from ITERATOR) require -- from ITERATOR action_exists: action /= void do_for_back (action: PROCEDURE [ANY, TUPLE [G]]; i, n, k: INTEGER) -- Apply action to every k-th item, -- n times if possible, starting from i-th. -- (from LINEAR_ITERATOR) require -- from LINEAR_ITERATOR valid_start: i >= 1 valid_repetition: n >= 0 valid_skip: k >= 1 do_for (action: PROCEDURE [ANY, TUPLE [G]]; i, n, k: INTEGER) -- Apply action to every k-th item, -- n times if possible, starting from i-th. -- (from LINEAR_ITERATOR) require -- from LINEAR_ITERATOR valid_start: i >= 1 valid_repetition: n >= 0 valid_skip: k >= 1 do_if (action: PROCEDURE [ANY, TUPLE [G]]; test: FUNCTION [ANY, TUPLE [G], BOOLEAN]) -- Apply action to every item of target satisfying test. -- (from ITERATOR) require -- from ITERATOR action_exists: action /= void test_exists: test /= void do_if_back (action: PROCEDURE [ANY, TUPLE [G]]; test: FUNCTION [ANY, TUPLE [G], BOOLEAN]) -- Apply action to every item of target satisfying test. -- (from ITERATOR) require -- from ITERATOR action_exists: action /= void test_exists: test /= void do_until_back (action: PROCEDURE [ANY, TUPLE [G]]; test: FUNCTION [ANY, TUPLE [G], BOOLEAN]) -- Apply action to every item of target up to -- and including first one satisfying test. -- (from LINEAR_ITERATOR) require -- from ITERATOR action_exists: action /= void test_exists: test /= void ensure then -- from LINEAR_ITERATOR achieved: not exhausted implies test.item (item_tuple) do_until (action: PROCEDURE [ANY, TUPLE [G]]; test: FUNCTION [ANY, TUPLE [G], BOOLEAN]) -- Apply action to every item of target up to -- and including first one satisfying test. -- (from LINEAR_ITERATOR) require -- from ITERATOR action_exists: action /= void test_exists: test /= void ensure then -- from LINEAR_ITERATOR achieved: not exhausted implies test.item (item_tuple) do_while (action: PROCEDURE [ANY, TUPLE [G]]; test: FUNCTION [ANY, TUPLE [G], BOOLEAN]) -- Apply action to every item of target up to -- and including first one not satisfying test. -- (from the start of target) -- (from LINEAR_ITERATOR) require -- from ITERATOR action_exists: action /= void test_exists: test /= void ensure then -- from LINEAR_ITERATOR finished: not exhausted implies not test.item (item_tuple) do_while_back (action: PROCEDURE [ANY, TUPLE [G]]; test: FUNCTION [ANY, TUPLE [G], BOOLEAN]) -- Apply action to every item of target up to -- and including first one not satisfying test. -- (from the start of target) -- (from LINEAR_ITERATOR) require -- from ITERATOR action_exists: action /= void test_exists: test /= void ensure then -- from LINEAR_ITERATOR finished: not exhausted implies not test.item (item_tuple) for_all (test: FUNCTION [ANY, TUPLE [G], BOOLEAN]): BOOLEAN -- Does test return true for -- all items of target? -- (from LINEAR_ITERATOR) require -- from ITERATOR test_exists: test /= void for_all_back (test: FUNCTION [ANY, TUPLE [G], BOOLEAN]): BOOLEAN -- Does test return true for -- all items of target? -- (from LINEAR_ITERATOR) require -- from ITERATOR test_exists: test /= void search (test: FUNCTION [ANY, TUPLE [G], BOOLEAN]; b: BOOLEAN) -- Search the first item of target for which test -- has the same value as b (both true or both false). -- (from LINEAR_ITERATOR) search_back (test: FUNCTION [ANY, TUPLE [G], BOOLEAN]; b: BOOLEAN) -- Search the first item of target for which test -- has the same value as b (both true or both false). -- (from LINEAR_ITERATOR) there_exists (test: FUNCTION [ANY, TUPLE [G], BOOLEAN]): BOOLEAN -- Does test return true for -- at least one item of target? -- (from LINEAR_ITERATOR) require -- from ITERATOR test_exists: test /= void there_exists_back (test: FUNCTION [ANY, TUPLE [G], BOOLEAN]): BOOLEAN -- Does test return true for -- at least one item of target? -- (from LINEAR_ITERATOR) require -- from ITERATOR test_exists: test /= void until_continue (action: PROCEDURE [ANY, TUPLE [G]]; test: FUNCTION [ANY, TUPLE [G], BOOLEAN]) -- Apply action to every item of target from current -- position, up to but excluding first one satisfying test. -- (from LINEAR_ITERATOR) require -- from LINEAR_ITERATOR invariant_satisfied: invariant_value ensure -- from LINEAR_ITERATOR achieved: exhausted or else test.item (item_tuple) invariant_satisfied: invariant_value until_continue_back (action: PROCEDURE [ANY, TUPLE [G]]; test: FUNCTION [ANY, TUPLE [G], BOOLEAN]) -- Apply action to every item of target from current -- position, up to but excluding first one satisfying test. -- (from LINEAR_ITERATOR) require -- from LINEAR_ITERATOR invariant_satisfied: invariant_value ensure -- from LINEAR_ITERATOR achieved: exhausted or else test.item (item_tuple) invariant_satisfied: invariant_value until_do_back (action: PROCEDURE [ANY, TUPLE [G]]; test: FUNCTION [ANY, TUPLE [G], BOOLEAN]) -- Apply action to every item of target up to -- but excluding first one satisfying test. -- (Apply to full list if no item satisfies test.) -- (from LINEAR_ITERATOR) require -- from ITERATOR action_exists: action /= void test_exists: test /= void ensure then -- from LINEAR_ITERATOR achieved: not exhausted implies test.item (item_tuple) until_do (action: PROCEDURE [ANY, TUPLE [G]]; test: FUNCTION [ANY, TUPLE [G], BOOLEAN]) -- Apply action to every item of target up to -- but excluding first one satisfying test. -- (Apply to full list if no item satisfies test.) -- (from LINEAR_ITERATOR) require -- from ITERATOR action_exists: action /= void test_exists: test /= void ensure then -- from LINEAR_ITERATOR achieved: not exhausted implies test.item (item_tuple) while_continue (action: PROCEDURE [ANY, TUPLE [G]]; test: FUNCTION [ANY, TUPLE [G], BOOLEAN]) -- Apply action to every item of target up to -- but excluding first one not satisfying test. -- (from LINEAR_ITERATOR) ensure -- from LINEAR_ITERATOR finished: not exhausted implies not test.item (item_tuple) while_continue_back (action: PROCEDURE [ANY, TUPLE [G]]; test: FUNCTION [ANY, TUPLE [G], BOOLEAN]) -- Apply action to every item of target up to -- but excluding first one not satisfying test. -- (from LINEAR_ITERATOR) ensure -- from LINEAR_ITERATOR finished: not exhausted implies not test.item (item_tuple) while_do_back (action: PROCEDURE [ANY, TUPLE [G]]; test: FUNCTION [ANY, TUPLE [G], BOOLEAN]) -- Apply action to every item of target up to -- but excluding first one not satisfying test. -- (Apply to full list if all items satisfy test.) -- (from LINEAR_ITERATOR) require -- from ITERATOR action_exists: action /= void test_exists: test /= void ensure then -- from LINEAR_ITERATOR finished: not exhausted implies not test.item (item_tuple) while_do (action: PROCEDURE [ANY, TUPLE [G]]; test: FUNCTION [ANY, TUPLE [G], BOOLEAN]) -- Apply action to every item of target up to -- but excluding first one not satisfying test. -- (Apply to full list if all items satisfy test.) -- (from LINEAR_ITERATOR) require -- from ITERATOR action_exists: action /= void test_exists: test /= void ensure then -- from LINEAR_ITERATOR finished: not exhausted implies not test.item (item_tuple) invariant -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) -- from LINEAR_ITERATOR target_exists: target /= void item_tuple_exists: item_tuple /= void internal_item_tuple_exists: internal_item_tuple /= void -- from ITERATOR traversable_exists: target /= void indexing library: "[ EiffelBase: Library of reusable components for Eiffel. ]" status: "[ Copyright 1986-2001 Interactive Software Engineering (ISE). For ISE customers the original versions are an ISE product covered by the ISE Eiffel license and support agreements. ]" license: "[ EiffelBase may now be used by anyone as FREE SOFTWARE to develop any product, public-domain or commercial, without payment to ISE, under the terms of the ISE Free Eiffel Library License (IFELL) at http://eiffel.com/products/base/license.html. ]" source: "[ Interactive Software Engineering Inc. ISE Building 360 Storke Road, Goleta, CA 93117 USA Telephone 805-685-1006, Fax 805-685-6869 Electronic mail <info@eiffel.com> Customer support http://support.eiffel.com ]" info: "[ For latest info see award-winning pages: http://eiffel.com ]" end -- class TWO_WAY_CHAIN_ITERATOR -- Generated by ISE Eiffel --
For more details: www.eiffel.com