Enum ParamIndices 

pub enum ParamIndices {
    Joint(usize, usize),
    Disjoint(Vec<usize>),
}

A data structure representing indices of parameters (e.g. for a function). There are optimized methods for consecutive and disjoint parameters.

Variants

Joint(usize, usize)

The index of the first parameter (consecutive parameters)

Disjoint(Vec<usize>)

The index of each parameter (disjoint parameters)

Implementations

impl ParamIndices

pub fn to_bitset(&self) -> BitSet

Converts the ParamIndices to a BitSet.

This function creates a BitSet where each bit corresponds to a parameter index. If a parameter index is present in the ParamIndices, the corresponding bit in the BitSet is set to 1.

Returns

A BitSet representing the parameter indices.

pub fn empty() -> ParamIndices

Creates a ParamIndices representing a constant value (no parameters).

Returns

A ParamIndices representing an empty set of parameter indices.

pub fn is_empty(&self) -> bool

Checks if the ParamIndices is empty (contains no parameters).

Returns

true if the ParamIndices is empty, false otherwise.

pub fn is_consecutive(&self) -> bool

Checks if the ParamIndices represents a consecutive range of parameters.

Returns

true if the ParamIndices is consecutive, false otherwise.

pub fn num_params(&self) -> usize

Returns the number of parameters represented by the ParamIndices.

Returns

The number of parameters.

pub fn start(&self) -> usize

Returns the starting index of the parameters.

For ParamIndices::Joint, this is the index of the first parameter in the consecutive range. For ParamIndices::Disjoint, this is the index of the first parameter in the vector, or 0 if the vector is empty.

Returns

The starting index of the parameters.

pub fn union(&self, other: &ParamIndices) -> ParamIndices

Concatenates two ParamIndices into a single ParamIndices.

This function combines the parameter indices from two ParamIndices instances. If the two ParamIndices represent overlapping ranges, they are merged into a single ParamIndices::Joint if possible. Otherwise, the parameter indices are combined into a ParamIndices::Disjoint.

Arguments

• other - The other ParamIndices to concatenate with.

Returns

A new ParamIndices representing the concatenation of the two input ParamIndices.

pub fn intersect(&self, other: &ParamIndices) -> ParamIndices

Computes the intersection of two ParamIndices.

This function returns a new ParamIndices containing only the parameter indices that are present in both input ParamIndices. The result is always a ParamIndices::Disjoint.

Arguments

• other - The other ParamIndices to intersect with.

Returns

A new ParamIndices representing the intersection of the two input ParamIndices.

pub fn sort(&mut self) -> &mut Self

Sorts the indices.

If the ParamIndices is Joint, this method does nothing.

Returns

A mutable reference to self for chaining.

pub fn sorted(&self) -> Self

Returns a new ParamIndices with the indices sorted.

pub fn iter<'a>(&'a self) -> ParamIndicesIter<'a>

Creates an iterator over the parameter indices.

Returns

A ParamIndicesIter that yields the parameter indices.

pub fn contains(&self, index: usize) -> bool

Checks if the ParamIndices contains the given index.

Arguments

• index - The index to check.

Returns

true if the ParamIndices contains the index, false otherwise.

pub fn to_vec(self) -> Vec<usize>

Convert the indices to a vector

pub fn as_vec(&self) -> Vec<usize>

Convert the indices to a vector without consuming the indices object.

pub fn len(&self) -> usize

Returns the number of indices tracked by this object; alias for num_params()

Trait Implementations

impl Clone for ParamIndices

fn clone(&self) -> ParamIndices

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParamIndices

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

Formats the value using the given formatter.

impl<T: AsRef<[usize]>> From<T> for ParamIndices

fn from(indices: T) -> Self

Converts to this type from the input type.

impl Hash for ParamIndices

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<'a> IntoIterator for &'a ParamIndices

type Item = usize

The type of the elements being iterated over.

type IntoIter = ParamIndicesIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for ParamIndices

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 Eq for ParamIndices