CL Enumerations: Standard Generic Function RESET
 

Generic function RESET

Package:

CL.EXTENSIONS.ENUMERATIONS

Syntax:

  reset enumeration
  => object
  

Arguments and Values:

enumeration---an enumeration instance

object---an object

Description:

The generic function RESET changes the internal state of the enumeration to its "initial" element.

Examples:

  cl-prompt> (defvar *se* (enumerate "foobar" :start 2))
  *SE*

  cl-prompt> (loop repeat 3 do (print (next *se*)))
  #\o
  #\b
  #\a
  NIL

  cl-prompt> (current *se*)
  #\r

  cl-prompt> (reset *se*)
  2

  cl-prompt> (current *se*)
  #\o

  cl-prompt> (loop repeat 3 do (print (next *se*)))
  #\o
  #\b
  #\a
  NIL
  

Affected By:

The internal state of enumeration.

Exceptional Situations:

None.

See Also:

ENUMERATION class, BOUNDED-ENUMERATION, NUMBER-ENUMERATION, BI-DIRECTIONAL-ENUMERATION, SEQUENCE-ENUMERATION, LIST-ENUMERATION, ARRAY-ENUMERATION, VECTOR-ENUMERATION, STRING-ENUMERATION, HASH-TABLE-ENUMERATION, NO-SUCH-ELEMENT.

Notes:

None.