package res

You can search for identifiers within the package.

in-package search v0.2.0

res
- Library res
  - Res
    
    DefStrat
    
    BitDefStrat
    
    Array
    
    Strategy
    
    Floats
    
    Strategy
    
    Bits
    
    Strategy
    
    Weak
    
    Strategy
    
    Buffer
    
    Strategy
    
    MakeArray
    
    Strategy
    
    MakeFloats
    
    Strategy
    
    MakeBits
    
    Strategy
    
    MakeWeak
    
    Strategy
    
    MakeBuffer
    
    Strategy
- Sources
  - res
    
    nopres_impl.ml
    
    nopres_intf.ml
    
    pres_impl.ml
    
    pres_intf.ml
    
    res.ml
    
    res__.ml
    
    strat.ml
    
    weak_impl.ml
    
    weak_intf.ml

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `Res.DefStrat`Source

Default strategy for resizable datastructures

type t is a triple (waste, shrink_trig, min_size), where waste (default: 1.5) indicates how much the array should grow in excess when reallocation is triggered, shrink_trig (default: 0.5) at which percentage of excess elements it should be shrunk and min_size (default: 16 elements) is the minimum size of the resizable array.

Sourcetype t = float * float * int

The abstract type of strategies.

Sourceval default : t

Default strategy of this strategy implementation.

Sourceval grow : t -> int -> int

grow strat new_len

returns
the new real length of some contiguous datastructure using strategy strat given new virtual length new_len. The user should then use this new real length to resize the datastructure.

Be careful, the new (real) length must be larger than the new virtual length, otherwise your program will crash!

Sourceval shrink : t -> real_len:int -> new_len:int -> int

shrink strat ~real_len ~new_len

returns
the new real length of a resizable datastructure given its current real length real_len and its required new virtual length new_len wrt. strategy strat. The user should then use this new real length to resize the datastructure. If -1 is returned, it is not necessary to resize.

Be careful, the new (real) length must be larger than the new virtual length new_len, otherwise your program may crash!

package res

Module Res.DefStratSource

Module `Res.DefStrat`Source