nvalchemi.csp.packer.PackingResult#
- class nvalchemi.csp.packer.PackingResult(structures, run_id, reports, scope='local')[source]#
Typed structures and one or more reports for a packing call.
The payload may contain compact RigidMoleculeASUBatch rows or materialized Toolkit Batch graphs. Its count is checked against the reports at construction; report counters remain the stable packing outcome if a caller later filters or mutates the payload. A local result has one report. A gathered result has rank-ordered reports from zero through world_size minus one. This record performs no process-group communication.
- Parameters:
structures (RigidMoleculeASUBatch or Batch) – Compact ASU structures or materialized Toolkit graphs.
run_id (int) – Nonnegative 63-bit identity for this packing call.
reports (tuple of PackingReport) – Nonempty rank-ordered completion records. Their accepted counts must equal the number of structures present at construction.
scope (local or gathered, default=local) – Whether reports describe one rank or all ranks in rank order.
- accepted_count#
Number of structures accepted when the result was constructed.
- Type:
int
- requested_count#
Sum of requested counts across reports.
- Type:
int
- complete#
Whether the accepted count reaches the requested count.
- Type:
bool
- generated_count#
Sum of generated candidates, or None if any report omits that value.
- Type:
int or None
- stop_reason#
Summary of completion or rank-local shortfall reasons.
- Type:
- property accepted_count: int#
Number of structures accepted at result construction.
- property complete: bool#
Whether the accepted count reaches the requested count.
- property generated_count: int | None#
Sum of generated candidates, or
Noneif any rank is unknown.
- property requested_count: int#
Sum of requested counts across the represented rank reports.
- property stop_reason: PackingStopReason#
Summarize completion and any rank-local shortfall reasons.