feat: CF conventions and logo (#42)

* feat: add ragged.io submodule with conversions for CF conventions

* fixed pre-commit errors

* docs: add logo

src/ragged/_spec_array_object.py

@@ -1236,6 +1236,8 @@ def _unbox(*inputs: array) -> tuple[ak.Array | SupportsDLPack, ...]:
         msg = f"mixed array types: {types}"
         raise TypeError(msg)
 
+    # FIXME: either complain about mixed devices or cast to a common device
+
     return tuple(x._impl for x in inputs)  # pylint: disable=W0212
 
 

src/ragged/io/__init__.py

@@ -0,0 +1,7 @@
+# BSD 3-Clause License; see https://github.com/scikit-hep/ragged/blob/main/LICENSE
+
+from __future__ import annotations
+
+from .cf import from_cf_contiguous, from_cf_indexed, to_cf_contiguous, to_cf_indexed
+
+__all__ = ["to_cf_contiguous", "from_cf_contiguous", "to_cf_indexed", "from_cf_indexed"]

src/ragged/io/cf.py

@@ -0,0 +1,54 @@
+# BSD 3-Clause License; see https://github.com/scikit-hep/ragged/blob/main/LICENSE
+
+from __future__ import annotations
+
+import awkward as ak
+
+from .._import import device_namespace
+from .._spec_array_object import _box, _unbox, array
+
+
+def to_cf_contiguous(x: array) -> tuple[array, array]:
+    if x.ndim != 2:
+        raise NotImplementedError
+
+    (y,) = _unbox(x)
+
+    return _box(type(x), ak.flatten(y)), _box(type(x), ak.num(y))
+
+
+def from_cf_contiguous(content: array, counts: array) -> array:
+    if content.ndim != 1 or counts.ndim != 1:
+        raise NotImplementedError
+
+    cont, cnts = _unbox(content, counts)
+
+    return _box(type(content), ak.unflatten(cont, cnts))
+
+
+def to_cf_indexed(x: array) -> tuple[array, array]:
+    if x.ndim != 2:
+        raise NotImplementedError
+
+    _, ns = device_namespace(x.device)
+    (y,) = _unbox(x)
+
+    index, _ = ak.broadcast_arrays(ns.arange(len(x), dtype=ns.int64), y)
+
+    return _box(type(x), ak.flatten(y)), _box(type(x), ak.flatten(index))
+
+
+def from_cf_indexed(content: array, index: array) -> array:
+    if content.ndim != 1 or index.ndim != 1:
+        raise NotImplementedError
+
+    _, ns = device_namespace(content.device)
+    cont, ind = _unbox(content, index)
+
+    counts = ns.zeros(ak.max(ind) + 1, dtype=ns.int64)
+    ns.add.at(counts, ns.asarray(ind), 1)
+
+    return _box(type(content), ak.unflatten(cont[ns.argsort(ind)], counts))  # type: ignore[index]
+
+
+__all__ = ["to_cf_contiguous", "from_cf_contiguous", "to_cf_indexed", "from_cf_indexed"]