i_break: Create an iterator that can be told to stop.

In iterors: Fast, Compact Iterators and Tools

Create an iterator that can be told to stop.

Description

Create an iterator that iterates over another iterator until a specified function returns FALSE. This can be useful for breaking out of a foreach loop, for example.

Usage

i_break(iterable, finished, ...)

Arguments

iterable	Iterable to iterate over.
finished	Function that returns a logical value. The iterator stops when this function returns FALSE.
...	Further arguments forwarded to iteror.

Details

Originally from the itertools package.

Value

an iteror which will stop when finished() is TRUE

Examples

# See how high we can count in a tenth of a second
mkfinished <- function(time) {
  starttime <- proc.time()[3]
  function() proc.time()[3] > starttime + time
}
length(as.list(i_break(icount(), mkfinished(0.1))))

iterors documentation built on May 31, 2023, 5:36 p.m.