Skip to main content

Expr

Struct Expr 

Source
pub struct Expr { /* private fields */ }
Expand description

A parsed expression that can be evaluated or inspected.

Expr is the main entry point for the expression language. Parse a string with Expr::parse(), then either evaluate it with Expr::eval() or inspect the AST with Expr::ast().

§Example

use wick_core::Expr;
use std::collections::HashMap;

// Parse an expression
let expr = Expr::parse("x^2 + 2*x + 1").unwrap();

// Evaluate with different variable values
let mut vars = HashMap::new();
vars.insert("x".to_string(), 3.0);
assert_eq!(expr.eval(&vars).unwrap(), 16.0);  // 9 + 6 + 1

vars.insert("x".to_string(), 0.0);
assert_eq!(expr.eval(&vars).unwrap(), 1.0);   // 0 + 0 + 1

Implementations§

Source§

impl Expr

Source

pub fn parse(input: &str) -> Result<Self, ParseError>

Parses an expression from a string.

§Errors

Returns ParseError if the input is not a valid expression:

§Example
use wick_core::{Expr, ParseError};

// Valid expression
assert!(Expr::parse("1 + 2").is_ok());

// Invalid: unexpected character
assert!(matches!(Expr::parse("1 @ 2"), Err(ParseError::UnexpectedChar('@'))));

// Invalid: incomplete expression
assert!(matches!(Expr::parse("1 +"), Err(ParseError::UnexpectedEnd)));
Source

pub fn ast(&self) -> &Ast

Returns a reference to the parsed AST.

Use this to inspect the expression structure or to compile it to a different target (WGSL, Lua, etc.).

Source

pub fn free_vars(&self) -> HashSet<&str>

Returns the set of free variables referenced in the expression.

This is useful for determining which variables need to be provided at evaluation time, or for building dependency graphs.

§Example
use wick_core::Expr;

let expr = Expr::parse("x * 2 + y").unwrap();
let vars = expr.free_vars();
assert!(vars.contains("x"));
assert!(vars.contains("y"));
assert_eq!(vars.len(), 2);
Source

pub fn eval(&self, vars: &HashMap<String, f32>) -> Result<f32, EvalError>

Evaluates the expression with the given variables.

This version is available when the func feature is disabled.

§Errors

Returns EvalError::UnknownVariable if a variable is not in vars.

Trait Implementations§

Source§

impl Clone for Expr

Source§

fn clone(&self) -> Expr

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Expr

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Expr

§

impl RefUnwindSafe for Expr

§

impl Send for Expr

§

impl Sync for Expr

§

impl Unpin for Expr

§

impl UnwindSafe for Expr

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.