From 5ca45f2bc9663a5de6e131e0bef8ac2f6cf11cc4 Mon Sep 17 00:00:00 2001 From: Frederik Hennig <frederik.hennig@fau.de> Date: Wed, 13 Nov 2024 12:15:31 +0100 Subject: [PATCH] fix doc errors from recent merge --- .../backend/kernelcreation/iteration_space.py | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/src/pystencils/backend/kernelcreation/iteration_space.py b/src/pystencils/backend/kernelcreation/iteration_space.py index 18cec5ecf..50a0e3140 100644 --- a/src/pystencils/backend/kernelcreation/iteration_space.py +++ b/src/pystencils/backend/kernelcreation/iteration_space.py @@ -193,22 +193,27 @@ class FullIterationSpace(IterationSpace): @property def dimensions(self): + """The dimensions of this iteration space""" return self._dimensions @property def lower(self): + """Lower limits of each dimension""" return (dim.start for dim in self._dimensions) @property def upper(self): + """Upper limits of each dimension""" return (dim.stop for dim in self._dimensions) @property def steps(self): + """Iteration steps of each dimension""" return (dim.step for dim in self._dimensions) @property def archetype_field(self) -> Field | None: + """Field whose shape and memory layout act as archetypes for this iteration space's dimensions.""" return self._archetype_field @property @@ -231,6 +236,13 @@ class FullIterationSpace(IterationSpace): def actual_iterations( self, dimension: int | FullIterationSpace.Dimension | None = None ) -> PsExpression: + """Construct an expression representing the actual number of unique points inside the iteration space. + + Args: + dimension: If an integer or a `Dimension` object is given, the number of iterations in that + dimension is computed. If `None`, the total number of iterations inside the entire space + is computed. + """ from .typification import Typifier from ..transformations import EliminateConstants -- GitLab