RFABase.h

This method is called before iterating over a chunk, to inquire the expected memory use. Should return the max desired memory footprint, in MB. Available physical memory is divided between agents in proportion to their requests.

virtual Bool newChunk (Int &)

Called before iterating over a chunk. Returns True if agent will process this chunk, or False if this the agent is unable to process it. (this can happen if, e.g., the requisite correlations are not present). The Int & maxmem argument is the number of MB memory which is still available in the memory pool. The agent class should plan its memory use accordingly, and subtract its expected memory use from maxmem. In effect, the agent "reserves" some amount of memory. This is used by RedFlagger to contain the total memory footprint. Note that only a rough reckoning is sufficient, so only bother estimating the biggest data structures. See implementations in RFADiffBase and RFATimeMedian for good examples.

virtual void endChunk ()

Called once finished with a chunk

virtual void startData ()

Called before starting a data pass on a chunk.

virtual void startDry ()

Called before starting a dry pass on a chunk.

virtual void startFlag ()

Called before starting the fetch-flags pass.

virtual IterMode endData ()

Called after a pass is completed successfully (i.e., not stopped by start or iter methods). Return value: STOP to stop, DATA for another data pass, DRY for another dry pass.

virtual IterMode endDry ()

Called after a dry pass is complete

virtual void endFlag ()

Called after a flag pass is complete

virtual IterMode iterTime ( uInt itime )

Iteration methods for a data pass. Either or both may be implemented. iterTime() is called once for each new VisBuffer (= new time slot) Return value: STOP to finish iterating, CONT/DATA to continue, or DRY to cancel the data pass and request a dry pass.

virtual IterMode iterRow ( uInt irow )

iterRow() is called once per each row in the VisBuffer. Iterating over rows is perhaps preferrable in terms of performance, at least for data iterations.

virtual IterMode iterDry ( uInt itime )

Iteration method for a dry pass. Called once per each time slot. Return value: STOP to finish iterating, CONT/DRY to continue, or DATA to cancel the dry pass and request another data pass.