mapFolding 0.2.2__py3-none-any.whl → 0.2.4__py3-none-any.whl

mapFolding/reference/flattened.py

@@ -0,0 +1,376 @@
+"""The algorithm flattened into semantic sections.
+This version is not maintained, so you may see differences from the current version."""
+from numpy import integer
+from numpy.typing import NDArray
+from typing import List, Any, Final, Optional, Union, Sequence, Tuple, Type, TypedDict
+import enum
+import numpy
+import sys
+
+def countFolds(listDimensions: Sequence[int], computationDivisions = None, CPUlimit: Optional[Union[int, float, bool]] = None):
+    def doWhile():
+
+        while activeLeafGreaterThan0Condition():
+
+            if activeLeafIsTheFirstLeafCondition() or leafBelowSentinelIs1Condition():
+
+                if activeLeafGreaterThanLeavesTotalCondition():
+                    foldsSubTotalsIncrement()
+
+                else:
+
+                    findGapsInitializeVariables()
+                    while loopingTheDimensions():
+
+                        if dimensionsUnconstrainedCondition():
+                            dimensionsUnconstrainedIncrement()
+
+                        else:
+
+                            leafConnecteeInitialization()
+                            while loopingLeavesConnectedToActiveLeaf():
+                                if thereAreComputationDivisionsYouMightSkip():
+                                    countGaps()
+                                leafConnecteeUpdate()
+
+                        dimension1ndexIncrement()
+
+                    if allDimensionsAreUnconstrained():
+                        insertUnconstrainedLeaf()
+
+                    indexMiniGapInitialization()
+                    while loopingToActiveGapCeiling():
+                        filterCommonGaps()
+                        indexMiniGapIncrement()
+
+            while backtrackCondition():
+                backtrack()
+
+            if placeLeafCondition():
+                placeLeaf()
+
+    def activeGapIncrement():
+        my[indexMy.gap1ndex] += 1
+
+    def activeLeafGreaterThan0Condition():
+        return my[indexMy.leaf1ndex] > 0
+
+    def activeLeafGreaterThanLeavesTotalCondition():
+        return my[indexMy.leaf1ndex] > the[indexThe.leavesTotal]
+
+    def activeLeafIsTheFirstLeafCondition():
+        return my[indexMy.leaf1ndex] <= 1
+
+    def activeLeafNotEqualToTaskDivisionsCondition():
+        return my[indexMy.leaf1ndex] != the[indexThe.taskDivisions]
+
+    def allDimensionsAreUnconstrained():
+        return my[indexMy.dimensionsUnconstrained] == the[indexThe.dimensionsTotal]
+
+    def backtrack():
+        my[indexMy.leaf1ndex] -= 1
+        track[indexTrack.leafBelow, track[indexTrack.leafAbove, my[indexMy.leaf1ndex]]] = track[indexTrack.leafBelow, my[indexMy.leaf1ndex]]
+        track[indexTrack.leafAbove, track[indexTrack.leafBelow, my[indexMy.leaf1ndex]]] = track[indexTrack.leafAbove, my[indexMy.leaf1ndex]]
+
+    def backtrackCondition():
+        return my[indexMy.leaf1ndex] > 0 and my[indexMy.gap1ndex] == track[indexTrack.gapRangeStart, my[indexMy.leaf1ndex] - 1]
+
+    def computationDivisionsCondition():
+        return the[indexThe.taskDivisions] == int(False)
+
+    def countGaps():
+        gapsWhere[my[indexMy.gap1ndexCeiling]] = my[indexMy.leafConnectee]
+        if track[indexTrack.countDimensionsGapped, my[indexMy.leafConnectee]] == 0:
+            gap1ndexCeilingIncrement()
+        track[indexTrack.countDimensionsGapped, my[indexMy.leafConnectee]] += 1
+
+    def dimension1ndexIncrement():
+        my[indexMy.dimension1ndex] += 1
+
+    def dimensionsUnconstrainedCondition():
+        return connectionGraph[my[indexMy.dimension1ndex], my[indexMy.leaf1ndex], my[indexMy.leaf1ndex]] == my[indexMy.leaf1ndex]
+
+    def dimensionsUnconstrainedIncrement():
+        my[indexMy.dimensionsUnconstrained] += 1
+
+    def filterCommonGaps():
+        gapsWhere[my[indexMy.gap1ndex]] = gapsWhere[my[indexMy.indexMiniGap]]
+        if track[indexTrack.countDimensionsGapped, gapsWhere[my[indexMy.indexMiniGap]]] == the[indexThe.dimensionsTotal] - my[indexMy.dimensionsUnconstrained]:
+            activeGapIncrement()
+        track[indexTrack.countDimensionsGapped, gapsWhere[my[indexMy.indexMiniGap]]] = 0
+
+    def findGapsInitializeVariables():
+        my[indexMy.dimensionsUnconstrained] = 0
+        my[indexMy.gap1ndexCeiling] = track[indexTrack.gapRangeStart, my[indexMy.leaf1ndex] - 1]
+        my[indexMy.dimension1ndex] = 1
+
+    def foldsSubTotalsIncrement():
+        foldsSubTotals[my[indexMy.taskIndex]] += the[indexThe.leavesTotal]
+
+    def gap1ndexCeilingIncrement():
+        my[indexMy.gap1ndexCeiling] += 1
+
+    def indexMiniGapIncrement():
+        my[indexMy.indexMiniGap] += 1
+
+    def indexMiniGapInitialization():
+        my[indexMy.indexMiniGap] = my[indexMy.gap1ndex]
+
+    def insertUnconstrainedLeaf():
+        my[indexMy.indexLeaf] = 0
+        while my[indexMy.indexLeaf] < my[indexMy.leaf1ndex]:
+            gapsWhere[my[indexMy.gap1ndexCeiling]] = my[indexMy.indexLeaf]
+            my[indexMy.gap1ndexCeiling] += 1
+            my[indexMy.indexLeaf] += 1
+
+    def leafBelowSentinelIs1Condition():
+        return track[indexTrack.leafBelow, 0] == 1
+
+    def leafConnecteeInitialization():
+        my[indexMy.leafConnectee] = connectionGraph[my[indexMy.dimension1ndex], my[indexMy.leaf1ndex], my[indexMy.leaf1ndex]]
+
+    def leafConnecteeUpdate():
+        my[indexMy.leafConnectee] = connectionGraph[my[indexMy.dimension1ndex], my[indexMy.leaf1ndex], track[indexTrack.leafBelow, my[indexMy.leafConnectee]]]
+
+    def loopingLeavesConnectedToActiveLeaf():
+        return my[indexMy.leafConnectee] != my[indexMy.leaf1ndex]
+
+    def loopingTheDimensions():
+        return my[indexMy.dimension1ndex] <= the[indexThe.dimensionsTotal]
+
+    def loopingToActiveGapCeiling():
+        return my[indexMy.indexMiniGap] < my[indexMy.gap1ndexCeiling]
+
+    def placeLeaf():
+        my[indexMy.gap1ndex] -= 1
+        track[indexTrack.leafAbove, my[indexMy.leaf1ndex]] = gapsWhere[my[indexMy.gap1ndex]]
+        track[indexTrack.leafBelow, my[indexMy.leaf1ndex]] = track[indexTrack.leafBelow, track[indexTrack.leafAbove, my[indexMy.leaf1ndex]]]
+        track[indexTrack.leafBelow, track[indexTrack.leafAbove, my[indexMy.leaf1ndex]]] = my[indexMy.leaf1ndex]
+        track[indexTrack.leafAbove, track[indexTrack.leafBelow, my[indexMy.leaf1ndex]]] = my[indexMy.leaf1ndex]
+        track[indexTrack.gapRangeStart, my[indexMy.leaf1ndex]] = my[indexMy.gap1ndex]
+        my[indexMy.leaf1ndex] += 1
+
+    def placeLeafCondition():
+        return my[indexMy.leaf1ndex] > 0
+
+    def taskIndexCondition():
+        return my[indexMy.leafConnectee] % the[indexThe.taskDivisions] == my[indexMy.taskIndex]
+
+    def thereAreComputationDivisionsYouMightSkip():
+        if computationDivisionsCondition():
+            return True
+        if activeLeafNotEqualToTaskDivisionsCondition():
+            return True
+        if taskIndexCondition():
+            return True
+        return False
+
+    stateUniversal = outfitFoldings(listDimensions, computationDivisions=computationDivisions, CPUlimit=CPUlimit)
+    connectionGraph: Final[numpy.ndarray] = stateUniversal['connectionGraph']
+    foldsSubTotals = stateUniversal['foldsSubTotals']
+    gapsWhere = stateUniversal['gapsWhere']
+    my = stateUniversal['my']
+    the: Final[numpy.ndarray] = stateUniversal['the']
+    track = stateUniversal['track']
+
+    if the[indexThe.taskDivisions] == int(False):
+        doWhile()
+    else:
+        stateUniversal['my'] = my.copy()
+        stateUniversal['gapsWhere'] = gapsWhere.copy()
+        stateUniversal['track'] = track.copy()
+        for indexSherpa in range(the[indexThe.taskDivisions]):
+            my = stateUniversal['my'].copy()
+            my[indexMy.taskIndex] = indexSherpa
+            gapsWhere = stateUniversal['gapsWhere'].copy()
+            track = stateUniversal['track'].copy()
+            doWhile()
+
+    return numpy.sum(foldsSubTotals).item()
+
+@enum.verify(enum.CONTINUOUS, enum.UNIQUE) if sys.version_info >= (3, 11) else lambda x: x
+class EnumIndices(enum.IntEnum):
+    """Base class for index enums."""
+    @staticmethod
+    def _generate_next_value_(name, start, count, last_values):
+        """0-indexed."""
+        return count
+
+    def __index__(self) -> int:
+        """Adapt enum to the ultra-rare event of indexing a NumPy 'ndarray', which is not the
+        same as `array.array`. See NumPy.org; I think it will be very popular someday."""
+        return self
+
+class indexMy(EnumIndices):
+    """Indices for dynamic values."""
+    dimension1ndex = enum.auto()
+    dimensionsUnconstrained = enum.auto()
+    gap1ndex = enum.auto()
+    gap1ndexCeiling = enum.auto()
+    indexLeaf = enum.auto()
+    indexMiniGap = enum.auto()
+    leaf1ndex = enum.auto()
+    leafConnectee = enum.auto()
+    taskIndex = enum.auto()
+
+class indexThe(EnumIndices):
+    """Indices for static values."""
+    dimensionsTotal = enum.auto()
+    leavesTotal = enum.auto()
+    taskDivisions = enum.auto()
+
+class indexTrack(EnumIndices):
+    """Indices for state tracking array."""
+    leafAbove = enum.auto()
+    leafBelow = enum.auto()
+    countDimensionsGapped = enum.auto()
+    gapRangeStart = enum.auto()
+
+class computationState(TypedDict):
+    connectionGraph: NDArray[integer[Any]]
+    foldsSubTotals: NDArray[integer[Any]]
+    mapShape: Tuple[int, ...]
+    my: NDArray[integer[Any]]
+    gapsWhere: NDArray[integer[Any]]
+    the: NDArray[integer[Any]]
+    track: NDArray[integer[Any]]
+
+dtypeLarge = numpy.int64
+dtypeDefault = dtypeLarge
+
+def getLeavesTotal(listDimensions: Sequence[int]) -> int:
+    """
+    How many leaves are in the map.
+
+    Parameters:
+        listDimensions: A list of integers representing dimensions.
+
+    Returns:
+        productDimensions: The product of all positive integer dimensions.
+    """
+    listNonNegative = parseDimensions(listDimensions, 'listDimensions')
+    listPositive = [dimension for dimension in listNonNegative if dimension > 0]
+
+    if not listPositive:
+        return 0
+    else:
+        productDimensions = 1
+        for dimension in listPositive:
+            if dimension > sys.maxsize // productDimensions:
+                raise OverflowError(f"I received {dimension=} in {listDimensions=}, but the product of the dimensions exceeds the maximum size of an integer on this system.")
+            productDimensions *= dimension
+
+        return productDimensions
+
+def getTaskDivisions(computationDivisions: Optional[Union[int, str]], concurrencyLimit: int, CPUlimit: Optional[Union[bool, float, int]], listDimensions: Sequence[int]):
+    if not computationDivisions:
+        return 0
+    else:
+        leavesTotal = getLeavesTotal(listDimensions)
+    if isinstance(computationDivisions, int):
+        taskDivisions = computationDivisions
+    elif isinstance(computationDivisions, str):
+        computationDivisions = computationDivisions.lower()
+        if computationDivisions == "maximum":
+            taskDivisions = leavesTotal
+        elif computationDivisions == "cpu":
+            taskDivisions = min(concurrencyLimit, leavesTotal)
+    else:
+        raise ValueError("Not my problem.")
+
+    if taskDivisions > leavesTotal:
+        raise ValueError("What are you doing?")
+
+    return taskDivisions
+
+def makeConnectionGraph(listDimensions: Sequence[int], **keywordArguments: Optional[Type]) -> NDArray[integer[Any]]:
+    datatype = keywordArguments.get('datatype', dtypeDefault)
+    mapShape = validateListDimensions(listDimensions)
+    leavesTotal = getLeavesTotal(mapShape)
+    arrayDimensions = numpy.array(mapShape, dtype=datatype)
+    dimensionsTotal = len(arrayDimensions)
+
+    cumulativeProduct = numpy.multiply.accumulate([1] + mapShape, dtype=datatype)
+    coordinateSystem = numpy.zeros((dimensionsTotal + 1, leavesTotal + 1), dtype=datatype)
+    for dimension1ndex in range(1, dimensionsTotal + 1):
+        for leaf1ndex in range(1, leavesTotal + 1):
+            coordinateSystem[dimension1ndex, leaf1ndex] = ( ((leaf1ndex - 1) // cumulativeProduct[dimension1ndex - 1]) % arrayDimensions[dimension1ndex - 1] + 1 )
+
+    connectionGraph = numpy.zeros((dimensionsTotal + 1, leavesTotal + 1, leavesTotal + 1), dtype=datatype)
+    for dimension1ndex in range(1, dimensionsTotal + 1):
+        for activeLeaf1ndex in range(1, leavesTotal + 1):
+            for connectee1ndex in range(1, activeLeaf1ndex + 1):
+                isFirstCoord = coordinateSystem[dimension1ndex, connectee1ndex] == 1
+                isLastCoord = coordinateSystem[dimension1ndex, connectee1ndex] == arrayDimensions[dimension1ndex - 1]
+                exceedsActive = connectee1ndex + cumulativeProduct[dimension1ndex - 1] > activeLeaf1ndex
+                isEvenParity = (coordinateSystem[dimension1ndex, activeLeaf1ndex] & 1) == (coordinateSystem[dimension1ndex, connectee1ndex] & 1)
+
+                if (isEvenParity and isFirstCoord) or (not isEvenParity and (isLastCoord or exceedsActive)):
+                    connectionGraph[dimension1ndex, activeLeaf1ndex, connectee1ndex] = connectee1ndex
+                elif isEvenParity and not isFirstCoord:
+                    connectionGraph[dimension1ndex, activeLeaf1ndex, connectee1ndex] = connectee1ndex - cumulativeProduct[dimension1ndex - 1]
+                elif not isEvenParity and not (isLastCoord or exceedsActive):
+                    connectionGraph[dimension1ndex, activeLeaf1ndex, connectee1ndex] = connectee1ndex + cumulativeProduct[dimension1ndex - 1]
+                else:
+                    connectionGraph[dimension1ndex, activeLeaf1ndex, connectee1ndex] = connectee1ndex
+    return connectionGraph
+
+def makeDataContainer(shape, datatype: Optional[Type] = None):
+    if datatype is None:
+        datatype = dtypeDefault
+    return numpy.zeros(shape, dtype=datatype)
+
+def outfitFoldings(listDimensions: Sequence[int], computationDivisions: Optional[Union[int, str]] = None, CPUlimit: Optional[Union[bool, float, int]] = None, **keywordArguments: Optional[Type]) -> computationState:
+    datatypeDefault = keywordArguments.get('datatypeDefault', dtypeDefault)
+    datatypeLarge = keywordArguments.get('datatypeLarge', dtypeLarge)
+
+    the = makeDataContainer(len(indexThe), datatypeDefault)
+
+    mapShape = tuple(sorted(validateListDimensions(listDimensions)))
+    the[indexThe.leavesTotal] = getLeavesTotal(mapShape)
+    the[indexThe.dimensionsTotal] = len(mapShape)
+    concurrencyLimit = setCPUlimit(CPUlimit)
+    the[indexThe.taskDivisions] = getTaskDivisions(computationDivisions, concurrencyLimit, CPUlimit, listDimensions)
+
+    stateInitialized = computationState(
+        connectionGraph = makeConnectionGraph(mapShape, datatype=datatypeDefault),
+        foldsSubTotals = makeDataContainer(the[indexThe.leavesTotal], datatypeLarge),
+        mapShape = mapShape,
+        my = makeDataContainer(len(indexMy), datatypeLarge),
+        gapsWhere = makeDataContainer(int(the[indexThe.leavesTotal]) * int(the[indexThe.leavesTotal]) + 1, datatypeDefault),
+        the = the,
+        track = makeDataContainer((len(indexTrack), the[indexThe.leavesTotal] + 1), datatypeLarge)
+        )
+
+    stateInitialized['my'][indexMy.leaf1ndex] = 1
+    return stateInitialized
+
+def parseDimensions(dimensions: Sequence[int], parameterName: str = 'unnamed parameter') -> List[int]:
+    # listValidated = intInnit(dimensions, parameterName)
+    listNOTValidated = dimensions if isinstance(dimensions, (list, tuple)) else list(dimensions)
+    listNonNegative = []
+    for dimension in listNOTValidated:
+        if dimension < 0:
+            raise ValueError(f"Dimension {dimension} must be non-negative")
+        listNonNegative.append(dimension)
+    if not listNonNegative:
+        raise ValueError("At least one dimension must be non-negative")
+    return listNonNegative
+
+def setCPUlimit(CPUlimit: Union[bool, float, int, None]) -> int:
+    # if not (CPUlimit is None or isinstance(CPUlimit, (bool, int, float))):
+    #     CPUlimit = oopsieKwargsie(CPUlimit)
+    # concurrencyLimit = defineConcurrencyLimit(CPUlimit)
+    # numba.set_num_threads(concurrencyLimit)
+    concurrencyLimitHARDCODED = 1
+    concurrencyLimit = concurrencyLimitHARDCODED
+    return concurrencyLimit
+
+def validateListDimensions(listDimensions: Sequence[int]) -> List[int]:
+    if not listDimensions:
+        raise ValueError(f"listDimensions is a required parameter.")
+    listNonNegative = parseDimensions(listDimensions, 'listDimensions')
+    dimensionsValid = [dimension for dimension in listNonNegative if dimension > 0]
+    if len(dimensionsValid) < 2:
+        raise NotImplementedError(f"This function requires listDimensions, {listDimensions}, to have at least two dimensions greater than 0. You may want to look at https://oeis.org/.")
+    return sorted(dimensionsValid)

mapFolding/startHere.py

@@ -1,4 +1,4 @@
-from mapFolding import outfitFoldings
+from mapFolding import outfitCountFolds, getFilenameFoldsTotal
 from typing import Optional, Sequence, Type, Union
 import os
 import pathlib
@@ -15,7 +15,7 @@ def countFolds(listDimensions: Sequence[int], writeFoldsTotal: Optional[Union[st
         CPUlimit (None): This is only relevant if there are `computationDivisions`: whether and how to limit the CPU usage. See notes for details.
         **keywordArguments: Additional arguments including `dtypeDefault` and `dtypeLarge` for data type specifications.
     Returns:
-        foldsTotal: Total number of distinct ways to fold a map of the given dimensions.
+        foldsSubTotals: Total number of distinct ways to fold a map of the given dimensions.
 
     Computation divisions:
         - None: no division of the computation into tasks; sets task divisions to 0
@@ -34,20 +34,20 @@ def countFolds(listDimensions: Sequence[int], writeFoldsTotal: Optional[Union[st
     N.B.: You probably don't want to divide the computation into tasks.
         If you want to compute a large `foldsTotal`, dividing the computation into tasks is usually a bad idea. Dividing the algorithm into tasks is inherently inefficient: efficient division into tasks means there would be no overlap in the work performed by each task. When dividing this algorithm, the amount of overlap is between 50% and 90% by all tasks: at least 50% of the work done by every task must be done by _all_ tasks. If you improve the computation time, it will only change by -10 to -50% depending on (at the very least) the ratio of the map dimensions and the number of leaves. If an undivided computation would take 10 hours on your computer, for example, the computation will still take at least 5 hours but you might reduce the time to 9 hours. Most of the time, however, you will increase the computation time. If logicalCores >= leavesTotal, it will probably be faster. If logicalCores <= 2 * leavesTotal, it will almost certainly be slower for all map dimensions.
     """
-    stateUniversal = outfitFoldings(listDimensions, computationDivisions=computationDivisions, CPUlimit=CPUlimit, **keywordArguments)
+    stateUniversal = outfitCountFolds(listDimensions, computationDivisions=computationDivisions, CPUlimit=CPUlimit, **keywordArguments)
 
     pathFilenameFoldsTotal = None
     if writeFoldsTotal is not None:
         pathFilenameFoldsTotal = pathlib.Path(writeFoldsTotal)
         if pathFilenameFoldsTotal.is_dir():
-            filenameFoldsTotalDEFAULT = str(sorted(stateUniversal['mapShape'])).replace(' ', '') + '.foldsTotal'
+            filenameFoldsTotalDEFAULT = getFilenameFoldsTotal(stateUniversal['mapShape'])
             pathFilenameFoldsTotal = pathFilenameFoldsTotal / filenameFoldsTotalDEFAULT
         pathFilenameFoldsTotal.parent.mkdir(parents=True, exist_ok=True)
 
-    # NOTE Don't import a module with a numba.jit function until you want the function to compile and to freeze all settings for that function.
     from mapFolding.babbage import _countFolds
-    foldsTotal = _countFolds(**stateUniversal)
-    # foldsTotal = benchmarkSherpa(**stateUniversal)
+    _countFolds(**stateUniversal)
+
+    foldsTotal = stateUniversal['foldsSubTotals'].sum().item()
 
     if pathFilenameFoldsTotal is not None:
         try:
@@ -57,12 +57,3 @@ def countFolds(listDimensions: Sequence[int], writeFoldsTotal: Optional[Union[st
             print(f"\nfoldsTotal foldsTotal foldsTotal foldsTotal foldsTotal\n\n{foldsTotal=}\n\nfoldsTotal foldsTotal foldsTotal foldsTotal foldsTotal")
 
     return foldsTotal
-
-# from numpy import integer
-# from numpy.typing import NDArray
-# from typing import Any, Tuple
-# from mapFolding.benchmarks.benchmarking import recordBenchmarks
-# @recordBenchmarks()
-# def benchmarkSherpa(connectionGraph: NDArray[integer[Any]], foldsTotal: NDArray[integer[Any]], mapShape: Tuple[int, ...], my: NDArray[integer[Any]], gapsWhere: NDArray[integer[Any]], the: NDArray[integer[Any]], track: NDArray[integer[Any]]):
-#     from mapFolding.babbage import _countFolds
-#     return _countFolds(connectionGraph, foldsTotal, mapShape, my, gapsWhere, the, track)

mapFolding/theSSOT.py

@@ -5,9 +5,17 @@ import numpy.typing
 import pathlib
 import sys
 
-dtypeLarge = numpy.int64
-dtypeDefault = dtypeLarge
-dtypeSmall = dtypeDefault
+datatypeModule = 'numpy'
+
+datatypeLarge = 'int64'
+datatypeDefault = datatypeLarge
+datatypeSmall = datatypeDefault
+
+make_dtype = lambda _datatype: eval(f"{datatypeModule}.{_datatype}")
+
+dtypeLarge = make_dtype(datatypeLarge)
+dtypeDefault = make_dtype(datatypeDefault)
+dtypeSmall = make_dtype(datatypeSmall)
 
 try:
     _pathModule = pathlib.Path(__file__).parent
@@ -15,7 +23,7 @@ except NameError:
     _pathModule = pathlib.Path.cwd()
 
 pathJobDEFAULT = _pathModule / "jobs"
-"""filenameFoldsTotal = str(sorted(mapShape)).replace(' ', '') + '.foldsTotal'"""
+
 if 'google.colab' in sys.modules:
     pathJobDEFAULT = pathlib.Path("/content/drive/MyDrive") / "jobs"
 
@@ -59,9 +67,9 @@ class indexTrack(EnumIndices):
 
 class computationState(TypedDict):
     connectionGraph: numpy.typing.NDArray[numpy.integer[Any]]
-    foldsTotal: numpy.ndarray[numpy.int64, numpy.dtype[numpy.int64]]
+    foldsSubTotals: numpy.typing.NDArray[numpy.integer[Any]]
+    gapsWhere: numpy.typing.NDArray[numpy.integer[Any]]
     mapShape: Tuple[int, ...]
     my: numpy.typing.NDArray[numpy.integer[Any]]
-    gapsWhere: numpy.typing.NDArray[numpy.integer[Any]]
     the: numpy.typing.NDArray[numpy.integer[Any]]
     track: numpy.typing.NDArray[numpy.integer[Any]]

{mapFolding-0.2.2.dist-info → mapFolding-0.2.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: mapFolding
-Version: 0.2.2
+Version: 0.2.4
 Summary: Algorithm(s) for counting distinct ways to fold a map (or a strip of stamps)
 Author-email: Hunter Hogan <HunterHogan@pm.me>
 Project-URL: homepage, https://github.com/hunterhogan/mapFolding
@@ -22,10 +22,12 @@ Requires-Dist: pytest; extra == "testing"
 Requires-Dist: pytest-cov; extra == "testing"
 Requires-Dist: pytest-env; extra == "testing"
 Requires-Dist: pytest-xdist; extra == "testing"
+Requires-Dist: pytest-order; extra == "testing"
+Requires-Dist: pytest-dependency; extra == "testing"
 
 # Algorithm(s) for counting distinct ways to fold a map (or a strip of stamps)
 
-`mapFolding.countFolds()` will accept arbitrary values for the map's dimensions.
+The function `mapFolding.countFolds()` counts distinct ways to fold maps and strips of stamps. The function accepts two or more dimensions:
 
 ```python
 from mapFolding import countFolds
@@ -34,12 +36,12 @@ foldsTotal = countFolds( [2,10] )
 
 The directory [mapFolding/reference](https://github.com/hunterhogan/mapFolding/blob/main/mapFolding/reference) has
 
-- a verbatim transcription of the "procedure" published in _The Computer Journal_,
+- a verbatim transcription of Lunnon's "procedure" published in 1971 by _The Computer Journal_,
 - multiple referential versions of the procedure with explanatory comments including
 - [hunterNumba.py](https://github.com/hunterhogan/mapFolding/blob/main/mapFolding/reference), a one-size-fits-all, self-contained, reasonably fast, contemporary algorithm that is nevertheless infected by _noobaceae ignorancium_, and
 - miscellaneous notes.
 
-[![Python Tests](https://github.com/hunterhogan/mapFolding/actions/workflows/unittests.yml/badge.svg)](https://github.com/hunterhogan/mapFolding/actions/workflows/unittests.yml)
+[![Python Tests](https://github.com/hunterhogan/mapFolding/actions/workflows/unittests.yml/badge.svg)](https://github.com/hunterhogan/mapFolding/actions/workflows/unittests.yml) [![pip install mapFolding](https://img.shields.io/badge/pip%20install-mapFolding-gray.svg?colorB=3b434b)](https://pypi.org/project/mapFolding/) ![Static Badge](https://img.shields.io/badge/stinkin'%20badges-don't%20need-b98e5e) ![PyPI - Downloads](https://img.shields.io/pypi/dd/mapFolding) ![Static Badge](https://img.shields.io/badge/issues-I%20have%20them-brightgreen) ![GitHub repo size](https://img.shields.io/github/repo-size/hunterhogan/mapFolding)
 
 ## Simple, easy usage based on OEIS IDs
 

mapFolding-0.2.4.dist-info/RECORD

@@ -0,0 +1,35 @@
+mapFolding/__init__.py,sha256=wnf2EzHR2unVha6-Y0gRoSPaE4PDdT4VngINa_dfT2E,337
+mapFolding/babbage.py,sha256=51fO7lwcTsTvSMwzKW1G2nGslGoEQt19IgnqZi8znao,2222
+mapFolding/beDRY.py,sha256=XawGabR1vhzOfdA46HSXmisA5EmxisTKdA3D98KDeac,13699
+mapFolding/countInitialize.py,sha256=pIeH52OwDMfuHXT2T4BbPmMm6r7zJnGc-e0QVQCKyDc,1824
+mapFolding/countParallel.py,sha256=1sLGIlMj_xZ4bFkG1srOPcDUCrSKc1q3x2QN_8l_sgY,2451
+mapFolding/countSequential.py,sha256=QSXwK3o8YBcxNrir_wGMXgqp38hXYTJanYXFLxUPCPo,1993
+mapFolding/importSelector.py,sha256=OY_LuUrLW5SFV6qM1tSgI2Rnfi5Bj3Fhdrkryo0WycE,392
+mapFolding/inlineAfunction.py,sha256=KO2snTNSGX-4urRtTOYqAZBCsBCaMfr5bo6rNZR9MPA,5102
+mapFolding/lovelace.py,sha256=iu7anbA_TacIAjc4EKkeBVxIJKAMdrYgvR4evzMZ1WY,15193
+mapFolding/oeis.py,sha256=_-fLGc1ybZ2eFxoiBrSmojMexeg6ROxtrLaBF2BzMn4,12144
+mapFolding/startHere.py,sha256=or7QhxgMls2hvP_I2eTBP5tffLrc3SMiE5Gz_Ik2aJY,4328
+mapFolding/theSSOT.py,sha256=3Zty4rYWOqrwivuCaKA71R0HM4rjmvtkL_Bsn4ZhwFo,2318
+mapFolding/JAX/lunnanJAX.py,sha256=xMZloN47q-MVfjdYOM1hi9qR4OnLq7qALmGLMraevQs,14819
+mapFolding/JAX/taskJAX.py,sha256=yJNeH0rL6EhJ6ppnATHF0Zf81CDMC10bnPnimVxE1hc,20037
+mapFolding/benchmarks/benchmarking.py,sha256=HD_0NSvuabblg94ftDre6LFnXShTe8MYj3hIodW-zV0,3076
+mapFolding/reference/flattened.py,sha256=X9nvRzg7YDcpCtSDTL4YiidjshlX9rg2e6JVCY6i2u0,16547
+mapFolding/reference/hunterNumba.py,sha256=0giUyqAFzP-XKcq3Kz8wIWCK0BVFhjABVJ1s-w4Jhu0,7109
+mapFolding/reference/irvineJavaPort.py,sha256=Sj-63Z-OsGuDoEBXuxyjRrNmmyl0d7Yz_XuY7I47Oyg,4250
+mapFolding/reference/lunnan.py,sha256=XEcql_gxvCCghb6Or3qwmPbn4IZUbZTaSmw_fUjRxZE,5037
+mapFolding/reference/lunnanNumpy.py,sha256=HqDgSwTOZA-G0oophOEfc4zs25Mv4yw2aoF1v8miOLk,4653
+mapFolding/reference/lunnanWhile.py,sha256=7NY2IKO5XBgol0aWWF_Fi-7oTL9pvu_z6lB0TF1uVHk,4063
+mapFolding/reference/rotatedEntryPoint.py,sha256=z0QyDQtnMvXNj5ntWzzJUQUMFm1-xHGLVhtYzwmczUI,11530
+mapFolding/reference/total_countPlus1vsPlusN.py,sha256=usenM8Yn_G1dqlPl7NKKkcnbohBZVZBXTQRm2S3_EDA,8106
+tests/__init__.py,sha256=eg9smg-6VblOr0kisM40CpGnuDtU2JgEEWGDTFVOlW8,57
+tests/conftest.py,sha256=AWB3m_jxMlkmOmGvk2ApJEk2ro5v8gmmJDcyLwN1oow,13761
+tests/pythons_idiotic_namespace.py,sha256=oOLDBergQqqhGuRpsXUnFD-R_6AlJipNKYHw-kk_OKw,33
+tests/test_oeis.py,sha256=vxnwO-cSR68htkyMh9QMVv-lvxBo6qlwPg1Rbx4JylY,7963
+tests/test_other.py,sha256=amhsy7VWzpuW_slBOTFPhC7e4o4k6Yp4xweNK1VHZnc,11906
+tests/test_tasks.py,sha256=Nwe4iuSjwGZvsw5CXCcic7tkBxgM5JX9mrGZMDYhAwE,1785
+tests/test_temporary.py,sha256=4FIEc9KGRpNsgU_eh8mXG49PSPqo8WLeZEyFI4Dpy3U,1127
+mapFolding-0.2.4.dist-info/METADATA,sha256=w1OgxNLylmuYfEKUsSIChm_8jLtjV63_OB04n8Btjm8,6543
+mapFolding-0.2.4.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+mapFolding-0.2.4.dist-info/entry_points.txt,sha256=F3OUeZR1XDTpoH7k3wXuRb3KF_kXTTeYhu5AGK1SiOQ,146
+mapFolding-0.2.4.dist-info/top_level.txt,sha256=1gP2vFaqPwHujGwb3UjtMlLEGN-943VSYFR7V4gDqW8,17
+mapFolding-0.2.4.dist-info/RECORD,,

tests/__init__.py

@@ -1 +1 @@
-from .conftest import makeDictionaryFoldsTotalKnown
+from tests.conftest import makeDictionaryFoldsTotalKnown

tests/conftest.py

@@ -14,10 +14,10 @@ from Z0Z_tools.pytest_parseParameters import makeTestSuiteConcurrencyLimit
 from Z0Z_tools.pytest_parseParameters import makeTestSuiteIntInnit
 from Z0Z_tools.pytest_parseParameters import makeTestSuiteOopsieKwargsie
 from mapFolding import countFolds, pathJobDEFAULT, indexMy, indexThe, indexTrack
-from mapFolding import defineConcurrencyLimit, intInnit, oopsieKwargsie
-from mapFolding import getLeavesTotal, parseDimensions, validateListDimensions
-from mapFolding import getTaskDivisions, makeConnectionGraph, outfitFoldings, setCPUlimit
-from mapFolding import oeisIDfor_n, getOEISids, clearOEIScache
+from mapFolding import defineConcurrencyLimit, intInnit, oopsieKwargsie, outfitCountFolds
+from mapFolding import oeisIDfor_n, getOEISids, clearOEIScache, getFilenameFoldsTotal
+from mapFolding.beDRY import getLeavesTotal, parseDimensions, validateListDimensions
+from mapFolding.beDRY import getTaskDivisions, makeConnectionGraph, setCPUlimit
 from mapFolding.beDRY import makeDataContainer
 from mapFolding.oeis import OEIS_for_n
 from mapFolding.oeis import _getFilenameOEISbFile
@@ -37,10 +37,11 @@ __all__ = [
     'countFolds',
     'defineConcurrencyLimit',
     'expectSystemExit',
+    'getFilenameFoldsTotal',
     'getLeavesTotal',
     'getOEISids',
-    'indexThe',
     'getTaskDivisions',
+    'indexThe',
     'intInnit',
     'makeConnectionGraph',
     'makeDataContainer',
@@ -50,7 +51,7 @@ __all__ = [
     'oeisIDfor_n',
     'oeisIDsImplemented',
     'oopsieKwargsie',
-    'outfitFoldings',
+    'outfitCountFolds',
     'parseDimensions',
     'setCPUlimit',
     'settingsOEIS',
@@ -133,6 +134,14 @@ def setupTeardownTestData() -> Generator[None, None, None]:
     yield
     cleanupTempFileRegister()
 
+@pytest.fixture(autouse=True)
+def setupWarningsAsErrors():
+    """Convert all warnings to errors for all tests."""
+    import warnings
+    warnings.filterwarnings("error")
+    yield
+    warnings.resetwarnings()
+
 @pytest.fixture
 def pathTempTesting(request: pytest.FixtureRequest) -> pathlib.Path:
     """Create a unique temp directory for each test function."""
@@ -227,6 +236,22 @@ def oeisID_1random() -> str:
     """Return one random valid OEIS ID."""
     return random.choice(oeisIDsImplemented)
 
+@pytest.fixture
+def mockFoldingFunction():
+    """Creates a mock function that simulates _countFolds behavior."""
+    def make_mock(foldsValue: int, listDimensions: List[int]):
+        arraySize = getLeavesTotal(listDimensions)
+        # The array needs to sum to our target value
+        mock_array = makeDataContainer(arraySize)
+        mock_array[arraySize - 1] = foldsValue  # Put entire value in last position
+
+        def mock_countfolds(**keywordArguments):
+            keywordArguments['foldsSubTotals'][:] = mock_array
+            return None
+
+        return mock_countfolds
+    return make_mock
+
 """
 Section: Standardized test structures"""
 

tests/pythons_idiotic_namespace.py

@@ -0,0 +1 @@
+from mapFolding.theSSOT import *