Skip to content
Snippets Groups Projects
Commit 5ca45f2b authored by Frederik Hennig's avatar Frederik Hennig
Browse files

fix doc errors from recent merge

parent 9cb46e2d
No related branches found
No related tags found
1 merge request!425Refactor and Improve Documentation
Pipeline #70263 passed
...@@ -193,22 +193,27 @@ class FullIterationSpace(IterationSpace): ...@@ -193,22 +193,27 @@ class FullIterationSpace(IterationSpace):
@property @property
def dimensions(self): def dimensions(self):
"""The dimensions of this iteration space"""
return self._dimensions return self._dimensions
@property @property
def lower(self): def lower(self):
"""Lower limits of each dimension"""
return (dim.start for dim in self._dimensions) return (dim.start for dim in self._dimensions)
@property @property
def upper(self): def upper(self):
"""Upper limits of each dimension"""
return (dim.stop for dim in self._dimensions) return (dim.stop for dim in self._dimensions)
@property @property
def steps(self): def steps(self):
"""Iteration steps of each dimension"""
return (dim.step for dim in self._dimensions) return (dim.step for dim in self._dimensions)
@property @property
def archetype_field(self) -> Field | None: 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 return self._archetype_field
@property @property
...@@ -231,6 +236,13 @@ class FullIterationSpace(IterationSpace): ...@@ -231,6 +236,13 @@ class FullIterationSpace(IterationSpace):
def actual_iterations( def actual_iterations(
self, dimension: int | FullIterationSpace.Dimension | None = None self, dimension: int | FullIterationSpace.Dimension | None = None
) -> PsExpression: ) -> 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 .typification import Typifier
from ..transformations import EliminateConstants from ..transformations import EliminateConstants
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment