src/TCollection/TCollection.cdl

   1 -- Created on: 1992-10-13
   2 -- Created by: Ramin BARRETO
   3 -- Copyright (c) 1992-1999 Matra Datavision
   4 -- Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 --
   6 -- This file is part of Open CASCADE Technology software library.
   7 --
   8 -- This library is free software; you can redistribute it and/or modify it under
   9 -- the terms of the GNU Lesser General Public License version 2.1 as published
  10 -- by the Free Software Foundation, with special exception defined in the file
  11 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 -- distribution for complete text of the license and disclaimer of any warranty.
  13 --
  14 -- Alternatively, this file may be used under the terms of Open CASCADE
  15 -- commercial license or contractual agreement.
  16
  17 -- Updated      J.P. TIRAULT, M. MERCIEN Nov,25 1992
  18 --              Adding classes
  19 --               - Array1
  20 --               - Array2
  21 -- Updated      R.LEQUETTE Jan 1993
  22 --              Adding of modifying classes
  23 --               - Sequence, HSequence
  24 --               - Set, HSet
  25 --               - List
  26 --               - BasicMap, BasicMapIterator
  27 --               - Map, DataMap, DoubleMap, IndexedMap, IndexedDataMap
  28
  29 package TCollection
  30
  31         ---Purpose: The package <TCollection> provides the services for the
  32         -- transient basic data structures.
  33
  34 uses
  35     Standard,
  36     MMgt
  37 is
  38     class AsciiString;
  39
  40     class ExtendedString;
  41
  42     class HAsciiString;
  43
  44     class HExtendedString;
  45
  46     generic class Array1;
  47
  48     generic class HArray1;
  49
  50     generic class Array2;
  51
  52     generic class HArray2;
  53
  54     generic class List, ListNode, ListIterator;
  55         ---Purpose: A single list handled by value.
  56
  57     class BaseSequence;
  58     class SeqNode;
  59     pointer SeqNodePtr to SeqNode from TCollection;
  60     generic class Sequence,SequenceNode;
  61         ---Purpose: An indexed double list handled by value.
  62
  63     generic class HSequence;
  64         ---Purpose: An indexed double list handle by reference.
  65
  66     generic class Set, SetIterator, SetList;
  67         ---Purpose: A small set handled by value.
  68
  69     generic class HSet;
  70         ---Purpose: A small set handled by reference.
  71
  72     generic class MapHasher;
  73         ---Purpose: A Tool to instantiate Maps. Providing HashCode and
  74         -- Comparisons on Keys.
  75
  76     private deferred class BasicMap;
  77     private class MapNode;
  78     pointer MapNodePtr to MapNode from TCollection;
  79     ---Purpose: Basic class root of all the Maps.
  80
  81     private deferred class BasicMapIterator;
  82         ---Purpose: Basic class root of all the Iterators on Maps.
  83
  84     generic class Map, MapIterator,StdMapNode;
  85         ---Purpose: A Hashed map to store keys.
  86
  87     generic class DataMap, DataMapIterator,DataMapNode;
  88         ---Purpose: A Map where data can be stored with the keys.
  89
  90     generic class DoubleMap, DoubleMapIterator, DoubleMapNode;
  91         ---Purpose: A Map to store pair of keys.
  92
  93     generic class IndexedMap,IndexedMapNode;
  94         ---Purpose: A Map where the keys are indexed.
  95
  96     generic class IndexedDataMap,IndexedDataMapNode;
  97         ---Purpose: An Indexed Map where data can be stored with the keys.
  98
  99     enumeration Side is Left , Right;
 100
 101     deferred generic class Compare ;
 102         ---Purpose: Defines a comparison operator which can be used by
 103         -- any ordered structure.   The  way to compare items
 104         -- has  to be described  in  subclasses, which  herit
 105         -- from instantiations of Compare.
 106
 107     private deferred class PrivCompareOfInteger
 108             instantiates Compare from TCollection(Integer from Standard);
 109
 110     private deferred class PrivCompareOfReal
 111             instantiates Compare from TCollection(Real from Standard);
 112
 113     class CompareOfInteger;
 114
 115     class CompareOfReal;
 116
 117
 118     NextPrimeForMap(I : Integer) returns Integer;
 119         ---Purpose: Returns a  prime number greater than  <I> suitable
 120         -- to dimension a Map.  When  <I> becomes great there
 121         -- is  a  limit on  the  result (today  the  limit is
 122         -- around 1 000 000). This is not a limit of the number of
 123         -- items but a limit in the number  of buckets.  i.e.
 124         -- there will be more collisions  in  the map.
 125
 126 end TCollection;
 127
 128
 129
 130
 131
 132