var searchIndex = {};
searchIndex["iter_progress"] = {"doc":"","items":[[3,"ProgressRecord","iter_progress","",null,null],[3,"ProgressRecorderIter","","Wraps an iterator and keeps track of state used for `ProgressRecord`'s",null,null],[8,"ProgressableIter","","An iterator that records it's progress as it goes along",null,null],[10,"progress","","",0,null],[11,"message","","Returns a basic log message of where we are now. You can construct this yourself, but this\nis a helpful convience method.",1,null],[11,"duration_since_start","","Duration since iteration started",1,null],[11,"num_done","","Number of items we've generated so far",1,null],[11,"previous_record_tm","","Tm for when the previous record was generated. None if there was no previous record.",1,null],[11,"started_iterating","","When the iteration started",1,null],[11,"print_message","","Prints a basic message",1,null],[11,"rate","","Number of items per second",1,null],[11,"fraction","","None if we don't know how much we've done (as a fraction), otherwise a value form 0 to 1\nfor what fraction along we are.",1,null],[11,"percent","","None if we don't know how much we've done, otherwise value for 0 to 100 representing how\nfar along as a percentage we are.",1,null],[11,"print_every_n_sec","","Print out `msg`, but only if there has been `n` seconds since last printout",1,null],[11,"do_every_n_sec","","Do thing but only every n sec (as far as possible).\nCould be a print statement.",1,null],[11,"should_do_every_n_sec","","If we want to print every `n` sec, should we print now?",1,null],[11,"should_do_every_n_items","","If we want to print every `n` items, should we print now?",1,null],[11,"print_every_n_items","","Print out `msg`, but only if there has been `n` items.\nOften you want to print out a debug message every 1,000 items or so. This function does\nthat.",1,null],[11,"do_every_n_items","","Do thing but only every n items.\nCould be a print statement.",1,null],[11,"recent_rate","","The rate of the last few items.",1,null],[11,"new","","Create a new `ProgressRecorderIter` from another iterator.",2,{"inputs":[{"name":"i"}],"output":{"name":"progressrecorderiter"}}],[11,"next","","",2,null],[11,"size_hint","","",2,null],[11,"count","","",2,null]],"paths":[[8,"ProgressableIter"],[3,"ProgressRecord"],[3,"ProgressRecorderIter"]]};
initSearch(searchIndex);