hashheap 0.2.2

data structures that combine a hashmap and a min/max priority heap, with main operations requiring O(1) or O(log n) time.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
/*  custom "hashheap", version 2.  no cloning or Rc required.


Theory stuff:

For heap of size n there are always (n+1)/2 leaves
So there are n-(n+1)/2 = non-leaves
*/

#![allow(dead_code)]
#![allow(unused_variables)]
#![allow(non_snake_case)]
#![allow(non_camel_case_types)]
#![allow(unused_parens)]
#![allow(unused_mut)]
#![allow(unused_assignments)]
#![allow(unused_doc_comments)]
#![allow(unused_imports)]
use std::collections::{HashMap,HashSet};
use std::collections::hash_map::RandomState;
use std::hash::{Hash,Hasher,BuildHasher};
use std::cmp::Ord;

const DEFAULTCAP:usize = 16;

//// independent functions for heap indices:
fn left(i:usize) -> usize { 2*i+1 }
fn right(i:usize) -> usize { 2*i+2 }
fn parent(i:usize) -> usize { if i>0 {(i-1)/2} else {0} }

fn derive_hash<T:Hash+Eq>(rs:&mut RandomState, key:&T) -> usize
{
   //let mut rs = hs.hasher() as & dyn std::hash::BuildHasher<Hasher:Hasher>;
   //let mut rs = RandomState::new();
   let mut bs = rs.build_hasher();
   key.hash(&mut bs);
   bs.finish() as usize
}


pub struct HashHeap<KT:Hash+Eq, VT:Ord>
{
   keys: Vec<Option<KT>>,  // None means once occupied
   vals : Vec<(VT,usize)>, // with inverse hash index (for map)
   userhash : fn(&KT) -> usize,
   rehash : fn(usize, usize) -> usize, // hashi,collisions -> newhashi
   kmap : HashMap<usize,(usize,usize)>, // hashindex to (ki,vi)
   lessthan : fn(&VT,&VT) -> bool,
   autostate : Option<RandomState>,
}
impl<KT:Hash+Eq, VT:Ord> HashHeap<KT,VT>
{
  pub fn with_capacity(mut cap:usize, maxheap:bool) -> HashHeap<KT,VT> {
    if cap<1 {cap = DEFAULTCAP;}
    let mut hh = HashHeap {
      keys: Vec::with_capacity(cap),    
      vals: Vec::with_capacity(cap),
      kmap: HashMap::with_capacity(cap),
      userhash: |x|0,
      rehash: |h,c|{h+c},
      lessthan : |a,b|a<b,
      autostate: Some(RandomState::new()),
    };
    if !maxheap {hh.lessthan = |a,b|b<a;}
    hh
  }//with_capacity

  pub fn new_minheap() -> HashHeap<KT,VT> { Self::with_capacity(0,false) }
  pub fn new_maxheap() -> HashHeap<KT,VT> { Self::with_capacity(0,true) }

  pub fn set_hash(&mut self, h: fn(&KT)->usize) -> bool {
    if self.vals.len()>0 {return false;}
    self.autostate = None;
    self.userhash = h;
    true
  }
  
  pub fn set_rehash(&mut self, rh: fn(usize,usize)->usize) -> bool {
    if self.vals.len()>0 {return false;}  
    self.rehash = rh;
    true
  }
  
  pub fn set_cmp(&mut self, cmp:fn(&VT,&VT)->bool) -> bool {
    if self.vals.len()>1 {false}
    else {
      self.lessthan = cmp;
      true
    }
  }//set_cmp

  fn autohash(&mut self, key:&KT) -> usize {
     if self.autostate.is_none() { (self.userhash)(key) }
     else { derive_hash(self.autostate.as_mut().unwrap(),key) }
  }


  // must return index of where key is found, or of an empty slot,
  // must rehash on collision
  fn findslot(&mut self, key:&KT) -> (usize,bool) {
    let mut h = self.autohash(key);
    let h0 = h;
    let mut collisions = 0;
    let mut reuse = None;
    while let Some((ki,vi)) = self.kmap.get(&h) {
      match &self.keys[*ki] {
        Some(key2) if key2 == key => { return (h,true); },
        None => { // rehash, set reuse
          if let None = reuse {reuse = Some(h);}
          collisions +=1;
          h = (self.rehash)(h0,collisions);
        },
        Some(_) => {  //rehash, includes case where key entry is None
          collisions += 1;
          h = (self.rehash)(h0,collisions);
        },
      }//match
    } //while let
    reuse.map_or((h,false), |g|(g,false))
  }//findslot returns index for insert, and bool indicating exact key match
   //Here, index refers to index of kmap, not of heap vector


