FormulaEngine

frequenz_microgrid_formula_engine

Struct FormulaEngine 

Source 
pub struct FormulaEngine<T> { /* private fields */ }
Expand description

FormulaEngine holds the parsed expression and can calculate the result based on the provided component values.

Implementations§

Source§

impl<T: FromStr + NumberLike<T> + PartialOrd> FormulaEngine<T>
where <T as FromStr>::Err: Debug,

Source

pub fn try_new(s: &str) -> Result<Self, FormulaError>

Create a new FormulaEngine from a formula string.

Source

pub fn components(&self) -> &HashSet<u64>

Get the components of the formula.

Source

pub fn calculate( &self, values: &HashMap<u64, Option<T>>, ) -> Result<Option<T>, FormulaError>

Calculate the result of the formula based on the provided component values.

Trait Implementations§

Source§

impl<T: Debug> Debug for FormulaEngine<T>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> Freeze for FormulaEngine<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for FormulaEngine<T>
where T: RefUnwindSafe,

§

impl<T> Send for FormulaEngine<T>
where T: Send,

§

impl<T> Sync for FormulaEngine<T>
where T: Sync,

§

impl<T> Unpin for FormulaEngine<T>
where T: Unpin,

§

impl<T> UnwindSafe for FormulaEngine<T>
where T: UnwindSafe,

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> 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, 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.