Struct dypdl::State

pub struct State {
    pub signature_variables: SignatureVariables,
    pub resource_variables: ResourceVariables,
}

State in DyPDL.

Fields

signature_variables: SignatureVariables

Variables other than resource variables

resource_variables: ResourceVariables

Resource variables

Implementations

impl State

pub fn is_satisfied<U: StateInterface>( &self, state: &U, metadata: &StateMetadata ) -> bool

Returns if the given state is equal to the current state.

Panics

Panics if the state metadata is wrong.

Trait Implementations

impl Clone for State

fn clone(&self) -> State

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for State

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

Formats the value using the given formatter.

impl Default for State

fn default() -> State

Returns the “default value” for a type.

impl PartialEq for State

fn eq(&self, other: &State) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StateInterface for State

fn get_number_of_set_variables(&self) -> usize

Returns the number of set variables.

Examples

use dypdl::prelude::*;

let mut model = Model::default();
let object_type = model.add_object_type("object", 4).unwrap();
let set = model.create_set(object_type, &[0, 1, 2, 3]).unwrap();
model.add_set_variable("variable", object_type, set).unwrap();
let state = model.target.clone();

assert_eq!(state.get_number_of_set_variables(), 1);

fn get_set_variable(&self, i: usize) -> &Set

Returns the value of a set variable.

Panics

Panics if no variable has the id of i.

Examples

use dypdl::prelude::*;

let mut model = Model::default();
let object_type = model.add_object_type("object", 4).unwrap();
let set = model.create_set(object_type, &[0, 1, 2, 3]).unwrap();
let variable = model.add_set_variable("variable", object_type, set.clone()).unwrap();
let state = model.target.clone();

assert_eq!(state.get_set_variable(variable.id()), &set);

fn get_number_of_vector_variables(&self) -> usize

Returns the number of vector variables;

Examples

use dypdl::prelude::*;

let mut model = Model::default();
let object_type = model.add_object_type("object", 4).unwrap();
model.add_vector_variable("variable", object_type, vec![0, 1, 2, 3]).unwrap();
let state = model.target.clone();

assert_eq!(state.get_number_of_vector_variables(), 1);

fn get_vector_variable(&self, i: usize) -> &Vector

Returns the value of a vector variable.

Panics

Panics if no variable has the id of i.

Examples

use dypdl::prelude::*;

let mut model = Model::default();
let object_type = model.add_object_type("object", 4).unwrap();
let variable = model.add_vector_variable("variable", object_type, vec![0, 1, 2, 3]).unwrap();
let state = model.target.clone();

assert_eq!(state.get_vector_variable(variable.id()), &vec![0, 1, 2, 3]);

fn get_number_of_element_variables(&self) -> usize

Returns the number of vector variables;

Examples

use dypdl::prelude::*;

let mut model = Model::default();
let object_type = model.add_object_type("object", 4).unwrap();
model.add_element_variable("variable", object_type, 0).unwrap();
let state = model.target.clone();

assert_eq!(state.get_number_of_element_variables(), 1);

fn get_element_variable(&self, i: usize) -> Element

Returns the value of an element variable.

Panics

Panics if no variable has the id of i.

Examples

use dypdl::prelude::*;

let mut model = Model::default();
let object_type = model.add_object_type("object", 4).unwrap();
let variable = model.add_element_variable("variable", object_type, 0).unwrap();
let state = model.target.clone();

assert_eq!(state.get_element_variable(variable.id()), 0);

fn get_number_of_integer_variables(&self) -> usize

Returns the number of integer numeric variables;

Examples

use dypdl::prelude::*;

let mut model = Model::default();
model.add_integer_variable("variable", 0).unwrap();
let state = model.target.clone();

assert_eq!(state.get_number_of_integer_variables(), 1);

fn get_integer_variable(&self, i: usize) -> Integer

Returns the value of an integer numeric variable.

Panics

Panics if no variable has the id of i.

Examples

use dypdl::prelude::*;

let mut model = Model::default();
let variable = model.add_integer_variable("variable", 0).unwrap();
let state = model.target.clone();

assert_eq!(state.get_integer_variable(variable.id()), 0);

fn get_number_of_continuous_variables(&self) -> usize

Returns the number of continuous numeric variables;

Examples

use dypdl::prelude::*;

let mut model = Model::default();
model.add_continuous_variable("variable", 0.5).unwrap();
let state = model.target.clone();

assert_eq!(state.get_number_of_continuous_variables(), 1);

fn get_continuous_variable(&self, i: usize) -> Continuous

Returns the value of a continuous numeric variable.

Panics

Panics if no variable has the id of i.

Examples

use approx::assert_relative_eq;
use dypdl::prelude::*;

let mut model = Model::default();
let variable = model.add_continuous_variable("variable", 0.5).unwrap();
let state = model.target.clone();

assert_relative_eq!(state.get_continuous_variable(variable.id()), 0.5);

fn get_number_of_element_resource_variables(&self) -> usize

Returns the number of element resource variables;

Examples

use dypdl::prelude::*;

let mut model = Model::default();
let object_type = model.add_object_type("object", 4).unwrap();
model.add_element_resource_variable("variable", object_type, false, 0).unwrap();
let state = model.target.clone();

assert_eq!(state.get_number_of_element_resource_variables(), 1);

fn get_element_resource_variable(&self, i: usize) -> Element

Returns the value of an element resource variable.

Panics

Panics if no variable has the id of i.

Examples

use dypdl::prelude::*;

let mut model = Model::default();
let object_type = model.add_object_type("object", 4).unwrap();
let variable = model.add_element_resource_variable("variable", object_type, false, 0).unwrap();
let state = model.target.clone();

assert_eq!(state.get_element_resource_variable(variable.id()), 0);

fn get_number_of_integer_resource_variables(&self) -> usize

Returns the number of integer resource variables;

Examples

use dypdl::prelude::*;

let mut model = Model::default();
model.add_integer_resource_variable("variable", false, 0).unwrap();
let state = model.target.clone();

assert_eq!(state.get_number_of_integer_resource_variables(), 1);

fn get_integer_resource_variable(&self, i: usize) -> Integer

Returns the value of an integer resource variable.

Panics

Panics if no variable has the id of i.

Examples

use dypdl::prelude::*;

let mut model = Model::default();
let variable = model.add_integer_resource_variable("variable", false, 0).unwrap();
let state = model.target.clone();

assert_eq!(state.get_integer_resource_variable(variable.id()), 0);

fn get_number_of_continuous_resource_variables(&self) -> usize

Returns the number of continuous resource variables;

Examples

use dypdl::prelude::*;

let mut model = Model::default();
model.add_continuous_resource_variable("variable", false, 0.5).unwrap();
let state = model.target.clone();

assert_eq!(state.get_number_of_continuous_resource_variables(), 1);

fn get_continuous_resource_variable(&self, i: usize) -> Continuous

Returns the value of a continuous resource variable.

Panics

Panics if no variable has the id of i.

Examples

use approx::assert_relative_eq;
use dypdl::prelude::*;

let mut model = Model::default();
let variable = model.add_continuous_resource_variable("variable", false, 0.5).unwrap();
let state = model.target.clone();

assert_relative_eq!(state.get_continuous_resource_variable(variable.id()), 0.5);

fn apply_effect<T: From<State>>( &self, effect: &Effect, registry: &TableRegistry ) -> T

Returns the transitioned state by the effect.

impl StructuralPartialEq for State