  pub fn insert(&mut self, key:KT, val:VT) -> Option<(KT,VT)> {
    let (h,exists) = self.findslot(&key);
    if exists {
      /* must replace value and reposition within heap !!!!!!!!!!! */
      let (ki,vi) = *self.kmap.get(&h).unwrap();
      let mut newkey = Some(key);
      let mut newval = (val,h);
      core::mem::swap(&mut newkey, &mut self.keys[ki]);
      core::mem::swap(&mut newval, &mut self.vals[vi]);
      //self.keys[ki] = Some(key);
      //self.vals[vi] = (val,h);
      self.reposition(vi);
      Some((newkey.unwrap(), newval.0))
    }//replace
    else {    // assuming key is new
      let kn = self.keys.len();
      let vn = self.vals.len();
      self.keys.push(Some(key));
      self.vals.push((val,h));
      self.kmap.insert(h,(kn,vn));
      self.swapup(vn);
      None
    }//else
  }//insert

  // version of insert that does not replace existing key, returns false instead
  pub fn push(&mut self, key:KT, val:VT) -> bool {
    let (h,exists) = self.findslot(&key);
    if exists { false }
    else {    // assuming key is new
      let kn = self.keys.len();
      let vn = self.vals.len();
      self.keys.push(Some(key));
      self.vals.push((val,h));
      self.kmap.insert(h,(kn,vn));
      self.swapup(vn);
      true
    }//else
  }//push

  pub fn peek(&self) -> Option<(&KT,&VT)> {
    if self.vals.len()==0 {return None;}
    let (v,hv) = &self.vals[0];
    let k = self.kmap.get(hv).unwrap().0;
    Some((self.keys[k].as_ref().unwrap(),v))
  }//peek

  pub fn pop(&mut self) -> Option<(KT,VT)> {
    let vn = self.vals.len();
    if vn==0 {return None;}
    self.heapswap(0,vn-1);
    let mut Kopt = None;
    let (V,iv) = self.vals.pop().unwrap();
    let (ki,vi) = *self.kmap.get(&iv).unwrap();
    core::mem::swap(&mut self.keys[ki], &mut Kopt);
    // entry persist in kmap for rehashing
    self.swapdown(0);
    Some((Kopt.unwrap(),V))
  }//pop

  pub fn get(&mut self, key:&KT) -> Option<&VT> {  //O(1)
    if let (h,true) = self.findslot(key) {
      let (_,vi) = self.kmap[&h];
      Some(&self.vals[vi].0)
    }
    else {None}
  }//get

  pub fn modify<F>(&mut self, key:&KT, mapfun:F) where F : FnOnce(&mut VT)
  {
    if let (h,true) = self.findslot(key) {
      let (_,vi) = self.kmap[&h];
      mapfun(&mut self.vals[vi].0);
      self.reposition(vi);
    }
  }//modify

  pub fn remove(&mut self, key:&KT) -> Option<VT> {
    if let (h,true) = self.findslot(key) {
      let (ki,vi) = self.kmap[&h];
      self.heapswap(vi,self.vals.len()-1);
      let (V,_) = self.vals.pop().unwrap();
      self.reposition(vi);
      self.keys[ki] = None;
      Some(V)
    }
    else {None}  
  }//remove

  pub fn contains_key(&mut self, key:&KT) -> bool {   // O(1)
    self.findslot(key).1
  }

  pub fn contains_val(&self,val:&VT) -> bool {  // O(n)
    self.valsearch(0,val)
  }
  fn valsearch(&self, root:usize, val:&VT) -> bool {
    if root >= self.vals.len() {false}
    else if &self.vals[root].0 == val {true}
    else if (self.lessthan)(&self.vals[root].0,val) {false}
    else {self.valsearch(left(root),val) || self.valsearch(right(root),val)}
  }

  // treat as maxheap 
  fn swapup(&mut self, mut i:usize) -> usize {
    let mut p = parent(i);
    while i>0 && (self.lessthan)(&self.vals[p].0 , &self.vals[i].0) {
       self.heapswap(i,p);
       i = p;
       p = parent(i);
    }//while
    i
  }//swapup returns final position of ith val

  fn swapdown(&mut self, mut i:usize) -> usize {
    let size = self.vals.len();
    let nonleaves = size - ((size+1)/2);
    let mut sc = 0;
    while (i<nonleaves && sc != usize::MAX) {  // refine
       sc = usize::MAX;
       let li = left(i);
       let ri = right(i);
       if li<size && (self.lessthan)(&self.vals[i].0 , &self.vals[li].0) {
         sc = li;
       }
       if ri<size && (self.lessthan)(&self.vals[i].0 , &self.vals[ri].0)
          && (self.lessthan)(&self.vals[li].0 , &self.vals[ri].0) { sc = ri; }
       if (sc != usize::MAX) { //swap
         self.heapswap(i,sc);
         i = sc;
       }
    }//while
    i
  }//swapdown

  fn reposition(&mut self, i:usize) -> usize {
     let mut ni = self.swapup(i);
     if ni==i {ni=self.swapdown(i);}
     ni
  }//reposition

