indexing
description: "Base class for EV_TREE and EV_TREE_ITEM."
legal: "See notice at end of class."
status: "See notice at end of class."
date: "$Date: 2006-01-22 18:25:44 -0800 (Sun, 22 Jan 2006) $"
revision: "$Revision: 56675 $"
deferred class interface
EV_TREE_NODE_LIST
feature
cursor: EV_DYNAMIC_LIST_CURSOR [EV_TREE_NODE]
EV_DYNAMIC_LIST
require CURSOR_STRUCTURE
True
ensure CURSOR_STRUCTURE
cursor_not_void: Result /= Void
ensure then EV_DYNAMIC_LIST
bridge_ok: Result.is_equal (implementation.cursor)
data: ANY
EV_ANY
first: like item
CHAIN
require CHAIN
not_empty: not is_empty
generating_type: STRING_8
ANY
generator: STRING_8
ANY
has (v: like item): BOOLEAN
`v'
object_comparison
CHAIN
require CONTAINER
True
ensure CONTAINER
not_found_in_empty: Result implies not is_empty
has_recursively (an_item: EV_TREE_NODE): BOOLEAN
`an_item'`Current'
require
item_not_void: an_item /= Void
ensure
not_found_in_empty: Result implies not is_empty
index_not_changed: old index = index
i_th alias "[]" (i: INTEGER_32): like item
`i'
EV_DYNAMIC_LIST
require TABLE
valid_key: valid_index (i)
ensure then EV_DYNAMIC_LIST
bridge_ok: Result.is_equal (implementation.i_th (i))
index: INTEGER_32
EV_DYNAMIC_LIST
require LINEAR
True
ensure then EV_DYNAMIC_LIST
bridge_ok: Result = implementation.index
index_of (v: like item; i: INTEGER_32): INTEGER_32
`i'`v'
EV_DYNAMIC_LIST
require LINEAR
positive_occurrences: i > 0
ensure LINEAR
non_negative_result: Result >= 0
ensure then EV_DYNAMIC_LIST
bridge_ok: Result = implementation.index_of (v, i)
item: EV_TREE_NODE
EV_DYNAMIC_LIST
require TRAVERSABLE
not_off: not off
require ACTIVE
readable: readable
ensure then EV_DYNAMIC_LIST
not_void: Result /= Void
bridge_ok: Result.is_equal (implementation.item)
last: like item
CHAIN
require CHAIN
not_empty: not is_empty
sequential_occurrences (v: like item): INTEGER_32
`v'
object_comparison
LINEAR
require BAG
True
ensure BAG
non_negative_occurrences: Result >= 0
retrieve_item_by_data (some_data: ANY; should_compare_objects: BOOLEAN): EV_TREE_NODE
`Result'`Current'
`some_data'
`should_compare_objects'
EV_DYNAMIC_LIST
ensure EV_DYNAMIC_LIST
not_found_in_empty: Result /= Void implies not is_empty
index_not_changed: old index = index
retrieve_item_recursively_by_data (some_data: ANY; should_compare_objects: BOOLEAN): EV_TREE_NODE
data
`Result'
`should_compare_objects'
ensure
not_found_in_empty: Result /= Void implies not is_empty
index_not_changed: old index = index
retrieve_items_by_data (some_data: ANY; should_compare_objects: BOOLEAN): ARRAYED_LIST [EV_TREE_NODE]
`Result'`Current'
`some_data'
`should_compare_objects'
EV_DYNAMIC_LIST
ensure EV_DYNAMIC_LIST
result_not_void: Result /= Void
not_found_in_empty: not Result.is_empty implies not is_empty
index_not_changed: old index = index
retrieve_items_recursively_by_data (some_data: ANY; should_compare_objects: BOOLEAN): ARRAYED_LIST [EV_TREE_NODE]
`Result'`Current'
`some_data'
`should_compare_objects'
ensure
result_not_void: Result /= Void
not_found_in_empty: not Result.is_empty implies not is_empty
index_not_changed: old index = index
infix "@" (i: INTEGER_32): like item assign put_i_th
`i'
CHAINi_th
CHAIN
require TABLE
valid_key: valid_index (i)
feature
count: INTEGER_32
EV_DYNAMIC_LIST
require FINITE
True
require SET
True
ensure then EV_DYNAMIC_LIST
bridge_ok: Result = implementation.count
index_set: INTEGER_INTERVAL
CHAIN
require INDEXABLE
True
ensure INDEXABLE
not_void: Result /= Void
ensure then CHAIN
count_definition: Result.count = count
occurrences (v: like item): INTEGER_32
`v'
object_comparison
CHAIN
require BAG
True
require LINEAR
True
ensure BAG
non_negative_occurrences: Result >= 0
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'
LIST
require ANY
other_not_void: other /= Void
ensure ANY
symmetric: Result implies other.is_equal (Current)
consistent: standard_is_equal (other) implies Result
ensure then LIST
indices_unchanged: index = old index and other.index = old other.index
true_implies_same_size: Result implies count = other.count
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
after: BOOLEAN
LIST
require LINEAR
True
before: BOOLEAN
LIST
require BILINEAR
True
conforms_to (other: ANY): BOOLEAN
`other'
ANY
require ANY
other_not_void: other /= Void
exhausted: BOOLEAN
LINEAR
ensure LINEAR
exhausted_when_off: off implies Result
extendible: BOOLEAN is True
DYNAMIC_CHAIN
full: BOOLEAN is False
EV_DYNAMIC_LIST
is_empty: BOOLEAN
FINITE
require CONTAINER
True
is_inserted (v: EV_TREE_NODE): BOOLEAN
`v'
`has (v)'
COLLECTION
isfirst: BOOLEAN
CHAIN
ensure CHAIN
valid_position: Result implies not is_empty
islast: BOOLEAN
CHAIN
ensure CHAIN
valid_position: Result implies not is_empty
object_comparison: BOOLEAN
equal`='
`='
CONTAINER
off: BOOLEAN
CHAIN
require TRAVERSABLE
True
parent: EV_ANY
`Current'
EV_CONTAINABLE
require EV_CONTAINABLE
not_destroyed: not is_destroyed
prunable: BOOLEAN
DYNAMIC_CHAIN
require COLLECTION
True
readable: BOOLEAN
SEQUENCE
require ACTIVE
True
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))
valid_cursor (p: CURSOR): BOOLEAN
`p'
`p'
`Current'
EV_DYNAMIC_LIST
require CURSOR_STRUCTURE
True
ensure then EV_DYNAMIC_LIST
bridge_ok: Result = implementation.valid_cursor (p)
valid_cursor_index (i: INTEGER_32): BOOLEAN
`i'
CHAIN
ensure CHAIN
valid_cursor_index_definition: Result = ((i >= 0) and (i <= count + 1))
valid_index (i: INTEGER_32): BOOLEAN
`i'
CHAIN
require TABLE
True
ensure then INDEXABLE
only_if_in_index_set: Result implies ((i >= index_set.lower) and (i <= index_set.upper))
ensure then CHAIN
valid_index_definition: Result = ((i >= 1) and (i <= count))
writable: BOOLEAN
SEQUENCE
require ACTIVE
True
feature
compare_objects
equal
`='
CONTAINER
require CONTAINER
changeable_comparison_criterion: changeable_comparison_criterion
ensure CONTAINER
object_comparison
compare_references
`='
equal
CONTAINER
require CONTAINER
changeable_comparison_criterion: changeable_comparison_criterion
ensure CONTAINER
reference_comparison: not object_comparison
feature
back
EV_DYNAMIC_LIST
require BILINEAR
not_before: not before
finish
CHAIN
require LINEAR
True
ensure then CHAIN
at_last: not is_empty implies islast
forth
EV_DYNAMIC_LIST
require LINEAR
not_after: not after
ensure then LIST
moved_forth: index = old index + 1
go_i_th (i: INTEGER_32)
`i'
EV_DYNAMIC_LIST
require CHAIN
valid_cursor_index: valid_cursor_index (i)
ensure CHAIN
position_expected: index = i
go_to (p: CURSOR)
`p'
EV_DYNAMIC_LIST
require CURSOR_STRUCTURE
cursor_position_valid: valid_cursor (p)
move (i: INTEGER_32)
`i'
EV_DYNAMIC_LIST
ensure CHAIN
too_far_right: (old index + i > count) implies exhausted
too_far_left: (old index + i < 1) implies exhausted
expected_index: (not exhausted) implies (index = old index + i)
search (v: like item)
item`v'
`v'
exhausted
object_comparison
BILINEAR
ensure LINEAR
object_found: (not exhausted and object_comparison) implies equal (v, item)
item_found: (not exhausted and not object_comparison) implies v = item
start
EV_DYNAMIC_LIST
require TRAVERSABLE
True
ensure then CHAIN
at_first: not is_empty implies isfirst
ensure then EV_DYNAMIC_LIST
empty_implies_after: is_empty implies after
feature
append (s: SEQUENCE [like item])
`s'
EV_DYNAMIC_LIST
require EV_DYNAMIC_LIST
not_destroyed: not is_destroyed
extendible: extendible
sequence_not_void: s /= Void
sequence_not_current: s /= Current
not_parented: not s.there_exists (agent (v: like item): BOOLEAN
)
ensure EV_DYNAMIC_LIST
count_increased: old count + s.count = count
cursor_not_moved: (index = old index) or (after and old after)
extend (v: like item)
`v'
EV_DYNAMIC_LISTforce
EV_DYNAMIC_LIST
require EV_DYNAMIC_LIST
not_destroyed: not is_destroyed
extendible: extendible
v_not_void: v /= Void
v_parent_void: v.parent = Void
v_not_current: not same (v)
v_not_parent_of_current: not is_parent_recursive (v)
ensure EV_DYNAMIC_LIST
parent_is_current: v.parent = Current
v_is_last: v = last
count_increased: count = old count + 1
cursor_not_moved: (index = old index) or (after and old after)
fill (other: CONTAINER [EV_TREE_NODE])
`other'
`other'
CHAIN
require COLLECTION
other_not_void: other /= Void
extendible: extendible
force (v: like item)
`v'
EV_DYNAMIC_LISTextend
EV_DYNAMIC_LIST
require EV_DYNAMIC_LIST
not_destroyed: not is_destroyed
extendible: extendible
v_not_void: v /= Void
v_parent_void: v.parent = Void
v_not_current: not same (v)
v_not_parent_of_current: not is_parent_recursive (v)
ensure EV_DYNAMIC_LIST
parent_is_current: v.parent = Current
v_is_last: v = last
count_increased: count = old count + 1
cursor_not_moved: (index = old index) or (after and old after)
dl_force (v: like item)
`v'
SEQUENCE
require SEQUENCE
extendible: extendible
ensure then SEQUENCE
new_count: count = old count + 1
item_inserted: has (v)
merge_left (other: like Current)
`other'
`other'
EV_DYNAMIC_LIST
require DYNAMIC_CHAIN
extendible: extendible
not_before: not before
other_exists: other /= Void
not_current: other /= Current
ensure DYNAMIC_CHAIN
new_count: count = old count + old other.count
new_index: index = old index + old other.count
other_is_empty: other.is_empty
merge_right (other: like Current)
`other'
`other'
EV_DYNAMIC_LIST
require DYNAMIC_CHAIN
extendible: extendible
not_after: not after
other_exists: other /= Void
not_current: other /= Current
ensure DYNAMIC_CHAIN
new_count: count = old count + old other.count
same_index: index = old index
other_is_empty: other.is_empty
put (v: like item)
`v'
replace
CHAIN
require COLLECTION
extendible: extendible
ensure COLLECTION
item_inserted: is_inserted (v)
ensure then SET
in_set_already: old has (v) implies (count = old count)
added_to_set: not old has (v) implies (count = old count + 1)
ensure then CHAIN
same_count: count = old count
put_front (v: like item)
`v'
EV_DYNAMIC_LIST
require EV_DYNAMIC_LIST
not_destroyed: not is_destroyed
extendible: extendible
v_not_void: v /= Void
v_parent_void: v.parent = Void
v_not_current: not same (v)
v_not_parent_of_current: not is_parent_recursive (v)
ensure EV_DYNAMIC_LIST
parent_is_current: v.parent = Current
v_is_first: v = first
count_increased: count = old count + 1
cursor_not_moved: (index = old index + 1) or (before and old before)
put_i_th (v: like item; i: INTEGER_32)
`i'`v'
EV_DYNAMIC_LIST
require EV_DYNAMIC_LIST
not_destroyed: not is_destroyed
valid_index: i > 0 and i <= count
v_not_void: v /= Void
v_parent_void: v.parent = Void
v_not_current: not same (v)
v_not_parent_of_current: not is_parent_recursive (v)
ensure EV_DYNAMIC_LIST
parent_is_current: v.parent = Current
item_replaced: v = i_th (i)
not_has_old_item: not has (old i_th (i))
old_item_parent_void: (old i_th (i)).parent = Void
count_same: count = old count
cursor_not_moved: index = old index
put_left (v: like item)
`v'
EV_DYNAMIC_LIST
require EV_DYNAMIC_LIST
not_destroyed: not is_destroyed
extendible: extendible
not_before: not before
v_not_void: v /= Void
v_parent_void: v.parent = Void
v_not_current: not same (v)
v_not_parent_of_current: not is_parent_recursive (v)
ensure EV_DYNAMIC_LIST
parent_is_current: v.parent = Current
v_at_index_plus_one: v = i_th (index - 1)
count_increased: count = old count + 1
cursor_not_moved: index = old index + 1
put_right (v: like item)
`v'
EV_DYNAMIC_LIST
require EV_DYNAMIC_LIST
not_destroyed: not is_destroyed
extendible: extendible
not_after: not after
v_not_void: v /= Void
v_parent_void: v.parent = Void
v_not_current: not same (v)
v_not_parent_of_current: not is_parent_recursive (v)
ensure EV_DYNAMIC_LIST
parent_is_current: v.parent = Current
v_at_index_plus_one: v = i_th (index + 1)
count_increased: count = old count + 1
cursor_not_moved: index = old index
replace (v: like item)
`v'
EV_DYNAMIC_LIST
require EV_DYNAMIC_LIST
not_destroyed: not is_destroyed
writable: writable
v_not_void: v /= Void
v_parent_void: v.parent = Void
v_not_current: not same (v)
v_not_parent_of_current: not is_parent_recursive (v)
ensure EV_DYNAMIC_LIST
parent_is_current: v.parent = Current
item_replaced: v = item
not_has_old_item: not has (old item)
old_item_parent_void: (old item).parent = Void
count_same: count = old count
cursor_not_moved: index = old index
set_data (some_data: like data)
`some_data'data
EV_ANY
require EV_ANY
not_destroyed: not is_destroyed
ensure EV_ANY
data_assigned: data = some_data
swap (i: INTEGER_32)
`i'
EV_DYNAMIC_LIST
require CHAIN
not_off: not off
valid_index: valid_index (i)
ensure CHAIN
swapped_to_item: item = old i_th (i)
swapped_from_item: i_th (i) = old item
feature
prune (v: like item)
`v'
`v'
EV_DYNAMIC_LIST
require COLLECTION
prunable: prunable
ensure then 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)
ensure then EV_DYNAMIC_LIST
not_has_v: not has (v)
had_item_implies_parent_void: old has (v) implies v.parent = Void
had_item_implies_count_decreased: old has (v) implies count = old count - 1
had_item_and_was_after_implies_index_decreased: (old after and old has (v)) implies index = old index - 1
prune_all (v: like item)
`v'
object_comparison
exhausted
DYNAMIC_CHAIN
require COLLECTION
prunable: prunable
ensure COLLECTION
no_more_occurrences: not has (v)
ensure then DYNAMIC_CHAIN
is_exhausted: exhausted
remove
after
EV_DYNAMIC_LIST
require ACTIVE
prunable: prunable
writable: writable
ensure then DYNAMIC_LIST
after_when_empty: is_empty implies after
ensure then EV_DYNAMIC_LIST
v_removed: not has (old item)
parent_void: (old item).parent = Void
count_decreased: count = old count - 1
index_same: index = old index
remove_left
EV_DYNAMIC_LIST
require DYNAMIC_CHAIN
left_exists: index > 1
ensure DYNAMIC_CHAIN
new_count: count = old count - 1
new_index: index = old index - 1
ensure then EV_DYNAMIC_LIST
left_neighbor_removed: not has (old i_th (index - 1))
parent_void: (old i_th (index - 1)).parent = Void
index_decreased: index = old index - 1
remove_right
EV_DYNAMIC_LIST
require DYNAMIC_CHAIN
right_exists: index < count
ensure DYNAMIC_CHAIN
new_count: count = old count - 1
same_index: index = old index
ensure then EV_DYNAMIC_LIST
right_neighbor_removed: not has (old i_th (index + 1))
parent_void: (old i_th (index + 1)).parent = Void
index_same: index = old index
wipe_out
EV_DYNAMIC_LIST
require COLLECTION
prunable: prunable
ensure COLLECTION
wiped_out: is_empty
ensure then DYNAMIC_LIST
is_before: before
feature
linear_representation: LINEAR [EV_TREE_NODE]
LINEAR
require CONTAINER
True
feature
copy (other: like Current)
`other'
EV_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
changeable_comparison_criterion: BOOLEAN is False
object_comparison
EV_ITEM_LIST
feature
recursive_do_all (action: PROCEDURE [ANY, TUPLE [EV_TREE_NODE]])
`action'
`action'
require
action_not_void: action /= Void
feature
destroy
`Current'
EV_ANY
ensure EV_ANY
is_destroyed: is_destroyed
feature
is_parent_recursive (a_list: like item): BOOLEAN
`a_list'`Current'
EV_DYNAMIC_LIST
require EV_DYNAMIC_LIST
a_list_not_void: a_list /= Void
not_destroyed: not is_destroyed
same (other: EV_ANY): BOOLEAN
`other'`Current'
EV_DYNAMIC_LIST
feature
do_all (action: PROCEDURE [ANY, TUPLE [EV_TREE_NODE]])
`action'
`action'
LINEAR
require TRAVERSABLE
action_exists: action /= Void
do_if (action: PROCEDURE [ANY, TUPLE [EV_TREE_NODE]]; test: FUNCTION [ANY, TUPLE [EV_TREE_NODE], BOOLEAN])
`action'`test'
`action'`test'
LINEAR
require TRAVERSABLE
action_exists: action /= Void
test_exits: test /= Void
for_all (test: FUNCTION [ANY, TUPLE [EV_TREE_NODE], BOOLEAN]): BOOLEAN
`test'
`test'
LINEAR
require TRAVERSABLE
test_exits: test /= Void
ensure then LINEAR
empty: is_empty implies Result
there_exists (test: FUNCTION [ANY, TUPLE [EV_TREE_NODE], BOOLEAN]): BOOLEAN
`test'
`test'
LINEAR
require TRAVERSABLE
test_exits: test /= Void
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
feature
is_destroyed: BOOLEAN
`Current'
EV_ANY
ensure EV_ANY
bridge_ok: Result = implementation.is_destroyed
invariant
EV_ITEM_LIST
parent_of_items_is_current: is_usable and then not is_empty implies parent_of_items_is_current
items_unique: is_usable and not is_empty implies items_unique
EV_ANY
is_initialized: is_initialized
is_coupled: implementation /= Void and then implementation.interface = Current
default_create_called: default_create_called
ANY
reflexive_equality: standard_is_equal (Current)
reflexive_conformance: conforms_to (Current)
LIST
before_definition: before = (index = 0)
after_definition: after = (index = count + 1)
CHAIN
non_negative_index: index >= 0
index_small_enough: index <= count + 1
off_definition: off = ((index = 0) or (index = count + 1))
isfirst_definition: isfirst = ((not is_empty) and (index = 1))
islast_definition: islast = ((not is_empty) and (index = count))
item_corresponds_to_index: (not off) implies (item = i_th (index))
index_set_has_same_count: index_set.count = count
ACTIVE
writable_constraint: writable implies readable
empty_constraint: is_empty implies (not readable) and (not writable)
INDEXABLE
index_set_not_void: index_set /= Void
BILINEAR
not_both: not (after and before)
before_constraint: before implies off
LINEAR
after_constraint: after implies off
TRAVERSABLE
empty_constraint: is_empty implies off
FINITE
empty_definition: is_empty = (count = 0)
non_negative_count: count >= 0
DYNAMIC_CHAIN
extendible: extendible
indexing
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 EV_TREE_NODE_LIST