Struct IndexedVar 

pub struct IndexedVar<'a, K = IndexKey> { /* private fields */ }

Indexed variable: maps an IndexKey to a single-variable Expr, tagged with the key type K its domain decodes to.

Constructed by crate::Model::indexed_var or the variable! macro. K is a phantom marker, carried so the type of an indexed family is visible and typed iteration via Self::keys is possible.

When the domain is a contiguous integer range (or a Cartesian product of ranges) the family is stored densely (see [Storage]). String, sparse, and filtered families fall back to a hash map.

Implementations

impl<'a, K> IndexedVar<'a, K>

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn is_dense(&self) -> bool

Whether this family is stored densely (domain was a range or product of ranges).

pub fn shape(&self) -> Option<Box<[usize]>>

Per-axis lengths when stored densely, else None.

pub fn iter(&self) -> impl Iterator<Item = (&IndexKey, &Expr<'a>)> + '_

pub fn get<Q: Into<IndexKey>>(&self, key: Q) -> Option<Expr<'a>>

pub fn at<const N: usize>(&self, coords: [usize; N]) -> Expr<'a>

Zero-allocation typed index by integer coordinates. On a dense family this maps straight to a flat offset with no IndexKey built. On a sparse family it falls back to building a key.

Panics

Panics if the coordinates are out of range/not present.

pub fn get_at<const N: usize>(&self, coords: [usize; N]) -> Option<Expr<'a>>

Fallible form of Self::at.

impl<'a, K: FromIndexKey> IndexedVar<'a, K>

pub fn keys(&self) -> impl Iterator<Item = (K, Expr<'a>)> + '_

Iterate the family’s entries with each key decoded to the typed K.

Trait Implementations

impl<'a, K> Clone for IndexedVar<'a, K>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, K> Debug for IndexedVar<'a, K>

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

Formats the value using the given formatter.

impl<'a, K> Index<&IndexKey> for IndexedVar<'a, K>

type Output = Expr<'a>

The returned type after indexing.

fn index(&self, key: &IndexKey) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'a, K, Q: Into<IndexKey>> Index<Q> for IndexedVar<'a, K>

type Output = Expr<'a>

The returned type after indexing.

fn index(&self, key: Q) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'a, K, const N: usize> Index<[usize; N]> for IndexedVar<'a, K>

type Output = Expr<'a>

The returned type after indexing.

fn index(&self, coords: [usize; N]) -> &Self::Output

Performs the indexing (container[index]) operation.