package octez-libs
Install
dune-project
Dependency
Authors
Maintainers
Sources
sha256=aa2f5bc99cc4ca2217c52a1af2a2cdfd3b383208cb859ca2e79ca0903396ca1d
sha512=d68bb3eb615e3dcccc845fddfc9901c95b3c6dc8e105e39522ce97637b1308a7fa7aa1d271351d5933febd7476b2819e1694f31198f1f0919681f1f9cc97cb3a
doc/octez-libs.base/Tezos_base/Skip_list/Make/Make_monadic/index.html
Module Make.Make_monadicSource
This functor can be used to build monadic functions for the skip list.
Parameters
Signature
val find :
deref:('ptr -> ('content, 'ptr) cell option M.t) ->
cell_ptr:'ptr ->
target_index:Z.t ->
('content, 'ptr) cell option M.tfind ~deref ~cell_ptr ~target_index returns Some cell where cell is the cell at position target_index. This is done by dereferencing the last pointer of the path returned by back_path.
val back_path :
deref:('ptr -> ('content, 'ptr) cell option M.t) ->
cell_ptr:'ptr ->
target_index:Z.t ->
'ptr list option M.tback_path ~deref ~cell_ptr ~target_index returns Some path where path is a sequence of back pointers to traverse to go from cell_ptr to the cell at position target_index in the sequence denoted by (deref, cell_ptr).
val valid_back_path :
equal_ptr:('ptr -> 'ptr -> bool) ->
deref:('ptr -> ('content, 'ptr) cell option M.t) ->
cell_ptr:'ptr ->
target_ptr:'ptr ->
'ptr list ->
bool M.tvalid_back_path ~equal_ptr ~deref ~cell_ptr ~target_ptr path returns true iff path is a valid and minimal path from cell_ptr to target_ptr in the skip list denoted by (deref, cell_ptr).
val search :
deref:('ptr -> ('content, 'ptr) cell option M.t) ->
compare:('content -> int) ->
cell:('content, 'ptr) cell ->
('content, 'ptr) search_result M.tsearch ~deref ~compare ~cell allows to find a cell of the skip list according to its content. This function assumes that the content of the cells is in increasing order according to the ordering defined by the function compare. In other words, this function assumes that compare is a function that returns a negative integer for cells before the target and a positive integer for cells after the target. The value returned by this function is {rev_path; last_cell} such that.
rev_path = []if and only ifcompare (content cell) > 0
- For all the cases below, if there is a path from cell
Ato cellB,rev_pathcontains the list of cells to go fromBtoA. Consequently, the first element ofrev_pathisB. Except forNearest_lower, this path is a minimal path.
last_pointer = Deref_returned_noneifdereffails to associate a cell to a pointer during the search. In that case,rev_pathis a path fromcelltocandidatewherecandidateis the last cell for which candidate did not fail and such thatcompare (content (candidate)) > 0.
last_pointer = No_exact_or_lower_ptrif for all cell of the skip list,compare (content cell) > 0. In that case,rev_pathis a path fromcellto the genesis cell.
last_pointer = Found targetif there is a celltargetsuch thatcompare (content target) = 0and a path fromcelltotarget. In that case,rev_pathis the minimal path fromcelltotarget.
last_pointer = Nearest_lower {lower;upper}if there is no cell in the skip list such thatcompare (content cell) = 0. In that caseloweris the unique cell such thatcompare (content lower) < 0and for all other cellscandidatesuch thatcompare (content candidate) < 0then there is a path fromlowertocandidate.upper, if it exists is the successor cell tolower, i.e.deref ((back_pointer upper) 0) = Some lower. In that case,rev_pathis a path fromcelltolower. This path is *NOT* minimal but almost. The path is minimal fromcelltoupper=Some up. By minimality, the path is logarithmic. Consequently, since there is a direct pointer fromuptolower, the passe toloweris also logarithmic.