Expand description
Module and function contracts, invocation arguments, and outcomes.
Structs§
- Args
- Validated arguments for a function invocation.
- Assumption
- An explicit method assumption.
- Deprecation
- Deprecation metadata.
- Error
Estimate - A validated numerical error estimate, only present when the method can actually provide one.
- Example
- A documented, executable example. CI runs every example and checks the expectation so documentation cannot drift from behaviour.
- Function
Descriptor - The authoritative function declaration.
- Function
Ref - A reference to a function and its version.
- Module
- A statically registered module.
- Module
Descriptor - Metadata describing a module.
- Outcome
- A successful invocation outcome.
- Param
Descriptor - A function parameter.
- Simple
Function - A function implemented by a plain function pointer plus its descriptor.
- Trace
- A bounded execution trace of computational steps. This is not a narrative explanation and contains no hidden reasoning.
- Trace
Step - One bounded trace step.
- Warning
- Warning attached to a result.
Enums§
- Assumption
Source - Where an assumption came from.
- Cost
Class - Rough cost class, used for documentation and batch budgeting.
- Determinism
- Determinism class of a function.
- Example
Expectation - Expected outcome of a documented example.
- Purity
- Whether a function has side effects.
Traits§
- Function
- The callable interface implemented by every function in every module.
Functions§
- require_
mode - Helper to require that the context mode is supported by a function.