Cache (BioFSharp.Mz) | BioFSharp.Mz

BioFSharp.Mz

Cache Module

Namespace: BioFSharp.Mz
Assembly: BioFSharp.Mz.dll

Types

Type	Description
Border
Cache<'a, 'b>	Wraps a SortedList to be used as a in memory cache. Especially usefull if computed theoretical fragmentation pattern or spectra are to be reused

Functions and values

Function or value	Description
`addItem cache (arg2, arg3)` Full Usage: `addItem cache (arg2, arg3)` Parameters: cache : `Cache<'a, 'b>` arg1 : `'a` arg2 : `'b`	Adds item to the Cache cache : `Cache<'a, 'b>` arg1 : `'a` arg2 : `'b`
`binarySearch border cache value` Full Usage: `binarySearch border cache value` Parameters: border : `Border` cache : `Cache<'a, 'b>` value : `'a` Returns: `int`	border : `Border` cache : `Cache<'a, 'b>` value : `'a` Returns: `int`
`bulkDeleteBy cache cutOff` Full Usage: `bulkDeleteBy cache cutOff` Parameters: cache : `Cache<'a, 'b>` cutOff : `'a` Returns: `Cache<'a, 'a0>`	Deletes list of items to the cache. Deletes all items with a key smaller than the defined cutOff. cache : `Cache<'a, 'b>` cutOff : `'a` Returns: `Cache<'a, 'a0>`
`bulkInsertBy cache items` Full Usage: `bulkInsertBy cache items` Parameters: cache : `Cache<'a, 'b>` items : `('a * 'b) list` Returns: `unit list`	Adds list of items to the cache cache : `Cache<'a, 'b>` items : `('a * 'b) list` Returns: `unit list`
`containsItemsBetween cache (arg2, arg3)` Full Usage: `containsItemsBetween cache (arg2, arg3)` Parameters: cache : `Cache<'a, 'b>` arg1 : `'a` arg2 : `'a` Returns: `(int * int) option`	Returns the indices of the items in the sorted cache including items at the border of the input range of keys. cache : `Cache<'a, 'b>` arg1 : `'a` arg2 : `'a` Returns: `(int * int) option`
`createCache` Full Usage: `createCache` Returns: `Cache<'a, 'b>`	Creates cache with default constructor Returns: `Cache<'a, 'b>`
`createCacheWith comparer capacity` Full Usage: `createCacheWith comparer capacity` Parameters: comparer : `IComparer<'a>` capacity : `int` Returns: `Cache<'a, 'b>`	Creates cache with defined comparer and defined capacity of items the list can contain, gets automatically increased if the limit is reached. comparer : `IComparer<'a>` capacity : `int` Returns: `Cache<'a, 'b>`
`createCacheWithCap capacity` Full Usage: `createCacheWithCap capacity` Parameters: capacity : `int` Returns: `Cache<'a, 'b>`	Creates cache with defined capacity of items the list can contain, gets automatically increased if the limit is reached. capacity : `int` Returns: `Cache<'a, 'b>`
`createCacheWithComp comparer` Full Usage: `createCacheWithComp comparer` Parameters: comparer : `IComparer<'a>` Returns: `Cache<'a, 'b>`	Creates cache with defined comparer comparer : `IComparer<'a>` Returns: `Cache<'a, 'b>`
`getItemBy cache key` Full Usage: `getItemBy cache key` Parameters: cache : `Cache<'a, 'b>` key : `'a` Returns: `bool * 'b`	Returns with defined key cache : `Cache<'a, 'b>` key : `'a` Returns: `bool * 'b`
`getItemsByIdx cache (arg2, arg3)` Full Usage: `getItemsByIdx cache (arg2, arg3)` Parameters: cache : `Cache<'a, 'b>` arg1 : `int` arg2 : `int` Returns: `('a * 'b) list`	Returns list of items with indices in the defined range. cache : `Cache<'a, 'b>` arg1 : `int` arg2 : `int` Returns: `('a * 'b) list`
`getItemsByRange cache (arg2, arg3)` Full Usage: `getItemsByRange cache (arg2, arg3)` Parameters: cache : `Cache<'a, 'b>` arg1 : `'a` arg2 : `'a` Returns: `('a * 'b) list`	Returns list of items with keys in the defined range. cache : `Cache<'a, 'b>` arg1 : `'a` arg2 : `'a` Returns: `('a * 'b) list`
`getValuesBy cache (arg2, arg3)` Full Usage: `getValuesBy cache (arg2, arg3)` Parameters: cache : `Cache<'a, 'b>` arg1 : `'a` arg2 : `'a` Returns: `'b list`	Returns list of values of items with keys in the defined range. cache : `Cache<'a, 'b>` arg1 : `'a` arg2 : `'a` Returns: `'b list`
`getValuesByIdx cache (arg2, arg3)` Full Usage: `getValuesByIdx cache (arg2, arg3)` Parameters: cache : `Cache<'a, 'b>` arg1 : `int` arg2 : `int` Returns: `'b list`	Returns list of values of items with indices in the defined range. cache : `Cache<'a, 'b>` arg1 : `int` arg2 : `int` Returns: `'b list`