Struct EvaluationMapPlan 

pub struct EvaluationMapPlan { /* private fields */ }

An admitted ordered inventory of complete inputs for one immutable Program or time Plan.

Position identifies an occurrence within one execution. Equal inputs remain separate: no sorting, deduplication, default anchor, retry or sampling occurs during execution.

Implementations

§

impl EvaluationMapPlan

Signature links:EvaluationMapPlan

pub fn execute_recorded<C>( &self, should_cancel: C, ) -> Result<EvaluationCollection, Diagnostic>

where C: FnMut() -> bool,

Signature links:execute_recordedResultEvaluationCollectionDiagnosticFnMutbool

Execute through ordinary delivery and capture even explicitly released members.

Returned collections can be incomplete; inspect is_complete. Recording owns additional payload storage outside the map’s numerical-retention charge and enforces the shared encoded artifact bound. No member is implicitly rerun.

§

impl EvaluationMapPlan

Signature links:EvaluationMapPlan

pub fn from_partition( program: Arc<DifferentiableProgram>, shared_values: &DifferentiableValues, mapped_values: &[DifferentiableValues], policy: EvaluationMapExecutionPolicy, ) -> Result<EvaluationMapPlan, Diagnostic>

Signature links:from_partitionArcDifferentiableProgramDifferentiableValuesDifferentiableValuesEvaluationMapExecutionPolicyResultEvaluationMapPlanDiagnostic

Compose typed shared inputs with ordered typed mapped occurrences.

Shared leaves may appear in any order. Each mapped product must contain exactly the remaining Program inputs in Program order. An empty mapped inventory has no occurrences; all-shared maps use one empty product per occurrence. The Plan retains this sharing declaration for every derivative view. Grid axes belong to the consuming map/product projection.

Errors

Rejects foreign signatures and incomplete or reordered mapped products, including invalid shared signatures in an empty map, before execution.

§

impl EvaluationMapPlan

Signature links:EvaluationMapPlan

pub fn from_time_requests<F>( plan: Arc<CommonTimePlan>, requests: &[CommonTimeRunRequest], checkpoints: Option<&[Option<CommonTimeCheckpoint>]>, policy: EvaluationMapExecutionPolicy, member_bytes_limit: usize, run: F, ) -> Result<EvaluationMapPlan, Diagnostic>

where F: Fn(&CommonTimeRunRequest, Option<&CommonTimeCheckpoint>) -> Result<ControlFlow<CommonTimeCheckpoint, CommonResult>, Vec<Diagnostic>> + Send + Sync + 'static,

Signature links:from_time_requestsArcOptionOptionEvaluationMapExecutionPolicyusizeResultEvaluationMapPlanDiagnosticFnOptionResultControlFlowVecDiagnosticSendSync

Admit complete independent time requests through the ordinary time Run adapter.

Every request must use this exact Plan and the same retained output times. Initial States and internal steps/events may differ. No padding, interpolation, output retiming, failed-member filtering or trajectory derivative is introduced. The ordinary Run owns event-side sampling and complete-horizon acceptance.

run executes one ordinary Run and returns its accepted Result or atomic checkpoint. It must create independent numerical state per call; the existing Plan/Run/Result owners admit its backend and history. The callback can observe its own cancellation token within a member; map cancellation is also checked before dispatch. Checkpoints, when supplied, bind the original complete requests.

The storage charge includes request coordinates/output inventories, encoded checkpoints, indexed terminal records and the configured per-member encoded Result/checkpoint limit times the retention/worker count. Shared Plan storage, callback captures, allocator overhead, solver/history scratch, serialization buffers and OS thread stacks are excluded; this is not a heap or peak-memory bound. Each produced member is checked before collection acceptance. Recompute retains a canonical Result fingerprint excluding elapsed wall time.

Errors

Rejects foreign Plans/checkpoints, inconsistent observation schedules and unaddressable or excessive storage charges before copying or running members.

pub fn time_plan(&self) -> Option<&CommonTimePlan>

Signature links:time_planOption

The immutable time Plan, absent for steady evaluation maps.

pub fn time_requests(&self) -> Option<&[CommonTimeRunRequest]>

Signature links:time_requestsOption

Complete original time requests in occurrence order, including repeats.

pub fn time_checkpoints(&self) -> Option<&[Option<CommonTimeCheckpoint>]>

Signature links:time_checkpointsOptionOption

Explicit restart checkpoints in the same original occurrence order.

§

impl EvaluationMapPlan

Signature links:EvaluationMapPlan

pub fn new( program: Arc<DifferentiableProgram>, points: &[DifferentiableValues], shared_inputs: &[Id<Parameter>], policy: EvaluationMapExecutionPolicy, ) -> Result<EvaluationMapPlan, Diagnostic>

Signature links:newArcDifferentiableProgramDifferentiableValuesIdParameterEvaluationMapExecutionPolicyResultEvaluationMapPlanDiagnostic

Admit complete points, an explicit shared-input selection and execution policy.

Shared inputs retain their selected order and must be bit-identical across all points. An empty selection makes every input occurrence-local.

The storage estimate includes every planned point and indexed terminal evidence, the policy’s resident numerical buffers and bounded ordering buffers, plus the explicit shared-input ID inventory. Deployment metadata uses its encoded-size charge, not a heap upper bound. Shared Program storage, allocator overhead, solver scratch, OS thread stacks, diagnostic strings and callback-owned allocations are excluded: this is neither a process-memory nor peak-memory limit.

