Modules¶

The package layout of cmenpy, one entry per subpackage. Only the module docstrings are repeated here — the full autodoc for every symbol lives in Classes and Functions, and each entry links to the sections that document it.

cmenpy¶

The top-level package. Re-exports the whole public surface (see __all__ in the source) and carries __version__.

cmenpy ¶

Compute Metaheuristic Engine for Python (cmenpy).

cmenpy.compile¶

Numba kernel decorators, their typing markers and introspection helpers. Re-exported at the top level, so cmenpy.precompile and cmenpy.compile.precompile are the same object.

Documented in Functions → Kernel decorators, Functions → Signature markers and Functions → Introspection.

compile ¶

Numba kernel decorators, their typing markers and introspection helpers.

cmenpy.model¶

Model declaration: the function-style declare and class-style template decorators, the field markers, the optimizer classes and the builders that turn a declaration into a runnable model.

Documented in Classes → Optimizers, Classes → Field markers, Classes → Protocols and Functions → Declaration decorators.

model ¶

Model declaration API: the function-style declare and class-style template.

cmenpy.population¶

Population abstractions: the PopulationSwarm handle, the stream operators and pipelines, the matrix views and the roster/iteration bases.

Documented in Classes → Population.

population ¶

Population abstractions (PopulationSwarm).

cmenpy.kernel¶

The flat population buffer (KernelBuffer) plus the mask, size and ranking support types.

Documented in Classes → Buffer and Functions → Builders and factories.

kernel ¶

Population buffer types (KernelBuffer, KernelMask, KernelSize).

cmenpy.target¶

Objective wrappers: the vectorized-target marker and the NFE-counting TargetFunction that enforces the evaluation budget.

Documented in Classes → Objectives and Functions → Declaration decorators.

target ¶

Objective wrappers: vectorized targets and the NFE-counting TargetFunction.

cmenpy.bounds¶

The search-space description handed to solve.

Documented in Classes → Search space and Functions → Builders and factories.

bounds ¶

Search-space bounds: one (low, up) pair per dimension.

cmenpy.context¶

The per-epoch run context handed to models, and its owner.

Documented in Classes → Runtime.

context ¶

Per-epoch run context (Context) and its owner (MainContextManager).

cmenpy.epoch¶

The epoch iterator that drives a run.

Documented in Classes → Runtime.

epoch ¶

The epoch iterator (EpochIteration) driving a run.

cmenpy.tracker¶

The per-epoch history recorder and its snapshots (enabled with debug=True).

Documented in Classes → Runtime.

tracker ¶

Per-epoch history recorder (Tracker) and its snapshots.

cmenpy.generator¶

The seeded random generator handed to models as ctx.rng.

Documented in Classes → Runtime.

generator ¶

Seeded random generator handed to models as ctx.rng.

cmenpy.functools¶

Sense-aware fitness comparators used by selection operators.

Documented in Functions → Comparators.

functools ¶

Sense-aware fitness comparators (is_best, is_worst, best_index, ...).

cmenpy.mixin¶

Reusable Operator Modules (@cm.module) for composing model behavior.

Documented in Functions → Declaration decorators.

mixin ¶

Reusable Operator Modules (@cm.module) for composing model behavior.

cmenpy.hints¶

Typing aliases, cast-spec markers and the structural protocols shared across cmenpy. A pure numpy/typing leaf — it imports nothing from the rest of the package.

Documented in Classes → Protocols and Classes → Support types and aliases.

hints ¶

Typing aliases and cast-spec markers shared across cmenpy.