Loading...
Searching...
No Matches
meshkit::plan::ConstraintAuditOptions Struct Reference

Pins, cancellation and resource limits for the constraint audits. More...

#include <meshkit/constraintaudit.hpp>

Collaboration diagram for meshkit::plan::ConstraintAuditOptions:

Public Attributes

Vector< Point2 > protectedPoints
 XY pins that simplified shortcuts must not cross, sweep over or (with the feature's minimumClearance) approach; a non-finite pin is a violation.
 
std::function< bool()> cancelled
 Optional; polled before work starts and every 4096 work units.
 
std::uint64_t workBudget = 0
 Work units allowed; 0 selects 256 per input item plus 100,000 (items: original and candidate vertices and pins, or constraint vertices, delivered edges and cells).
 
std::uint64_t maximumWorkspaceBytes = std::uint64_t(1) << 30
 Estimated workspace limit in bytes (default 1 GiB); exceeding it sets resourceLimited.
 
int maximumExamples = 20
 Violations kept in ConstraintAuditReport::examples, clamped to [0, 1000]; all are still counted.
 

Detailed Description

Pins, cancellation and resource limits for the constraint audits.

Member Data Documentation

◆ cancelled

std::function<bool()> meshkit::plan::ConstraintAuditOptions::cancelled

Optional; polled before work starts and every 4096 work units.

Returning true stops the audit with cancelled set; the report is then incomplete and never ok.

◆ maximumExamples

int meshkit::plan::ConstraintAuditOptions::maximumExamples = 20

Violations kept in ConstraintAuditReport::examples, clamped to [0, 1000]; all are still counted.

Default 20.

◆ maximumWorkspaceBytes

std::uint64_t meshkit::plan::ConstraintAuditOptions::maximumWorkspaceBytes = std::uint64_t(1) << 30

Estimated workspace limit in bytes (default 1 GiB); exceeding it sets resourceLimited.

Not a limit on total process memory.

◆ protectedPoints

Vector<Point2> meshkit::plan::ConstraintAuditOptions::protectedPoints

XY pins that simplified shortcuts must not cross, sweep over or (with the feature's minimumClearance) approach; a non-finite pin is a violation.

Used only by auditConstraintSimplification().

◆ workBudget

std::uint64_t meshkit::plan::ConstraintAuditOptions::workBudget = 0

Work units allowed; 0 selects 256 per input item plus 100,000 (items: original and candidate vertices and pins, or constraint vertices, delivered edges and cells).

Exhaustion sets resourceLimited.


The documentation for this struct was generated from the following file: