SolutionDescriptor

Struct SolutionDescriptor 

Source
pub struct SolutionDescriptor {
    pub type_name: &'static str,
    pub type_id: TypeId,
    pub entity_descriptors: Vec<EntityDescriptor>,
    pub problem_fact_descriptors: Vec<ProblemFactDescriptor>,
    pub score_field: &'static str,
    pub score_is_optional: bool,
    /* private fields */
}
Expand description

Describes a planning solution at runtime.

Contains metadata about:

  • Entity types and their descriptors
  • Problem fact types
  • Score type

Fields§

§type_name: &'static str

Name of the solution type.

§type_id: TypeId

TypeId of the solution type.

§entity_descriptors: Vec<EntityDescriptor>

Descriptors for all entity types in this solution.

§problem_fact_descriptors: Vec<ProblemFactDescriptor>

Descriptors for all problem fact types.

§score_field: &'static str

Name of the score field.

§score_is_optional: bool

Whether the score type is Option.

Implementations§

Source§

impl SolutionDescriptor

Source

pub fn new(type_name: &'static str, type_id: TypeId) -> Self

Creates a new SolutionDescriptor.

Source

pub fn with_entity(self, descriptor: EntityDescriptor) -> Self

Adds an entity descriptor and indexes it by TypeId for O(1) lookup.

Source

pub fn with_problem_fact(self, descriptor: ProblemFactDescriptor) -> Self

Adds a problem fact descriptor.

Source

pub fn with_score_field(self, field: &'static str) -> Self

Sets the score field name.

Source

pub fn find_entity_descriptor( &self, type_name: &str, ) -> Option<&EntityDescriptor>

Finds an entity descriptor by type name.

Source

pub fn find_entity_descriptor_by_type( &self, type_id: TypeId, ) -> Option<&EntityDescriptor>

Finds an entity descriptor by type ID (O(1) lookup).

Source

pub fn genuine_variable_descriptors(&self) -> Vec<&VariableDescriptor>

Returns all genuine variable descriptors across all entities.

Source

pub fn shadow_variable_descriptors(&self) -> Vec<&VariableDescriptor>

Returns all shadow variable descriptors across all entities.

Source

pub fn total_entity_count(&self, solution: &dyn Any) -> Option<usize>

Returns the total number of entities across all entity collections.

Returns None if any entity descriptor lacks an extractor or the solution type doesn’t match.

Source

pub fn all_entity_refs(&self, solution: &dyn Any) -> Vec<(usize, EntityRef)>

Returns all entity references across all entity collections.

Source

pub fn for_each_entity<F>(&self, solution: &dyn Any, f: F)
where F: FnMut(usize, usize, &dyn Any),

Iterates over all entities in all collections.

The callback receives:

  • The entity descriptor index
  • The entity index within its collection
  • A reference to the entity
Source

pub fn get_entity<'a>( &self, solution: &'a dyn Any, descriptor_index: usize, entity_index: usize, ) -> Option<&'a dyn Any>

Gets an entity by descriptor index and entity index.

Source

pub fn get_entity_mut<'a>( &self, solution: &'a mut dyn Any, descriptor_index: usize, entity_index: usize, ) -> Option<&'a mut dyn Any>

Gets a mutable entity by descriptor index and entity index.

Source

pub fn entity_descriptor_count(&self) -> usize

Returns the number of entity descriptors.

Source

pub fn problem_fact_descriptor_count(&self) -> usize

Returns the number of problem fact descriptors.

Source

pub fn all_extractors_configured(&self) -> bool

Returns whether all entity descriptors have extractors configured.

Trait Implementations§

Source§

impl Clone for SolutionDescriptor

Source§

fn clone(&self) -> Self

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 SolutionDescriptor

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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.