nästa upp förra
Nästa: Programkommentar Upp: Modellkommentar Förra: Form

Innehåll

Modellkommentaren ska beskriva modellen för ADT:n eller det paket som tillhandahålls. Om det är en lista som beskrivs så måste man tala om vilken modell som gäller för listan. Är den cirkulär eller linjär? Finns det vaktpostpositioner utanför elementdelen av listan? Vad händer vid insättning? O.s.v. o.s.v.

De typinvarianter som finns för typen, ska även de vara specificerade i modellkommentaren (i DESCRIPTION-delen).

Modellkommentar för en list-ADT

NAME 
  List -- A list abstract datatype

SYNOPSIS
  cc [flags] files List.o [libraries]

  #include "List.h"

DESCRIPTION
  The List abstract datatype is a linear sequence of elements, where you 
  can insert and remove elements anywhere. 

  Each element in the list has a unique index. The first element
  has index 0 (zero), and the last element has index (size - 1).

  For every element, there is also an abstract index, called a position.
  The postion acts somewhat like the address of the element in the list.

  There are two special positions in every list, even if it is empty. 
  The position before the position of the first element (the before-position)
  and the position after the position of the last element (the after-position).
  Therefore an empty list consists of two positions. 

  The capacity of the list may be unlimited (an unbounded list) or
  limited (a bounded list). An unbounded list is defined by capacity == -1.
  When querying the size and capacity of the list, the special positions 
  do not count.

  Insertions push all elements from and including the given position
  one step to the right (to a higher index) to make room for the new
  element.

  Removals removes the element in question, and all the elements with
  higher index slides down (one index).

AUTHOR
  Jonas Mölsä       <jbm@nada.kth.se> (interface and documentation)
  Richard Spångberg <rsp@nada.kth.se> (interface and documentation)

VERSION
  2.0



Jonas Mölsä
Sat Sep 13 13:46:34 MET DST 1997