Struct ParamInfo 

pub struct ParamInfo { /* private fields */ }

Information about function parameters, including their indices and whether they are constant.

Fields

• indices - The parameter indices, stored as either consecutive or disjoint ranges
• constant - A vector indicating whether each parameter is constant (true) or variable (false)

Implementations

impl ParamInfo

pub fn new(indices: impl Into<ParamIndices>, constant: Vec<bool>) -> ParamInfo

Creates a new ParamInfo with the given parameter indices and constant flags.

Arguments

• indices - The parameter indices (can be any type that converts to ParamIndices)
• constant - A vector indicating whether each parameter is constant

Returns

A new ParamInfo instance.

Panics

The length of the constant vector should match the number of parameters in indices.

pub fn parameterized(indices: impl Into<ParamIndices>) -> ParamInfo

Creates a new ParamInfo where all parameters are variable (not constant).

This is a convenience method for creating parameter information where all parameters can vary during optimization or analysis.

Arguments

• indices - The parameter indices (can be any type that converts to ParamIndices)

Returns

A new ParamInfo instance with all parameters marked as variable.

pub fn to_sorted(&self) -> ParamInfo

Returns a new ParamInfo with its parameter indices sorted.

If the ParamIndices are Disjoint, the internal vector is sorted. If the ParamIndices are Joint, they remain Joint as their order is inherently sorted. The constant vector is reordered to match the new order of indices.

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

Unions this ParamInfo with another, combining their parameter indices and constant flags.

This operation combines parameter indices from both ParamInfo instances. If a parameter index appears in both instances, their constant flags must match or an assertion will fail.

Arguments

• other - The other ParamInfo to concatenate with

Returns

A new ParamInfo containing the combined parameters and their constant status.

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

Computes the intersection of this ParamInfo with another.

Returns a new ParamInfo containing only the parameters that are present in both instances. The constant flags must match for common parameters.

Arguments

• other - The other ParamInfo to intersect with

Returns

A new ParamInfo containing only the common parameters.

pub fn num_params(&self) -> usize

Returns the total number of parameters.

Returns

The number of parameters tracked by this ParamInfo.

pub fn num_var_params(&self) -> usize

Returns the total number of variable parameters.

Returns

The number of non-constant parameters tracked by this ParamInfo.

pub fn get_param_map(&self) -> Vec<u64>

Returns the parameter indices as a vector of u64 values.

This is useful for interfacing with external libraries that expect parameter indices as 64-bit unsigned integers.

Returns

A vector containing all parameter indices converted to u64.

pub fn get_const_map(&self) -> Vec<bool>

Returns a copy of the constant flags for all parameters.

The returned vector has the same length as the number of parameters, where each boolean indicates whether the corresponding parameter is constant.

Returns

A vector of boolean values indicating parameter constancy.

pub fn empty() -> ParamInfo

Creates an empty ParamInfo with no parameters.

This is useful as a default or starting point for parameter information.

Returns

An empty ParamInfo instance.

pub fn is_empty(&self) -> bool

Checks if this ParamInfo contains no parameters.

Returns

true if there are no parameters, false otherwise.

pub fn len(&self) -> usize

Returns the number of parameters (alias for num_params).

Returns

The total number of parameters.

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

Returns a sorted vector of indices for parameters that are not constant.

This is useful for optimization routines that only need to vary non-constant parameters.

Returns

A sorted vector containing the indices of all non-constant parameters.

Trait Implementations

impl Clone for ParamInfo

fn clone(&self) -> ParamInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParamInfo

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

Formats the value using the given formatter.

impl Hash for ParamInfo

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 PartialEq for ParamInfo

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

impl StructuralPartialEq for ParamInfo