Struct CellRef 

pub struct CellRef { /* private fields */ }

A reference to a cell in the circuit.

Implementations

impl CellRef

pub fn absolute(col: usize, row: usize) -> Self

Creates a new cell reference using absolute coordinates.

pub fn relative(col: usize, base: usize, offset: usize) -> Self

Creates a new cell reference using coordinates relative to a row (usually the region’s first row).

pub fn row(&self) -> usize

Returns the absolute row the cell points to.

pub fn col(&self) -> usize

Returns the column number.

pub fn is_absolute(&self) -> bool

Returns true if is an absolute reference.

pub fn relativize(&self, base: usize) -> Self

Tries to convert an absolute reference into a relative reference w.r.t. the given base.

For a non-panicking version see try_relativize.

Panics

If the base is larger than the row number or if the reference is already relative.

pub fn try_relativize(&self, base: usize) -> Result<Self, CellError>

Tries to convert an absolute reference into a relative reference w.r.t. the given base.

Fails if the base is larger than the row number or if the reference is already relative.

pub fn absolutize(&self) -> Self

Converts the cell reference to an absolute reference.

If the reference is already absolute it does nothing.

Trait Implementations

impl Clone for CellRef

fn clone(&self) -> CellRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CellRef

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

Formats the value using the given formatter.

impl Display for CellRef

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

Formats the value using the given formatter.

impl EqvRelation<CellRef> for SymbolicEqv

fn equivalent(lhs: &CellRef, rhs: &CellRef) -> bool

Two cell refs are equivalent if they point to the same absolute cell or the point to the same relative cell regardless of their base.

impl Hash for CellRef

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 CellRef

fn cmp(&self, other: &CellRef) -> 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 CellRef

fn eq(&self, other: &Self) -> 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 PartialOrd for CellRef

fn partial_cmp(&self, other: &CellRef) -> 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 Copy for CellRef

impl Eq for CellRef