API reference and operation help
When you know which operation you need, its reference explains the arguments it accepts, the object it returns and the conditions under which the result has the stated meaning. It also describes how to check your inputs. To see how several operations work together on an example, begin with Using TamerOp, where the guides follow and interpret the computation.
The coding agent guide gives task routes, executable examples and guidance for using the documentation shipped with the installed package.
Find an operation's contract
An operation's contract is the combination of its accepted inputs, guarantees and requirements. Julia's help mode reads the method documentation shipped with the package, so you can consult these details in the version you are using. 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 gives you the main workflows and operations for inspecting results. OA gives access to more detailed ways of constructing, querying and checking objects. Some operations belong to a particular part of the library, as in OP.FieldLinAlg.solve_fullcolumn for a linear algebra calculation. A Julia function can have several methods for different kinds of arguments; consult the method you intend to call, since its conditions may differ from those of another method. Help displays these calling forms, their mathematical meaning and the available 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 |
Guides and shared contracts
Getting started
- Using TamerOp with coding agents — API reference. How can a coding agent choose a TamerOp workflow, run it and interpret its result?
Persistence and filtered complexes
- Filtered pairs and relative persistence — API reference. What input, basis and map conventions define relative persistence?
- Source representatives — API reference. What is retained and verified when a chain or cocycle is traced to source cells?
Finite descriptions and parameter queries
- Change-of-poset reference — API reference. What do restriction, pushforward and common-refinement operations guarantee?
- Options must affect the requested computation — API reference. Which options change mathematical meaning, computation, or storage?
Modules, maps and derived algebra
- Derived algebra reference — API reference. What are the contracts of Hom, Ext, Tor, products and spectral computations?
- Finite modules, selected vectors and submodules — API reference. What are the exact contracts for finite posets, modules, morphisms and presentations?
- Interval decomposition contracts — API reference. Which multiplicities, summands, subquotients and witnesses are certified by a result?
Features and data analysis
- Ensembles of persistence results — API reference. What alignment and statistical contracts do ensemble computations accept and guarantee?
Visualization and interaction
- Live and saved inspection sessions — API reference. What state and computation does a session retain, and which actions work in each execution environment?
- Visualization reference — API reference. Which visual specifications, sessions, renderers and exports are supported?
Supporting resources:
- From points to a finite encoding. How can an agent construct and inspect a small multiparameter persistence example?
- Compute with a module's spaces and maps. How can an agent describe a finite module and check the maps between its spaces?
- Inspect a result and save its figure. How can an agent inspect a visual result and save it for its user?
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.