pd-code-components 0.1.0__tar.gz → 0.1.1__tar.gz

pd_code_components-0.1.1/PKG-INFO

@@ -0,0 +1,63 @@
+Metadata-Version: 2.4
+Name: pd-code-components
+Version: 0.1.1
+Summary: get all components from a link pd code.
+License: MIT
+License-File: LICENSE
+Author: GGN_2015
+Author-email: premierbob@qq.com
+Requires-Python: >=3.10
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Description-Content-Type: text/markdown
+
+# pd-code-components
+
+Find the components represented by a planar-diagram code.
+
+## Installation
+
+```bash
+pip install pd-code-components
+```
+
+## Usage example
+
+```python
+from pd_code_components import get_components_from_pd_code
+
+hopf = [[2, 3, 1, 4], [4, 1, 3, 2]]
+print(get_components_from_pd_code(hopf))
+# [[1, 2], [3, 4]]
+```
+
+## Algorithm
+
+At each crossing, slots `0` and `2` belong to one strand and slots `1` and `3` to the other. These opposite-slot pairs form an undirected graph on arc labels. Iterative depth-first traversal finds connected components in `O(V + E)` time. Sets are used for adjacency and visitation, avoiding the quadratic membership checks in the original list-based implementation.
+
+## Input conventions
+
+A PD code is represented as a list of four-entry crossings. Arc labels normally occur exactly twice. Public functions validate inputs and return new values rather than mutating caller-owned data unless their API explicitly says otherwise.
+
+## External software
+
+No external software is required.
+
+## Development
+
+Run examples and package checks before release. Python packages require Python 3.10 or newer. Build PyPI artifacts with:
+
+```bash
+poetry check
+poetry build
+```
+
+## License
+
+MIT. See `LICENSE`.
+

pd_code_components-0.1.1/README.md

@@ -0,0 +1,44 @@
+# pd-code-components
+
+Find the components represented by a planar-diagram code.
+
+## Installation
+
+```bash
+pip install pd-code-components
+```
+
+## Usage example
+
+```python
+from pd_code_components import get_components_from_pd_code
+
+hopf = [[2, 3, 1, 4], [4, 1, 3, 2]]
+print(get_components_from_pd_code(hopf))
+# [[1, 2], [3, 4]]
+```
+
+## Algorithm
+
+At each crossing, slots `0` and `2` belong to one strand and slots `1` and `3` to the other. These opposite-slot pairs form an undirected graph on arc labels. Iterative depth-first traversal finds connected components in `O(V + E)` time. Sets are used for adjacency and visitation, avoiding the quadratic membership checks in the original list-based implementation.
+
+## Input conventions
+
+A PD code is represented as a list of four-entry crossings. Arc labels normally occur exactly twice. Public functions validate inputs and return new values rather than mutating caller-owned data unless their API explicitly says otherwise.
+
+## External software
+
+No external software is required.
+
+## Development
+
+Run examples and package checks before release. Python packages require Python 3.10 or newer. Build PyPI artifacts with:
+
+```bash
+poetry check
+poetry build
+```
+
+## License
+
+MIT. See `LICENSE`.

{pd_code_components-0.1.0 → pd_code_components-0.1.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pd-code-components"
-version = "0.1.0"
+version = "0.1.1"
 description = "get all components from a link pd code."
 authors = [
     {name = "GGN_2015",email = "premierbob@qq.com"}

pd_code_components-0.1.0/PKG-INFO

@@ -1,42 +0,0 @@
-Metadata-Version: 2.4
-Name: pd-code-components
-Version: 0.1.0
-Summary: get all components from a link pd code.
-License: MIT
-License-File: LICENSE
-Author: GGN_2015
-Author-email: premierbob@qq.com
-Requires-Python: >=3.10
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: Python :: 3.14
-Description-Content-Type: text/markdown
-
-# pd-code-components
-
-Find link components in a planar-diagram code.
-
-## Installation
-
-```bash
-pip install pd-code-components
-```
-
-## Quick start
-
-`from pd_code_components import get_components_from_pd_code`.
-
-PD codes are lists of four-entry crossings. Each arc label must occur exactly twice. Functions validate their inputs and do not mutate caller-owned PD-code lists unless explicitly documented.
-
-## Development
-
-Use Python 3.10 or newer for Python packages. Build distributions with `poetry build`. Run the package's tests or examples before publishing. C++ projects require a modern standards-compliant compiler.
-
-## License
-
-MIT. See `LICENSE`.
-

pd_code_components-0.1.0/README.md

@@ -1,23 +0,0 @@
-# pd-code-components
-
-Find link components in a planar-diagram code.
-
-## Installation
-
-```bash
-pip install pd-code-components
-```
-
-## Quick start
-
-`from pd_code_components import get_components_from_pd_code`.
-
-PD codes are lists of four-entry crossings. Each arc label must occur exactly twice. Functions validate their inputs and do not mutate caller-owned PD-code lists unless explicitly documented.
-
-## Development
-
-Use Python 3.10 or newer for Python packages. Build distributions with `poetry build`. Run the package's tests or examples before publishing. C++ projects require a modern standards-compliant compiler.
-
-## License
-
-MIT. See `LICENSE`.