Class DS_MULTIARRAYED_SPARSE_SET_CURSOR PreviousNext

note
description:

    "Cursors for multi-arrayed sparse set traversals"

library:    "Gobo Eiffel Structure Library"
author:     "Eric Bezault <ericb@gobosoft.com>"
copyright:  "Copyright (c) 2001, Eric Bezault and others"
license:    "MIT License"
class interface
DS_MULTIARRAYED_SPARSE_SET_CURSOR [G]
inherit
DS_SPARSE_SET_CURSOR [G]
    DS_SET_CURSOR [G]
        DS_LINEAR_CURSOR [G]
            DS_CURSOR [G]
    DS_BILINEAR_CURSOR [G]
        DS_LINEAR_CURSOR [G]
            DS_CURSOR [G]
create
make (a_set: like container)
        -- Create a new cursor for a_set.
    require
        a_set_not_void: a_set /= Void
    ensure
        container_set: container = a_set
        before: before
feature -- Access
item: G
        -- Item at cursor position
        -- (From DS_CURSOR.)
    require
        not_off: not off
container: DS_MULTIARRAYED_SPARSE_SET [G]
        -- Set traversed
        -- (From DS_CURSOR.)
feature -- Status report
is_first: BOOLEAN
        -- Is cursor on first item?
        -- (From DS_LINEAR_CURSOR.)
    ensure
        not_empty: Result implies not container.is_empty
        not_off: Result implies not off
        definition: Result implies (item = container.first)
is_last: BOOLEAN
        -- Is cursor on last item?
        -- (From DS_BILINEAR_CURSOR.)
    ensure
        not_empty: Result implies not container.is_empty
        not_off: Result implies not off
        definition: Result implies (item = container.last)
after: BOOLEAN
        -- Is there no valid position to right of cursor?
        -- (From DS_LINEAR_CURSOR.)
before: BOOLEAN
        -- Is there no valid position to left of cursor?
        -- (From DS_BILINEAR_CURSOR.)
off: BOOLEAN
        -- Is there no item at cursor position?
        -- (From DS_CURSOR.)
same_position (other: like Current): BOOLEAN
        -- Is current cursor at same position as other?
        -- (From DS_CURSOR.)
    require
        other_not_void: other /= Void
feature -- Cursor movement
start
        -- Move cursor to first position.
        -- (From DS_LINEAR_CURSOR.)
    ensure
        empty_behavior: container.is_empty implies after
        not_empty_behavior: not container.is_empty implies is_first
finish
        -- Move cursor to last position.
        -- (From DS_BILINEAR_CURSOR.)
    ensure
        empty_behavior: container.is_empty implies before
        not_empty_behavior: not container.is_empty implies is_last
forth
        -- Move cursor to next position.
        -- (From DS_LINEAR_CURSOR.)
    require
        not_after: not after
back
        -- Move cursor to previous position.
        -- (From DS_BILINEAR_CURSOR.)
    require
        not_before: not before
search_forth (v: G)
        -- Move to first position at or after current
        -- position where item and v are equal.
        -- (Use equality_tester's criterion from container
        -- if not void, use `=' criterion otherwise.)
        -- Move after if not found.
        -- (From DS_LINEAR_CURSOR.)
    require
        not_off: not off or after
search_back (v: G)
        -- Move to first position at or before current
        -- position where item and v are equal.
        -- (Use equality_tester's criterion from container
        -- if not void, use `=' criterion otherwise.)
        -- Move before if not found.
        -- (From DS_BILINEAR_CURSOR.)
    require
        not_off: not off or before
go_after
        -- Move cursor to after position.
        -- (From DS_LINEAR_CURSOR.)
    ensure
        after: after
go_before
        -- Move cursor to before position.
        -- (From DS_BILINEAR_CURSOR.)
    ensure
        before: before
go_to (other: like Current)
        -- Move cursor to other's position.
        -- (From DS_CURSOR.)
    require
        other_not_void: other /= Void
        valid_cursor: container.valid_cursor (other)
    ensure
        same_position: same_position (other)
feature -- Comparison
is_equal (other: like Current): BOOLEAN
        -- Are other and current cursor at the same position?
        -- (From GENERAL.)
    require
        other_not_void: other /= Void
    ensure
        consistent: standard_is_equal (other) implies Result
        same_type: Result implies same_type (other)
        symmetric: Result implies other.is_equal (Current)
feature -- Duplication
copy (other: like Current)
        -- Copy other to current cursor.
        -- (From GENERAL.)
    require
        other_not_void: other /= Void
        type_identity: same_type (other)
    ensure
        is_equal: is_equal (other)
invariant
container_not_void: container /= Void
empty_constraint: container.is_empty implies off
    -- (From DS_CURSOR.)
after_constraint: after implies off
    -- (From DS_LINEAR_CURSOR.)
not_both: not (after and before)
before_constraint: before implies off
    -- (From DS_BILINEAR_CURSOR.)
end -- class DS_MULTIARRAYED_SPARSE_SET_CURSOR

Copyright 2001, Eric Bezault
mailto:
ericb@gobosoft.com
http:
//www.gobosoft.com
Last Updated: 6 April 2001

HomeTocPreviousNext