Changeset 50

Show
Ignore:
Timestamp:
01/19/08 10:56:33
Author:
hobu
Message:

update ReST

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • spatialindex/trunk/README

    r49 r50  
    213213initialization, follows: 
    214214 
    215     ---------   -------- ------------------ 
    216     Property      Type     Description 
    217     ---------   -------- ------------------ 
    218  1. FileName    VT_PCHAR The base name of the file to open (no extension) 
    219  2. Overwrite   VT_BOOL  If Overwrite is true and a storage manager with the  
    220                          specified filename already exists, it will be  
    221                          truncated and overwritten. All data will be lost. 
    222  3. PageSize    VT_ULONG The page size to use. If the specified filename  
    223                          already exists and Overwrite is false, PageSize is ignored. 
    224     ---------   -------- ------------------ 
     215---------   -------- ------------------ 
     216Property      Type     Description 
     217---------   -------- ------------------ 
     218FileName    VT_PCHAR The base name of the file to open (no extension) 
     219Overwrite   VT_BOOL  If Overwrite is true and a storage manager with the  
     220                     specified filename already exists, it will be  
     221                     truncated and overwritten. All data will be lost. 
     222PageSize    VT_ULONG The page size to use. If the specified filename  
     223                     already exists and Overwrite is false, PageSize is ignored. 
     224---------   -------- ------------------ 
    225225 
    226226For entities that are larger than the page size, multiple pages are used.  
    …… 
    241241will be lost due to a stale .idx file. Avoiding such disasters is future work. 
    242242 
    243  SpatialIndex Interfaces 
     243SpatialIndex Interfaces 
    244244------------------------------------------------------------------------------ 
    245245 
    …… 
    334334results. 
    335335 
    336  The RTree Package 
     336The RTree Package 
    337337------------------------------------------------------------------------------ 
    338338 
    …… 
    366366complying with the following property strings: 
    367367 
    368     -----------------------    --------  ----------------------------------------------- 
    369     Property                    Type      Description 
    370     -----------------------    --------  ----------------------------------------------- 
    371     IndexIndentifier           VT_LONG   If specified an existing index will be  
    372                                          opened from the supplied storage manager with  
    373                                          the given index id. Behavior is unspecified 
    374                                          if the index id or the storage manager are incorrect. 
    375     Dimension                  VT_ULONG  Dimensionality of the data that will be inserted. 
    376     IndexCapacity              VT_ULONG  The index node capacity. Default is 100. 
    377     LeafCapactiy               VT_ULONG  The leaf node capacity. Default is 100. 
    378     FillFactor                 VT_DOUBLE The fill factor. Default is 70% 
    379     TreeVariant                VT_LONG   Can be one of Linear, Quadratic or Rstar. Default is Rstar 
    380     NearMinimumOverlapFactor   VT_ULONG  Default is 32. 
    381     SplitDistributionFactor    VT_DOUBLE Default is 0.4 
    382     ReinsertFactor             VT_DOUBLE Default is 0.3 
    383     EnsureTightMBRs            VT_BOOL   Default is true 
    384     IndexPoolCapacity          VT_LONG   Default is 100 
    385     LeafPoolCapacity           VT_LONG   Default is 100 
    386     RegionPoolCapacity         VT_LONG   Default is 1000 
    387     PointPoolCapacity          VT_LONG   Default is 500 
    388     -----------------------    --------  ----------------------------------------------- 
     368-----------------------    --------  ----------------------------------------------- 
     369Property                    Type      Description 
     370-----------------------    --------  ----------------------------------------------- 
     371IndexIndentifier           VT_LONG   If specified an existing index will be  
     372                                     opened from the supplied storage manager with  
     373                                     the given index id. Behavior is unspecified 
     374                                     if the index id or the storage manager are incorrect. 
     375Dimension                  VT_ULONG  Dimensionality of the data that will be inserted. 
     376IndexCapacity              VT_ULONG  The index node capacity. Default is 100. 
     377LeafCapactiy               VT_ULONG  The leaf node capacity. Default is 100. 
     378FillFactor                 VT_DOUBLE The fill factor. Default is 70% 
     379TreeVariant                VT_LONG   Can be one of Linear, Quadratic or Rstar. Default is Rstar 
     380NearMinimumOverlapFactor   VT_ULONG  Default is 32. 
     381SplitDistributionFactor    VT_DOUBLE Default is 0.4 
     382ReinsertFactor             VT_DOUBLE Default is 0.3 
     383EnsureTightMBRs            VT_BOOL   Default is true 
     384IndexPoolCapacity          VT_LONG   Default is 100 
     385LeafPoolCapacity           VT_LONG   Default is 100 
     386RegionPoolCapacity         VT_LONG   Default is 1000 
     387PointPoolCapacity          VT_LONG   Default is 500 
     388-----------------------    --------  ----------------------------------------------- 
    389389 
    390390