diff --git a/doc/index.rst b/doc/index.rst index 304bc619670909b4d254f7e28dc849bf76ea0025..9df2f5960197a29e22624c8e9d6825121ddd1d31 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -63,8 +63,11 @@ an idea. misc reference ref_fundamental + ref_expr + ref_set + ref_geo ref_ast - ref_flow.rst + ref_flow ref_schedule ref_containers 🚀 Github diff --git a/doc/ref_expr.rst b/doc/ref_expr.rst new file mode 100644 index 0000000000000000000000000000000000000000..3d225834febca5a58a2c864f3fcbd915e72b2b53 --- /dev/null +++ b/doc/ref_expr.rst @@ -0,0 +1,104 @@ +Reference: Expression-like Objects +================================== + +.. currentmodule:: islpy + +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: + +Multiple Piecewise Affine Expression +------------------------------------ + +.. autoclass:: MultiPwAff + :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_fundamental.rst b/doc/ref_fundamental.rst index f769771eb3b01a2fe6b8b8a026208cebb6117b69..9183b1736f2a49fe7e1074f488e2089f60a1b778 100644 --- a/doc/ref_fundamental.rst +++ b/doc/ref_fundamental.rst @@ -64,184 +64,6 @@ 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: - -StrideInfo ----------- - -.. autoclass:: StrideInfo - :members: - -Cell ----- - -.. autoclass:: Cell - :members: - -Fixed Box ---------- - -.. autoclass:: FixedBox - :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: - -Multiple Piecewise Affine Expression ------------------------------------- - -.. autoclass:: MultiPwAff - :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: - Canonical Names for Internal Module ----------------------------------- diff --git a/doc/ref_geo.rst b/doc/ref_geo.rst new file mode 100644 index 0000000000000000000000000000000000000000..d6eec64ee759aa759da7fa0048365b7c4191f543 --- /dev/null +++ b/doc/ref_geo.rst @@ -0,0 +1,42 @@ +Reference: Geometric Entities +============================= + +.. currentmodule:: islpy + +Point +----- + +.. autoclass:: Point + :members: + +Vertex +------ + +.. autoclass:: Vertex + :members: + +Vertices +-------- + +.. autoclass:: Vertices + :members: + +StrideInfo +---------- + +.. autoclass:: StrideInfo + :members: + +Cell +---- + +.. autoclass:: Cell + :members: + +Fixed Box +--------- + +.. autoclass:: FixedBox + :members: + + diff --git a/doc/ref_set.rst b/doc/ref_set.rst new file mode 100644 index 0000000000000000000000000000000000000000..44602d9f8f89a556dceb7056ab4963a936dd40f1 --- /dev/null +++ b/doc/ref_set.rst @@ -0,0 +1,42 @@ +Reference: Sets and Maps +======================== + +.. currentmodule:: islpy + +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: + +