  // swap values at indices i, j in vals, re-associate
  fn heapswap(&mut self, i:usize, j:usize) {
    if i==j {return;}
    let ih = self.vals[i].1;   //hash-index of corresponding key
    let jh = self.vals[j].1;  
    self.vals.swap(i,j);
    self.kmap.get_mut(&ih).map(|(_,vi)|{*vi=j;});
    self.kmap.get_mut(&jh).map(|(_,vj)|{*vj=i;});
    // hash-index does not change- need for future lookup
  }// swap values in vals, re-associate

  pub fn len(&self)->usize { self.vals.len() }

  pub fn reserve(&mut self, additional:usize) {
    self.kmap.reserve(additional);
    self.vals.reserve(additional);
    self.keys.reserve(additional);    
  }
}// impl HashHeap

/////////////////////////////////////////////


// test hash function on strings that produces collisions by design...
fn shash(s:&str) -> usize {
  let mut sum = 0;
  for c in s.chars() {
    sum += c as usize
  }
  sum
}//shash test function

fn main() {
  let mut gpa = HashHeap::<&'static str, u16>::new_maxheap();
  //gpa.set_hash(|s|shash(s));
  gpa.insert("larz",245);
  gpa.insert("mary",375);
  gpa.insert("narx",108);
  gpa.insert("sam",399);    
  gpa.insert("oarw",390);
  gpa.insert("nev",145);
  gpa.insert("haten",101);

  for n in ["mary","larz","narx","oarw","nev","haten","sam"] {
    println!("{}: {:?}",n, gpa.get(&n));
  }

  gpa.modify(&"oarw",|g|{*g=191});
  println!("\n-------------\npop: {:?}",gpa.pop());
  println!("pop: {:?}",gpa.pop());

  println!("remove(larz): {:?}", gpa.remove(&"larz"));

  for n in ["mary","larz","narx","oarw","nev","haten","sam"] {
    println!("{}: {:?}",n, gpa.get(&n));
  }

  for k in gpa.keys() { println!("key {}",k);}
  for (k,v) in gpa.iter() {println!("key {}, value {}",k,v);}

  while gpa.len()>0 {println!("final pop: {:?}",gpa.pop());}

  let mut rs = std::collections::hash_map::RandomState::new();
  println!("derive_hash: {}",derive_hash(&mut rs, &"larz"));
  println!("derive_hash: {}",derive_hash(&mut rs, &"larz"));  
}//main


impl<KT:Hash+Eq, VT:Ord> Default for HashHeap<KT,VT> {
  fn default() -> Self {
     Self::new_maxheap()
  }
} // impl default


////// iterator implementations


pub struct KeyIter<'a,KT> {
   keys : &'a [Option<KT>],
   index : usize
}
impl<'a,KT> Iterator for KeyIter<'a,KT> {
  type Item = &'a KT;
  fn next(&mut self) -> Option<Self::Item> {
    let kn = self.keys.len();
    while self.index<kn && self.keys[self.index].is_none() {
      self.index+=1;
    }
    if self.index >= kn {None}
    else {
      self.index+=1;
      self.keys[self.index-1].as_ref()
    }
  }//next
}// keys iterator

pub struct ValIter<'a,VT> {
   vals : &'a [(VT,usize)],
   index : usize,
}
impl<'a,VT> Iterator for ValIter<'a,VT> {
  type Item = &'a VT;
  fn next(&mut self) -> Option<Self::Item> {
    let vn = self.vals.len();
    if self.index >= vn {None}
    else {
      self.index += 1;
      Some(&self.vals[self.index-1].0)
    }
  }//next
}// vals iterator

pub struct KeyValIter<'a,KT:Hash+Eq,VT:Ord> {
  hh: &'a HashHeap<KT,VT>,
  index : usize,
}
impl<'a,KT:Hash+Eq,VT:Ord> Iterator for KeyValIter<'a,KT,VT> {
  type Item = (&'a KT, &'a VT);
  fn next(&mut self) -> Option<Self::Item> {
    let vn = self.hh.vals.len();
    while self.index<vn
    {
      let (v,iv) = &self.hh.vals[self.index];
      self.index += 1;
      let (ki,_) = self.hh.kmap[iv];
      if let Some(k) = &self.hh.keys[ki] {return Some((k,v));}
    }
    None
  }//next
}// key-val iterator



impl<'a,KT:Hash+Eq, VT:Ord> HashHeap<KT,VT>
{
  pub fn keys(&'a self) -> KeyIter<'a,KT> {
    KeyIter {
      keys: &self.keys,
      index:0,
    }
  }//keys

  pub fn values(&'a self) -> ValIter<'a,VT> {
    ValIter {
      vals: &self.vals,
      index: 0,
    }
  }//values

  pub fn iter(&'a self) -> KeyValIter<'a,KT,VT> {
    KeyValIter {
      hh: self,
      index:0,
    }
  }
}// impl iterators