Struct ExprArenaWriteGuard 

pub struct ExprArenaWriteGuard<'a> { /* private fields */ }

Methods from Deref<Target = ExprArena>

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn push(&mut self, node: ExprNode) -> ExprId

Panics

Panics if the number of expressions exceeds u32::MAX (expression arena overflow).

pub fn get(&self, id: ExprId) -> &ExprNode

pub fn get_mut(&mut self, id: ExprId) -> &mut ExprNode

pub fn nodes(&self) -> &[ExprNode]

pub fn constant(&mut self, v: f64) -> ExprId

pub fn var(&mut self, v: VarId) -> ExprId

pub fn param(&mut self, p: ParamId) -> ExprId

pub fn new_param(&mut self, value: f64) -> ParamId

Allocate a fresh parameter initialized to value, returning its ParamId. Push a ExprNode::Param with Self::param to reference it inside an expression.

Panics

Panics if the number of parameters exceeds u32::MAX.

pub fn num_params(&self) -> usize

pub fn param_value(&self, p: ParamId) -> f64

Current value bound to parameter p.

Panics

Panics if p was not allocated by Self::new_param on this arena.

pub fn try_param_value(&self, p: ParamId) -> Option<f64>

Look up the value of p, returning None if p is out of range.

pub fn set_param_value(&mut self, p: ParamId, value: f64)

Re-bind parameter p to value. Takes effect on the next extraction or evaluation.

Panics

Panics if p was not allocated by Self::new_param on this arena.

pub fn linear(&mut self, coeffs: Vec<(VarId, f64)>, constant: f64) -> ExprId

Trait Implementations

impl Debug for ExprArenaWriteGuard<'_>

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

Formats the value using the given formatter.

impl Deref for ExprArenaWriteGuard<'_>

type Target = ExprArena

The resulting type after dereferencing.

fn deref(&self) -> &<ExprArenaWriteGuard<'_> as Deref>::Target

Dereferences the value.

impl DerefMut for ExprArenaWriteGuard<'_>

fn deref_mut(&mut self) -> &mut <ExprArenaWriteGuard<'_> as Deref>::Target

Mutably dereferences the value.

impl Drop for ExprArenaWriteGuard<'_>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.