From 5e1e70e027e6ee3762ecb996aef370012eca6c0a Mon Sep 17 00:00:00 2001 From: Andreas Kloeckner <inform@tiker.net> Date: Mon, 16 May 2016 20:21:11 -0500 Subject: [PATCH] Add missing documentation files --- doc/ref_ast.rst | 32 ++++++ doc/ref_containers.rst | 50 +++++++++ doc/ref_flow.rst | 34 +++++++ doc/ref_fundamental.rst | 221 ++++++++++++++++++++++++++++++++++++++++ doc/ref_schedule.rst | 28 +++++ 5 files changed, 365 insertions(+) create mode 100644 doc/ref_ast.rst create mode 100644 doc/ref_containers.rst create mode 100644 doc/ref_flow.rst create mode 100644 doc/ref_fundamental.rst create mode 100644 doc/ref_schedule.rst diff --git a/doc/ref_ast.rst b/doc/ref_ast.rst new file mode 100644 index 0000000..02e5bed --- /dev/null +++ b/doc/ref_ast.rst @@ -0,0 +1,32 @@ +Reference: Abstract Syntax Trees +================================ + +.. currentmodule:: islpy + +.. versionadded:: 2014.1 + +AST Expression +-------------- + +.. autoclass:: AstExpr + :members: + +AST Node +-------- + +.. autoclass:: AstNode + :members: + +AST Build +--------- + +.. autoclass:: AstBuild + :members: + +AST Print Options +----------------- + +.. autoclass:: AstPrintOptions + :members: + + diff --git a/doc/ref_containers.rst b/doc/ref_containers.rst new file mode 100644 index 0000000..71dbef9 --- /dev/null +++ b/doc/ref_containers.rst @@ -0,0 +1,50 @@ +Reference: Containers +===================== + +.. currentmodule:: islpy + +Lists +^^^^^ + +.. autoclass:: IdList + :members: + +.. autoclass:: ValList + :members: + +.. autoclass:: BasicSetList + :members: + +.. autoclass:: BasicMapList + :members: + +.. autoclass:: SetList + :members: + +.. autoclass:: MapList + :members: + +.. autoclass:: UnionSetList + :members: + +.. autoclass:: AffList + :members: + +.. autoclass:: UnionPwAffList + :members: + +.. autoclass:: BandList + :members: + +.. autoclass:: AstExprList + :members: + +.. autoclass:: AstNodeList + :members: + +Dictionaries +^^^^^^^^^^^^ + +.. autoclass:: IdToAstExpr + :members: + diff --git a/doc/ref_flow.rst b/doc/ref_flow.rst new file mode 100644 index 0000000..803f483 --- /dev/null +++ b/doc/ref_flow.rst @@ -0,0 +1,34 @@ +Dataflow +^^^^^^^^ + +Access Info +----------- + +.. autoclass:: AccessInfo + :members: + +Union Access Info +----------------- + +.. autoclass:: UnionAccessInfo + :members: + +Restriction +----------- + +.. autoclass:: Restriction + :members: + +Flow +---- + +.. autoclass:: Flow + :members: + +Union Flow +---------- + +.. autoclass:: UnionFlow + :members: + + diff --git a/doc/ref_fundamental.rst b/doc/ref_fundamental.rst new file mode 100644 index 0000000..f4e59e7 --- /dev/null +++ b/doc/ref_fundamental.rst @@ -0,0 +1,221 @@ +Reference: Basic Building Blocks +================================ + +.. currentmodule:: islpy + +Context +------- + +.. autoclass:: Context() + :members: + +Id +-- + +.. autoclass:: Id + :members: + +Space +----- + +(formerly called :class:`Dim`. A compatibility alias is in place.) + +.. autoclass:: Space + :members: + +Local Space +----------- + +.. autoclass:: LocalSpace + :members: + +Constraints +----------- + +.. autoclass:: Constraint + :members: + +Value +----- + +.. autoclass:: Val + :members: + +Multi-Value +----------- + +.. autoclass:: MultiVal + :members: + +Vector +------ + +.. autoclass:: Vec + :members: + +Matrix +------ + +.. autoclass:: Mat + :members: + +Sets and Maps +^^^^^^^^^^^^^ + +Basic Set +--------- + +.. autoclass:: BasicSet + :members: + +Basic Map +--------- + +.. autoclass:: BasicMap + :members: + +Set +--- + +.. autoclass:: Set + :members: + +Map +--- + +.. autoclass:: Map + :members: + +Union Set +--------- + +.. autoclass:: UnionSet + :members: + +Union Map +--------- + +.. autoclass:: UnionMap + :members: + +Geometric Entities +^^^^^^^^^^^^^^^^^^ + +Point +----- + +.. autoclass:: Point + :members: + +Vertex +------ + +.. autoclass:: Vertex + :members: + +Vertices +-------- + +.. autoclass:: Vertices + :members: + +Cell +---- + +.. autoclass:: Cell + :members: + +Quasi-Affine Expressions +^^^^^^^^^^^^^^^^^^^^^^^^ + +Quasi-Affine Expression +----------------------- + +.. autoclass:: Aff + :members: + +Piecewise Quasi-Affine Expression +--------------------------------- + +.. autoclass:: PwAff + :members: + +Union of Piecewise Quasi-Affine Expressions +------------------------------------------- + +.. autoclass:: UnionPwAff + :members: + +Multiple Union of Piecewise Quasi-Affine Expressions +---------------------------------------------------- + +.. autoclass:: MultiUnionPwAff + :members: + + +Multiple Affine Expressions +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Multiple Affine Expression +-------------------------- + +.. autoclass:: MultiAff + :members: + +Piecewise Multiple Affine Expression +------------------------------------ + +.. autoclass:: PwMultiAff + :members: + +Union of Piecewise Multiple Affine Expressions +---------------------------------------------- + +.. autoclass:: UnionPwMultiAff + :members: + +Quasipolynomials +^^^^^^^^^^^^^^^^ + +Term +---- + +.. autoclass:: Term + :members: + +QPolynomial +----------- + +.. autoclass:: QPolynomial + :members: + +PwQPolynomial +------------- + +.. autoclass:: PwQPolynomial + :members: + +UnionPwQPolynomial +------------------ + +.. autoclass:: UnionPwQPolynomial + :members: + +QPolynomialFold +--------------- + +.. autoclass:: QPolynomialFold + :members: + +PwQPolynomial +------------- + +.. autoclass:: PwQPolynomialFold + :members: + +UnionPwQPolynomialFold +---------------------- + +.. autoclass:: UnionPwQPolynomialFold + :members: + diff --git a/doc/ref_schedule.rst b/doc/ref_schedule.rst new file mode 100644 index 0000000..e38e5ba --- /dev/null +++ b/doc/ref_schedule.rst @@ -0,0 +1,28 @@ +Reference: Scheduling +===================== + +.. currentmodule:: islpy + +Band +---- + +.. autoclass:: Band + :members: + +Schedule +-------- + +.. autoclass:: Schedule + :members: + +Schedule Node +------------- + +.. autoclass:: ScheduleNode + :members: + +ScheduleConstraints +------------------- + +.. autoclass:: ScheduleConstraints + :members: -- GitLab