Struct ValuesWalk 

pub struct ValuesWalk { /* private fields */ }

Successive windows of values over whole chromosomes.

Exhausted after one pass. locs() gives the region of each window up front, so iter.locs().to_vec() before the walk is how both are had at once.

Implementations

impl ValuesWalk

pub fn restarted(&self) -> Self

The same walk, back at its first window.

What makes the Python iterator re-iterable: __iter__ hands back a fresh cursor over the plan that is already built, so a second for loop walks the file again instead of yielding nothing. Costs two refcount bumps — the windows and the per-window bin counts are shared, not copied — and re-reads the file, which is what a second pass is.

pub fn plan(reader: &BbiReader, req: &ValuesRequest, span: i64) -> Result<Self>

Resolve the whole walk up front: the windows, the zoom level, and every argument that could be refused.

A request that cannot be read says so when it is made rather than part way through the iteration.

pub fn len(&self) -> usize

Number of windows, so len(iterator) works on the Python side.

pub fn bin_size(&self) -> i64

The whole number of base pairs each bin covers.

Resolved at plan from the request’s f64, so a caller laying window values out on coordinates — as the exporters do — reads the grid the walk actually used rather than rounding the request a second time.

pub fn is_empty(&self) -> bool

pub fn locs(&self) -> &[WindowLoc]

The region of each window: the nth array covers locs()[n].

pub fn next_window(&mut self, reader: &BbiReader) -> Option<Result<Array1<f32>>>

The next window, or None once the walk is spent.

Takes the reader on every step rather than holding it: a #[pyclass] cannot carry a borrow, and the Python iterator drives exactly this.

Trait Implementations

impl Debug for ValuesWalk

Hand-written: a progress callback is a boxed closure and cannot be Debug.

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.