Skip to content

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 OA
help?> OP.encode
help?> OP.encoding_module
help?> OA.structure_map

OP 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.

TaskOperations to look upGuide
Retain a finite descriptionOP.encode, OP.encoding_poset, OP.encoding_mapFinite encodings
Query spaces and mapsOP.dimensions, OA.locate, OA.structure_mapExploring spaces and maps
Request deferred computationsOP.describe, OP.encoding_moduleInspection and explicit computation
Compute an ordinary barcodeOP.persistence_diagram, OP.cubical_persistenceOrdinary persistence
View or export a resultOP.available_visuals, OA.visual_spec, OP.visualize, OP.save_visualChoosing views and inspecting intervals
Interpret algebraic scopeOP.hom, OP.ext, OP.tor, OP.resolveMathematical categories
Choose coefficients and geometryOA.EncodingOptions, OP.PipelineOptionsOptions and their effects

Guides and shared contracts

Getting started

Persistence and filtered complexes

Finite descriptions and parameter queries

Modules, maps and derived algebra

Features and data analysis

Visualization and interaction

Supporting resources:

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.