include/opencascade/TCollection.hxx

0001 // Created on: 1992-10-13
0002 // Created by: Ramin BARRETO
0003 // Copyright (c) 1992-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _TCollection_HeaderFile
0018 #define _TCollection_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 //! The package <TCollection> provides the services for the
0025 //! transient basic data structures.
0026 class TCollection
0027 {
0028 public:
0029
0030   DEFINE_STANDARD_ALLOC
0031
0032   //! Returns a  prime number greater than  <I> suitable
0033   //! to dimension a Map.  When  <I> becomes great there
0034   //! is  a  limit on  the  result (today  the  limit is
0035   //! around 1 000 000). This is not a limit of the number of
0036   //! items but a limit in the number  of buckets.  i.e.
0037   //! there will be more collisions  in  the map.
0038   Standard_EXPORT static Standard_Integer NextPrimeForMap (const Standard_Integer I);
0039
0040 };
0041
0042 #endif // _TCollection_HeaderFile