Struct VariableDescriptor 

pub struct VariableDescriptor {
    pub name: &'static str,
    pub variable_type: VariableType,
    pub allows_unassigned: bool,
    pub value_range_provider: Option<&'static str>,
    pub value_range_type: ValueRangeType,
    pub source_variable: Option<&'static str>,
    pub source_entity: Option<&'static str>,
}

Describes a planning variable at runtime.

Fields

name: &'static str

Name of the variable (field name).

variable_type: VariableType

Type of the variable.

allows_unassigned: bool

Whether the variable can be unassigned (null).

value_range_provider: Option<&'static str>

Reference to the value range provider.

value_range_type: ValueRangeType

The type of value range.

source_variable: Option<&'static str>

For shadow variables: the source variable name.

source_entity: Option<&'static str>

For shadow variables: the source entity type name.

Implementations

impl VariableDescriptor

pub fn genuine(name: &'static str) -> Self

Creates a new genuine variable descriptor.

pub fn chained(name: &'static str) -> Self

Creates a new chained variable descriptor.

Chained variables form chains rooted at anchor problem facts. For example, in vehicle routing: Vehicle ← Customer1 ← Customer2

pub fn list(name: &'static str) -> Self

Creates a new list variable descriptor.

pub fn shadow(name: &'static str, kind: ShadowVariableKind) -> Self

Creates a new shadow variable descriptor.

pub fn with_value_range(self, provider: &'static str) -> Self

Sets the value range provider reference.

pub fn with_allows_unassigned(self, allows: bool) -> Self

Sets whether unassigned values are allowed.

pub fn piggyback(name: &'static str, source_shadow: &'static str) -> Self

Creates a piggyback shadow variable descriptor.

Piggyback shadows ride on another shadow variable’s listener, updated as a side-effect without their own dedicated listener.

pub fn with_value_range_type(self, value_range_type: ValueRangeType) -> Self

Sets the value range type.

pub fn with_source(self, entity: &'static str, variable: &'static str) -> Self

Sets the source variable for shadow variables.

Trait Implementations

impl Clone for VariableDescriptor

fn clone(&self) -> VariableDescriptor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VariableDescriptor

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

Formats the value using the given formatter.