Class DS_INDEXED_CURSOR PreviousNext

note
description:

    "Indexed cursors for data structure traversals"

library:    "Gobo Eiffel Structure Library"
author:     "Eric Bezault <ericb@gobosoft.com>"
copyright:  "Copyright (c) 1999, Eric Bezault and others"
license:    "MIT License"
deferred class interface
DS_INDEXED_CURSOR [G]
inherit
DS_CURSOR [G]
feature -- Access
item: G
        -- Item at cursor position
        -- (From DS_CURSOR.)
    require
        not_off: not off
    deferred
index: INTEGER
        -- Index of current position
    deferred
    ensure
        valid_index: valid_index (Result)
container: DS_TRAVERSABLE [G]
        -- Data structure traversed
        -- (From DS_CURSOR.)
    deferred
feature -- Status report
off: BOOLEAN
        -- Is there no item at cursor position?
        -- (From DS_CURSOR.)
    deferred
same_position (other: like Current): BOOLEAN
        -- Is current cursor at same position as other?
        -- (From DS_CURSOR.)
    require
        other_not_void: other /= Void
    deferred
valid_index (i: INTEGER): BOOLEAN
        -- Is i a valid index value?
    deferred
feature -- Cursor movement
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)
    deferred
    ensure
        same_position: same_position (other)
go_i_th (i: INTEGER)
        -- Move cursor to i-th position.
    require
        valid_index: valid_index (i)
    deferred
    ensure
        moved: index = i
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.)
end -- class DS_INDEXED_CURSOR

Copyright 1999, Eric Bezault
mailto:
ericb@gobosoft.com
http:
//www.gobosoft.com
Last Updated: 31 July 1999

HomeTocPreviousNext