Errors

Rejects foreign Models, roles, types or input order, unsupported providers and checked count/storage overflow before any member executes or points are copied.

pub fn from_samples( program: Arc<DifferentiableProgram>, samples: &[SampledParameterPoint], shared_inputs: &[Id<Parameter>], policy: EvaluationMapExecutionPolicy, ) -> Result<EvaluationMapPlan, Diagnostic>

Signature links:from_samplesArcDifferentiableProgramSampledParameterPointIdParameterEvaluationMapExecutionPolicyResultEvaluationMapPlanDiagnostic

Admit already frozen sampled points with their full sampling identity.

No sampler is retained or called. Repeated IDs and equal points keep their separate request positions; chunking and recomputation cannot change the generator, master stream, coupling, lineage or frozen input.

Errors

Rejects a foreign Program or point/input order and the same structural, provider and storage limits as Self::new, including sample metadata.

pub fn model(&self) -> &ModelArtifactReference

Signature links:modelModelArtifactReference

Exact Model shared by every admitted occurrence.

pub fn len(&self) -> usize

Signature links:lenusize

Complete occurrence count, including repeated and unstarted requests.

pub fn is_empty(&self) -> bool

Signature links:is_emptybool

Whether this admitted inventory is empty.

pub fn program_identity( &self, ) -> Result<&DifferentiableProgramIdentity, Diagnostic>

Signature links:program_identityResultDifferentiableProgramIdentityDiagnostic

Exact steady program identity; time maps reject this derivative projection.

pub fn shared_inputs(&self) -> Result<&[Id<Parameter>], Diagnostic>

Signature links:shared_inputsResultIdParameterDiagnostic

Explicit shared steady inputs; equal values never imply sharing.

pub fn points(&self) -> Result<&[DifferentiableValues], Diagnostic>

Signature links:pointsResultDifferentiableValuesDiagnostic

Complete frozen steady points; time maps retain their original Run requests instead.

pub fn samples(&self) -> Option<&[SampledParameterPoint]>

Signature links:samplesOptionSampledParameterPoint

Full frozen parameter-sampling association, when constructed from samples. Time sampling identities remain on the original time requests.

pub const fn policy(&self) -> EvaluationMapExecutionPolicy

Signature links:policyEvaluationMapExecutionPolicy

Explicit scheduling and accepted-state lifetime.

pub const fn estimated_storage_bytes(&self) -> usize

Signature links:estimated_storage_bytesusize

Admitted defined storage charge, not actual heap or peak process memory.

pub fn execute( &self, ) -> Result<CompleteEvaluationMap, EvaluationMapTerminalReport>

Signature links:executeResultCompleteEvaluationMapEvaluationMapTerminalReport

Execute with this plan’s bounded host scheduling and retention policy.

Errors

Returns indexed partial outcomes, never a fake complete collection.

pub fn execute_with_cancellation<C>( &self, should_cancel: C, ) -> Result<CompleteEvaluationMap, EvaluationMapTerminalReport>

where C: FnMut() -> bool,

Signature links:execute_with_cancellationResultCompleteEvaluationMapEvaluationMapTerminalReportFnMutbool

Execute with cooperative cancellation before dispatching occurrences.

In-flight members finish ordinary acceptance; no cancellation poll occurs within a member or after all occurrences are accepted. Empty maps are already complete. A failed member stays failed even if cancellation also arrives; independently accepted in-flight members remain inspectable.

Errors

Returns indexed failure/cancelled/not-started states on incomplete work.

pub fn execute_with_delivery<C, D>( &self, should_cancel: C, deliver: D, ) -> Result<CompleteEvaluationMap, EvaluationMapTerminalReport>

where C: FnMut() -> bool, D: FnMut(EvaluationMapOccurrenceId, EvaluationMapOccurrence<'_>),

Signature links:execute_with_deliveryResultCompleteEvaluationMapEvaluationMapTerminalReportFnMutboolFnMutEvaluationMapOccurrenceIdEvaluationMapOccurrence

Deliver accepted members in request order, at bounded chunk boundaries.

The occurrence ID binds delivery to this exact execution and request position. A fresh execution mints a fresh identity, including a retry of equal inputs. The callback only borrows each evaluation. Under Recompute, its primal and derivative buffers are released immediately after delivery. Retained callback copies are caller-owned, outside this plan’s storage charge. Accepted members of an incomplete chunk may also be delivered; only the final return type establishes complete membership. No reduction, failure filtering or normalization is implicit in delivery.

Errors

Preserves every member failure and cancellation in an indexed report.

Trait Implementations

§

impl Clone for EvaluationMapPlan

Signature links:CloneEvaluationMapPlan

§

fn clone(&self) -> EvaluationMapPlan

Signature links:cloneEvaluationMapPlan

Returns a duplicate of the value.

§

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

Signature links:unstableSourceclone_from

Performs copy-assignment from source.

§

impl Debug for EvaluationMapPlan

Signature links:DebugEvaluationMapPlan

§

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

Signature links:fmtFormatterResult()Error

Formats the value using the given formatter.

§

impl PartialEq for EvaluationMapPlan

Signature links:PartialEqEvaluationMapPlan

§

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

Signature links:eqEvaluationMapPlanbool

Tests for self and other values to be equal, and is used by ==.

§

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

Signature links:unstableSourcene&Rhsbool

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