indexing
description: "Objects that are able to iterate over linear structures"
legal: "See notice at end of class."
status: "See notice at end of class."
names: iterators, iteration, linear_iterators, linear_iteration
date: "$Date: 2006-01-22 18:25:44 -0800 (Sun, 22 Jan 2006) $"
revision: "$Revision: 56675 $"
class interface
LINEAR_ITERATOR [G]
create
set (s: like target)
`s'
require ITERATOR
target_exists: s /= Void
ensure ITERATOR
target = s
target /= Void
feature
set (s: like target)
`s'
require ITERATOR
target_exists: s /= Void
ensure ITERATOR
target = s
target /= Void
feature
generating_type: STRING_8
ANY
generator: STRING_8
ANY
item: G
target
require
traversable_exists: target /= Void
item_tuple: TUPLE [G]
target
target: LINEAR [G]
feature
frozen deep_equal (some: ANY; other: like arg #1): BOOLEAN
`some'`other'
ANY
ensure ANY
shallow_implies_deep: standard_equal (some, other) implies Result
both_or_none_void: (some = Void) implies (Result = (other = Void))
same_type: (Result and (some /= Void)) implies some.same_type (other)
symmetric: Result implies deep_equal (other, some)
frozen equal (some: ANY; other: like arg #1): BOOLEAN
`some'`other'
ANY
ensure ANY
definition: Result = (some = Void and other = Void) or else ((some /= Void and other /= Void) and then some.is_equal (other))
is_equal (other: like Current): BOOLEAN
`other'
ANY
require ANY
other_not_void: other /= Void
ensure ANY
symmetric: Result implies other.is_equal (Current)
consistent: standard_is_equal (other) implies Result
frozen standard_equal (some: ANY; other: like arg #1): BOOLEAN
`some'`other'
ANY
ensure ANY
definition: Result = (some = Void and other = Void) or else ((some /= Void and other /= Void) and then some.standard_is_equal (other))
frozen standard_is_equal (other: like Current): BOOLEAN
`other'
ANY
require ANY
other_not_void: other /= Void
ensure ANY
same_type: Result implies same_type (other)
symmetric: Result implies other.standard_is_equal (Current)
feature
conforms_to (other: ANY): BOOLEAN
`other'
ANY
require ANY
other_not_void: other /= Void
invariant_value: BOOLEAN
target
`target = Void'
ITERATOR
same_type (other: ANY): BOOLEAN
`other'
ANY
require ANY
other_not_void: other /= Void
ensure ANY
definition: Result = (conforms_to (other) and other.conforms_to (Current))
feature
exhausted: BOOLEAN
target
forth
target
off: BOOLEAN
target
start
target
feature
copy (other: like Current)
`other'
ANY
require ANY
other_not_void: other /= Void
type_identity: same_type (other)
ensure ANY
is_equal: is_equal (other)
frozen deep_copy (other: like Current)
copy`other'deep_twin
ANY
require ANY
other_not_void: other /= Void
ensure ANY
deep_equal: deep_equal (Current, other)
frozen deep_twin: like Current
ANY
ensure ANY
deep_equal: deep_equal (Current, Result)
frozen standard_copy (other: like Current)
`other'
ANY
require ANY
other_not_void: other /= Void
type_identity: same_type (other)
ensure ANY
is_standard_equal: standard_is_equal (other)
frozen standard_twin: like Current
`other'
ANY
ensure ANY
standard_twin_not_void: Result /= Void
equal: standard_equal (Result, Current)
frozen twin: like Current
`Current'
twincopycopy
ANY
ensure ANY
twin_not_void: Result /= Void
is_equal: Result.is_equal (Current)
feature
frozen default: like Current
ANY
frozen default_pointer: POINTER
`POINTER'
`p'default
`p'`POINTER'
ANY
default_rescue
ANY
frozen do_nothing
ANY
feature
internal_item_tuple: TUPLE [G]
target
feature
continue_for (action: PROCEDURE [ANY, TUPLE [G]]; n, k: INTEGER_32)
`action'`k'
`n'
require
valid_repetition: n >= 0
valid_skip: k >= 1
continue_search (test: FUNCTION [ANY, TUPLE [G], BOOLEAN]; b: BOOLEAN)
target
`test'`b'
target
ensure then
found: not exhausted = (b = test.item (item_tuple))
continue_until (action: PROCEDURE [ANY, TUPLE [G]]; test: FUNCTION [ANY, TUPLE [G], BOOLEAN])
`action'target
`test'
target
require
invariant_satisfied: invariant_value
ensure then
achieved: not exhausted implies test.item (item_tuple)
continue_while (action: PROCEDURE [ANY, TUPLE [G]]; test: FUNCTION [ANY, TUPLE [G], BOOLEAN])
`action'target
`test'
target
require else
invariant_satisfied: invariant_value
ensure then
finished: not exhausted implies not test.item (item_tuple)
do_all (action: PROCEDURE [ANY, TUPLE [G]])
`action'target
ITERATOR
require ITERATOR
action_exists: action /= Void
do_for (action: PROCEDURE [ANY, TUPLE [G]]; i, n, k: INTEGER_32)
`action'`k'
`n'`i'
require
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])
`action'target`test'
ITERATOR
require ITERATOR
action_exists: action /= Void
test_exists: test /= Void
do_until (action: PROCEDURE [ANY, TUPLE [G]]; test: FUNCTION [ANY, TUPLE [G], BOOLEAN])
`action'target
`test'
require ITERATOR
action_exists: action /= Void
test_exists: test /= Void
ensure then
achieved: not exhausted implies test.item (item_tuple)
do_while (action: PROCEDURE [ANY, TUPLE [G]]; test: FUNCTION [ANY, TUPLE [G], BOOLEAN])
`action'target
`test'
starttarget
require ITERATOR
action_exists: action /= Void
test_exists: test /= Void
ensure then
finished: not exhausted implies not test.item (item_tuple)
for_all (test: FUNCTION [ANY, TUPLE [G], BOOLEAN]): BOOLEAN
`test'
target
require ITERATOR
test_exists: test /= Void
search (test: FUNCTION [ANY, TUPLE [G], BOOLEAN]; b: BOOLEAN)
target`test'
`b'
there_exists (test: FUNCTION [ANY, TUPLE [G], BOOLEAN]): BOOLEAN
`test'
target
require ITERATOR
test_exists: test /= Void
until_continue (action: PROCEDURE [ANY, TUPLE [G]]; test: FUNCTION [ANY, TUPLE [G], BOOLEAN])
`action'target
`test'
require
invariant_satisfied: invariant_value
ensure
achieved: exhausted or else test.item (item_tuple)
invariant_satisfied: invariant_value
until_do (action: PROCEDURE [ANY, TUPLE [G]]; test: FUNCTION [ANY, TUPLE [G], BOOLEAN])
`action'target
`test'
`test'
require ITERATOR
action_exists: action /= Void
test_exists: test /= Void
ensure then
achieved: not exhausted implies test.item (item_tuple)
while_continue (action: PROCEDURE [ANY, TUPLE [G]]; test: FUNCTION [ANY, TUPLE [G], BOOLEAN])
`action'target
`test'
ensure
finished: not exhausted implies not test.item (item_tuple)
while_do (action: PROCEDURE [ANY, TUPLE [G]]; test: FUNCTION [ANY, TUPLE [G], BOOLEAN])
`action'target
`test'
`test'
require ITERATOR
action_exists: action /= Void
test_exists: test /= Void
ensure then
finished: not exhausted implies not test.item (item_tuple)
feature
io: STD_FILES
ANY
out: STRING_8
ANYtagged_out
ANY
print (some: ANY)
`some'
ANY
frozen tagged_out: STRING_8
ANYout
ANY
feature
operating_environment: OPERATING_ENVIRONMENT
ANY
invariant
target_exists: target /= Void
item_tuple_exists: item_tuple /= Void
internal_item_tuple_exists: internal_item_tuple /= Void
ITERATOR
traversable_exists: target /= Void
ANY
reflexive_equality: standard_is_equal (Current)
reflexive_conformance: conforms_to (Current)
indexing
library: "EiffelBase: Library of reusable components for Eiffel."
copyright: "Copyright (c) 1984-2006, Eiffel Software and others"
license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)"
source: "[
Eiffel Software
356 Storke Road, Goleta, CA 93117 USA
Telephone 805-685-1006, Fax 805-685-6869
Website http://www.eiffel.com
Customer support http://support.eiffel.com
]"
end LINEAR_ITERATOR