Struct CrossSection 

#[non_exhaustive]
pub struct CrossSection {
    pub members: Vec<Member>,
    pub timestamp: i64,
}

A market-breadth cross-section: the per-symbol state of an entire universe at a single point in time.

Invariants enforced by new:

• members is non-empty (a breadth reading needs at least one symbol).
• every member’s change is finite, and volume is finite and non-negative.

timestamp is a caller-defined epoch / resolution and is not validated.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

members: Vec<Member>

Per-symbol members of the universe for this tick.

timestamp: i64

Tick timestamp (caller-defined epoch / resolution).

Implementations

impl CrossSection

pub fn new(members: Vec<Member>, timestamp: i64) -> Result<Self>

Construct a cross-section, validating every member invariant.

Errors

Returns Error::InvalidCrossSection if members is empty, if any member has a non-finite change, or if any member has a volume that is not a finite non-negative number.

pub const fn new_unchecked(members: Vec<Member>, timestamp: i64) -> Self

Construct a cross-section without validation. The caller asserts that every invariant documented on CrossSection holds.

pub fn advancers(&self) -> usize

Number of advancing symbols (those with a strictly positive change).

pub fn decliners(&self) -> usize

Number of declining symbols (those with a strictly negative change).

pub fn advancing_volume(&self) -> f64

Total volume traded by advancing symbols (those with positive change).

pub fn declining_volume(&self) -> f64

Total volume traded by declining symbols (those with negative change).

pub fn total_volume(&self) -> f64

Total volume traded across the whole universe.

pub fn new_highs(&self) -> usize

Number of symbols that printed a new period high.

pub fn new_lows(&self) -> usize

Number of symbols that printed a new period low.

pub fn above_ma_count(&self) -> usize

Number of symbols trading above their reference moving average.

pub fn on_buy_signal_count(&self) -> usize

Number of symbols on a point-and-figure buy signal.

Trait Implementations

impl Clone for CrossSection

fn clone(&self) -> CrossSection

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CrossSection

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

Formats the value using the given formatter.

impl PartialEq for CrossSection

fn eq(&self, other: &CrossSection) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CrossSection