API reference and operation help
Use reference material when you know the operation you need and want its accepted arguments, return object, mathematical scope or validation behavior. For a connected workflow with interpreted results, begin with Using TamerOp.
Find an operation's contract
Julia's help mode reads the method documentation shipped with the package. Import TamerOp, then type ? at the Julia prompt to enter help mode:
import TamerOp as OP
import TamerOp.Advanced as OAhelp?> OP.encode
help?> OP.encoding_module
help?> OA.structure_mapOP exposes the main workflows and result accessors. OA exposes detailed constructors, queries and validators. Subsystem owners also provide qualified APIs, for example OP.FieldLinAlg.solve_fullcolumn; look up the method you intend to call rather than inferring its contract from another overload. Help displays method signatures, mathematical meaning and applicable options.
Operations in context
These links lead to explanatory guides. The named operations also have method-specific help in Julia.
| Task | Operations to look up | Guide |
|---|---|---|
| Retain a finite description | OP.encode, OP.encoding_poset, OP.encoding_map | Finite encodings |
| Query spaces and maps | OP.dimensions, OA.locate, OA.structure_map | Exploring spaces and maps |
| Request deferred computations | OP.describe, OP.encoding_module | Inspection and explicit computation |
| Compute an ordinary barcode | OP.persistence_diagram, OP.cubical_persistence | Ordinary persistence |
| View or export a result | OP.available_visuals, OA.visual_spec, OP.visualize, OP.save_visual | Choosing views and inspecting intervals |
| Interpret algebraic scope | OP.hom, OP.ext, OP.tor, OP.resolve | Mathematical categories |
| Choose coefficients and geometry | OA.EncodingOptions, OP.PipelineOptions | Options and their effects |
Shared contracts
- Options must affect the requested computation — API reference. Which options change mathematical meaning, computation, or storage?
- Visualization reference — API reference. Which visual specifications, sessions, renderers and exports are supported?
The API inventory guide explains how the public bindings and documentation coverage are maintained. It is contributor material; use operation help and the relevant contracts above for a query's calling conventions.