Struct CubeHeight 

pub struct CubeHeight { /* private fields */ }

A cube’s height, written k*d + n over the code distance d.

k = numerator / denominator is a positive rational kept in lowest terms so that 2d/4 == d/2; n is a signed integer offset. Blog syntax is height=<expr> — d, 2d, d/2, 3d/2, 3d+2, d/2 - 1 — defaulting to height=d. Ord is structural, present only to give Block a total order; it does not compare realized heights, which depend on d.

use bloq_graph::CubeHeight;

let half: CubeHeight = "d/2".parse()?;
assert_eq!((half.cells(), half.rounds(7)), (1, 4)); // one cell, ceil(7/2) rounds

Implementations

impl CubeHeight

pub const DEFAULT: Self

height=d: one code distance of rounds, one cell.

pub fn new( numerator: u32, denominator: u32, offset: i32, ) -> Result<Self, BlockError>

Constructs numerator/denominator * d + offset, reduced to lowest terms.

Errors

Returns BlockError::NonPositiveCubeHeight if either numerator or denominator is zero (k <= 0 is meaningless), or BlockError::CubeHeightExceedsRange if the footprint would exceed MAX_CUBE_HEIGHT_CELLS.

pub const fn numerator(self) -> u32

The reduced numerator of k.

pub const fn denominator(self) -> u32

The reduced denominator of k.

pub const fn offset(self) -> i32

The integer offset n.

pub const fn is_default(self) -> bool

Whether this is height=d, the height a cube has when nothing is written.

pub const fn cells(self) -> u32

Cells occupied along the time axis: ceil(k), always at least 1.

The offset n deliberately does not participate. n buys or refunds individual syndrome rounds inside the cube’s own worldline; it does not change which lattice cells the cube claims, so height=d-1 and height=d+1 are both single-cell cubes.

pub const fn rounds(self, distance: u32) -> i64

Compiled syndrome rounds at distance: ceil(k*d) + n.

Since n is an integer this equals ceil(k*d + n) exactly, and it is computed that way — integer div_ceil on the numerator, then the offset — rather than through floating point.

The result is signed because a large negative n can drive it below zero; callers that need a usable round count must check it (a cube needs at least 2 rounds, one for its initialization stage and one for its measurement stage).

Trait Implementations

impl Clone for CubeHeight

fn clone(&self) -> CubeHeight

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CubeHeight

impl Debug for CubeHeight

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

Formats the value using the given formatter.

impl Default for CubeHeight

fn default() -> Self

Returns the “default value” for a type.

impl Display for CubeHeight

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

Emits the canonical form: the fraction reduced, a /1 denominator and a +0 offset omitted. This is exactly what the blog writer puts after height=, so it must re-parse to an equal value.

impl Eq for CubeHeight

impl FromStr for CubeHeight

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses k*d + n, sharing the blog grammar so the two cannot drift.

type Err = BlockError

The associated error which can be returned from parsing.

impl Hash for CubeHeight

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for CubeHeight

fn cmp(&self, other: &CubeHeight) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for CubeHeight

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for CubeHeight

fn partial_cmp(&self, other: &CubeHeight) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for CubeHeight