xobjects 0.7.0__tar.gz → 0.7.2__tar.gz

{xobjects-0.7.0/xobjects.egg-info → xobjects-0.7.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xobjects
-Version: 0.7.0
+Version: 0.7.2
 Summary: In-memory serialization and code generator for CPU and GPU
 Home-page: https://xsuite.readthedocs.io/
 Download-URL: https://pypi.python.org/pypi/xobjects
@@ -17,6 +17,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: numpy
 Requires-Dist: cffi
+Requires-Dist: setuptools
 Requires-Dist: scipy
 Provides-Extra: tests
 Requires-Dist: pytest; extra == "tests"

{xobjects-0.7.0 → xobjects-0.7.2}/pyproject.toml

@@ -17,6 +17,7 @@ requires-python = ">=3.9"
 dependencies = [
     "numpy",
     "cffi",
+    "setuptools",
     "scipy"
 ]
 [project.urls]

{xobjects-0.7.0 → xobjects-0.7.2}/setup.py

@@ -23,7 +23,7 @@ setup(
     url="https://xsuite.readthedocs.io/",
     python_requires=">=3.7",
     setup_requires=[],
-    install_requires=["numpy", "cffi", "scipy"],
+    install_requires=["numpy", "cffi", "setuptools", "scipy"],
     packages=["xobjects"],
     license="Apache 2.0",
     download_url="https://pypi.python.org/pypi/xobjects",

{xobjects-0.7.0 → xobjects-0.7.2}/tests/test_hybrid_class.py

@@ -332,6 +332,28 @@ def test_to_json_defaults():
     assert b_dict == {}
 
 
+def test_to_dict_scalar_raw_union_defaults():
+    class ScalarUnion(xo.RawUnion):
+        scalar = xo.Float64
+        bits = xo.UInt64
+
+        @classmethod
+        def _from_buffer(cls, buffer, offset=0, container=None):
+            return xo.Float64._from_buffer(buffer, offset)
+
+    class A(xo.HybridClass):
+        _xofields = {
+            "a": ScalarUnion,
+            "b": xo.Field(ScalarUnion, default=2.5),
+            "c": xo.Field(ScalarUnion, default_factory=lambda: 3.5),
+        }
+
+    assert A().to_dict() == {"__class__": "A"}
+    values = {"__class__": "A", "a": 1.5, "b": 0.0, "c": 0.0}
+    for copy_to_cpu in (True, False):
+        assert A.from_dict(values).to_dict(copy_to_cpu=copy_to_cpu) == values
+
+
 def test_to_dict_python_vars():
     class TD(xo.HybridClass):
         _xofields = {

{xobjects-0.7.0 → xobjects-0.7.2}/tests/test_kernel.py

@@ -4,6 +4,7 @@
 # ########################################### #
 
 import cffi
+import pickle
 import pytest
 import sysconfig
 from pathlib import Path
@@ -14,7 +15,8 @@ import xobjects as xo
 from xobjects.test_helpers import for_all_test_contexts, requires_context
 
 
-def test_kernel_cpu():
+@pytest.mark.parametrize('pickle_context', [False, True])
+def test_kernel_cpu(pickle_context):
     ctx = xo.ContextCpu()
     src_code = r"""
 double my_mul(const int n, const double* x1,
@@ -45,6 +47,13 @@ double my_mul(const int n, const double* x1,
 
     assert y == 285.0
 
+    if pickle_context:
+        restored = pickle.loads(pickle.dumps(ctx))
+        assert not restored.kernels
+        assert ctx.kernels.my_mul(n=len(a1), x1=a1, x2=a2) == 285.0
+        restored.add_kernels(sources=[src_code], kernels=kernel_descriptions)
+        assert restored.kernels.my_mul(n=len(a1), x1=a1, x2=a2) == 285.0
+
 
 @for_all_test_contexts
 def test_kernel_pointer_none_maps_to_null(test_context):

xobjects-0.7.2/xobjects/_version.py

@@ -0,0 +1 @@
+__version__ = "0.7.2"

{xobjects-0.7.0 → xobjects-0.7.2}/xobjects/context_cpu.py

@@ -96,6 +96,7 @@ def kernel_compilation_help_message():
 
 from .context import (
     Kernel,
+    KernelDict,
     ModuleNotAvailable,
     SourceType,
     XBuffer,
@@ -821,6 +822,7 @@ class ContextCpu(XContext):
 
     def __setstate__(self, state):
         self.__dict__.update(state)
+        self._kernels = KernelDict(self._kernels)
         self._buffers = weakref.WeakSet()
 
 

{xobjects-0.7.0 → xobjects-0.7.2}/xobjects/hybrid_class.py

@@ -10,6 +10,7 @@ import numpy as np
 from .struct import Struct
 from .typeutils import context_default
 from .ref import Ref
+from .raw_union import RawUnion
 
 
 class _FieldOfDressed:
@@ -297,7 +298,12 @@ class HybridClass(metaclass=MetaHybridClass):
                 defaults[field.name] = dft
                 continue
             try:
-                defaults[field.name] = field.get_default()
+                default = field.get_default()
+                if isinstance(default, RawUnion):
+                    # A raw union can expose a scalar when read as a field.
+                    default = type(default)._from_buffer(
+                        default._buffer, default._offset)
+                defaults[field.name] = default
             except (TypeError, ValueError):
                 # The above can fail with different error types
                 # if a field type is dynamic.

{xobjects-0.7.0 → xobjects-0.7.2/xobjects.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xobjects
-Version: 0.7.0
+Version: 0.7.2
 Summary: In-memory serialization and code generator for CPU and GPU
 Home-page: https://xsuite.readthedocs.io/
 Download-URL: https://pypi.python.org/pypi/xobjects
@@ -17,6 +17,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: numpy
 Requires-Dist: cffi
+Requires-Dist: setuptools
 Requires-Dist: scipy
 Provides-Extra: tests
 Requires-Dist: pytest; extra == "tests"

{xobjects-0.7.0 → xobjects-0.7.2}/xobjects.egg-info/SOURCES.txt

@@ -1,49 +1,10 @@
-.gitignore
-.pre-commit-config.yaml
-.readthedocs.yaml
 Architecture.md
 LICENSE
 MANIFEST.in
 README.md
-contributors_and_credits.txt
-mktest
 pyproject.toml
-release.sh
-requirements.txt
 setup.cfg
 setup.py
-update_cprght_statement.py
-.github/workflows/black.yml
-docs/Makefile
-docs/architecture.rst
-docs/conf.py
-docs/index.rst
-docs/make.bat
-docs/quickstart.rst
-docs/reference.rst
-docs/architecture/contexts.rst
-docs/architecture/types.rst
-examples/api_def.py
-examples/api_init.py
-examples/capi_example.c
-examples/check_assembly.c
-examples/ex_array_init_perf.py
-examples/ex_cpugpu.py
-examples/ex_nested_ref.py
-examples/ex_ref_cpu.py
-examples/ex_struct_cpu.py
-examples/ex_unionref_cpu.py
-examples/ex_unionref_method.py
-examples/init_soa.py
-examples/issue_with_two_pyopencl_contexts.py
-examples/opencl_offsets.py
-examples/simple_kernel.py
-examples/sixtracklib.py
-examples/kernel_basics/kernel_cffi.py
-examples/kernel_basics/kernel_cupy.py
-examples/kernel_basics/kernel_pyopencl.py
-tests/__init__.py
-tests/notest_capi.py
 tests/test_align.py
 tests/test_array.py
 tests/test_buffer.py

{xobjects-0.7.0 → xobjects-0.7.2}/xobjects.egg-info/requires.txt

@@ -1,5 +1,6 @@
 numpy
 cffi
+setuptools
 scipy
 
 [tests]

xobjects-0.7.0/.github/workflows/black.yml

@@ -1,10 +0,0 @@
-name: Lint
-
-on: [push, pull_request]
-
-jobs:
-  lint:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: pre-commit/action@v3.0.1

xobjects-0.7.0/.gitignore

@@ -1,13 +0,0 @@
-__pycache__/
-*.pyc
-*.pyo
-*.swp
-*.egg-info/
-docs/_build
-cov_html
-.vscode
-.pytest_cache
-.coverage
-.idea
-*.c
-**/.DS_Store

xobjects-0.7.0/.pre-commit-config.yaml

@@ -1,12 +0,0 @@
-repos:
-  - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
-    hooks:
-    -   id: check-yaml
-    -   id: end-of-file-fixer
-    -   id: trailing-whitespace
-  - repo: https://github.com/psf/black-pre-commit-mirror
-    rev: 26.3.1
-    hooks:
-      - id: black
-        language_version: python3

xobjects-0.7.0/.readthedocs.yaml

@@ -1,20 +0,0 @@
-# .readthedocs.yaml
-# Read the Docs configuration file
-# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
-
-# Required
-version: 2
-
-# Build documentation in the docs/ directory with Sphinx
-sphinx:
-   configuration: docs/conf.py
-
-# Optionally build your docs in additional formats such as PDF
-formats:
-   - pdf
-
-# Optionally set the version of Python and requirements required to build your docs
-python:
-   version: 3.7
-#   install:
-#   - requirements: docs/requirements.txt

xobjects-0.7.0/contributors_and_credits.txt

@@ -1,7 +0,0 @@
-The following people contributed to the development of this package:
-
-CERN contributors:
- - R. De Maria
- - G. Iadarola
- - P. Kiksiny
- - S. Lopaciuk

xobjects-0.7.0/docs/Makefile

@@ -1,20 +0,0 @@
-# Minimal makefile for Sphinx documentation
-#
-
-# You can set these variables from the command line, and also
-# from the environment for the first two.
-SPHINXOPTS    ?=
-SPHINXBUILD   ?= sphinx-build
-SOURCEDIR     = .
-BUILDDIR      = _build
-
-# Put it first so that "make" without argument is like "make help".
-help:
-	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
-
-.PHONY: help Makefile
-
-# Catch-all target: route all unknown targets to Sphinx using the new
-# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
-%: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

xobjects-0.7.0/docs/architecture/contexts.rst

@@ -1,164 +0,0 @@
-Contexts
-========
-
-Devices
--------
-
-
-Buffers
--------
-
-Buffers are able to store data in the host or device from several object types and return data in device or host.
-
-
-Instance methods:
-
-*  write(self, source, offset, nbytes): write nbytes from source that can be a np-like array, bytearray, bytes or another buffer
-*  to_nplike(self,dtype,shape,offset): return a view of the data in a np-like arrays
-*  to_bytearray(self,offset,count): return
-
-.. code::
-
-   def update_from_xbuffer(self,offset, source, source_offset, nbytes):
-       "update from any xbuffer, don't pass through gpu if possible"
-
-   def update_from_buffer(self, offset, buffer):
-       """source is python buffer such as bytearray, numpy array .data"""
-
-   def copy_native(self,offset,nbytes):
-        """return native data with content at from offset and nbytes
-        return native_data
-
-   def update_from_native(self, offset, source, source_offset, nbytes):
-       """update native source into buffer usef in update_from_xbuffer"""
-
-   def to_nplike(self,offset,shape,dtype)
-       """view in nplike"""
-
-   def to_bytearray(self,offset,nbytes)
-       """copy in byte array: used in update_from_xbuffer"""
-
-   def to_pointer_arg(self,offset,nbytes):
-       return self.data[offset:offset+nbytes] #offset can lead to alignement error in opencl if not multiple of 4 bytes
-
-
-
-Arguments for kernels:
-
-- CPU:
-  - numpy array ->  ``ffi.cast("double *", ffi.from_buffer(arr))``
-  - numpy scalar -> no change
-  - s string -> ``ss.decode("utf8")``
-
-- PyOpenCL:
-  - pyopencl.Buffer: [offset:offset+nbytes] or copy back and fort if needs to be aligned
-  - pyopencl.array:  arr.base_data[arr.offset:arr.offset+arr.nbytes] or copy back and fort
-
-- cuda:
-    -  pycuda.array: arr or arr.data
-
-
-nparray.data:    python buffer pointing to start of the array arrays
-clarray.data:  Optional Opencl buffer pointing to the start of the array
-clarray.base_data,clarray.base_data:  Optional Opencl buffer  and offset from where the pointer start
-cupyaray.
-
-
-clarray.base_data[]:
-
-Code generation
----------------
-
-Each context is able to compile source code and make available python callable functions.
-
-The callable functions can take as arguments Python numbers, strings,
-numpy-like arrays (depending on the context) and xobject allocated in the same
-contexts (if not copies will be done).
-
-Source code is optionally pre-processed to adapt it to the context.
-
-The callable functions are defined by:
-*  the name of the function in the source code
-*  the type of parameters
-*  how to pass parallalization instruction (threads for openmp, grid for GPU)
-
-The callable functions are parametrized by name and argument types.
-
-Each xobject type can provide the API source code  the ``_get_c_api()`` class method.
-
-
-
-C Api
-^^^^^^^^^^^^^^^^^^^
-
-General:
-
-- ``<pointer type> <typename>_getp_<field_names>(<typename> obj, <indexes>)``
-- ``<scalar type>  <typename>_get_<field_names>(<typename> obj, <indexes>)``
-- ``<typename>_set_<field_names>(<typename> obj, <indexes>, <scalar_type> value)``
-- ``<int64> <typename>_size_<field_names>(<typename> obj,<indexes>)``
-
-Array:
-- ``<int64> <typename>_len...(<typename> obj) : number of itemns``
-- ``<int64> <typename>_dim...(<typename> obj, int index): size of dimension``
-- ``<int64> <typename>_ndim...(<typename> obj): number of dimensions``
-- ``void <typename>_strides(int* result)``
-
-UnionRef:
-- ``<int64> <typename>_typeid...(<typename> obj) : get member
-- ``void* <typename>_member...(int* result)``
-
-
-Kernels and Functions
-^^^^^^^^^^^^^^^^^^^^^
-
-Context can execute:
-
-- kernels: no return function and executed on a grid
-- functions: only for cpu kernels
-
-
-.. code:: python
-  Kernel(
-    cname,
-    args=Arg(dtype, name: String, const: Boolean)
-    grid=integer, string or list of string or functions of arguments
-    ret=None)
-
-
-Arg:
-
-* atype: argument type:
-  - provide validation function: cls._validate(value) or atype(value)
-  - provide C-type name: atype._get_ctype()  or dtype -> converted to c types,
-  - generate raw argument from value .atype._get_carg() for the interface
-* name: optional, String needed for the grid
-* const: boolean (used in case of copy back)
-
-Code:
-
-* define sources, list of string or files
-* define kernels to expose, list of kernels
-* define preprocessors
-* attach callable kernels to context
-* to be used by CMethod or CProperty
-
-.. code::
-    double x -> Arg(dtype=xo.Float64,name='x'): takes python scalar and np scalar
-    double *restrict x -> Arg(dtype=xo.Float64,pointer=True,const=False,name='x'): takes np.array, xo.Float64 arrays
-    const double *restrict x -> Arg(dtype=xo.Float64,pointer=True,const=True,name='x'): takes np.array, xo.Float64 arrays
-    const Float64_N -> Arg(dtype=xo.Float64[:],const=True,name='x'): takes xo.Float64[:]
-    const Float64_6by6 -> Arg(dtype=xo.Float64[6,6],const=True,name='x'): takes xo.Float64[6,6]
-
-
-
-
-
-*  function: general function
-*  method: implies first attribute is the instance of the class where it is defined
-*  kernel: implies some iteration and no return type
-
-The function can be defined using:
-*   header
-*   source
-*   body

xobjects-0.7.0/docs/architecture/types.rst

@@ -1,179 +0,0 @@
-Types
-=====
-
-Introduction
--------------
-
-
-Data layout and API can be defined by a composition of:
-*   Scalars: Int8, Int16, Int32, Int64, Float32, Float64
-*   Compounds: Struct, Array, Ref
-
-Types can have a fixed size (*static types*) or a variable size (*dynamic size*).
-The size of one instance cannot change after creation, but their content can.
-
-
-Data Layout
--------------
-
-Data structure is organized in 64bit slots.
-
-Table indicates slot size and the description.
-
-Scalar
-
-=====  ===========
-Slots  Description
-=====  ===========
-8      Data
-=====  ===========
-
-String of n-bytes
-
-=============     ===============================
-Slots             Description
-=============     ===============================
-8                 Size in bytes
-ceil((n+1)/8)     Data in UTF-8 null terminated
-=============     ===============================
-
-
-Struct with static and *n* dynamical fields
-
-=======  ===============================
-Slots    Description
-=======  ===============================
-8        Optional: size if n>0
-...      Fixed-size field data
-8*(n-1)  Optional: Offsets of the 2nd to n-th last variable sized
-...      Optional: Variable sized data
-=======  ===============================
-
-Array with n dimensions, whose l are dynamic of *m* items.
-
-=======  ===============================
-Slots    Description
-=======  ===============================
-8        Optional: size
-8*l      Optional: size of l-variable dimensions
-8*n      Optional: strides for n-dimensions larger than 2
-m*s      Data or offsets for m-items (s is the item-size or 8)
-...      Optional: Items data if the item type is dynamic
-=======  ===============================
-
-Union
-
-=======  ===============================
-Slots    Description
-=======  ===============================
-8        Type id
-...      Item data
-=======  ===============================
-
-
-Ref
-
-=======  ======================================
-Slots    Description
-=======  ======================================
-8        Offset from start of the buffer
-8        Optional: typeid
-=======  ======================================
-
-
-Python type interface
-----------------------
-
-The following describe the generic interface
-
-Class variables:
-
-==============  ===============================
-name            Description
-==============  ===============================
-_size           Size in bytes, None if not static size
-==============  ===============================
-
-Class methods:
-
-============= ============== ============ ============================================
-name          args           return                  Description
-============= ============== ============ ============================================
-_inspect_args *args,         Info         Return at least info.size and optionally
-              *kwargs                     other metadata to build objects in memory
-                                          from python objects. Args are propocessed
-                                          by _pre_init
-_pre_init     *args,         args,        Preprocess arguments and generate standard
-              *kwargs        kwargs       values
-_to_buffer    buffer         None         Serialize python in buffer from offset.
-              offset                      Assume sufficient size is available
-              value
-_from_buffer  buffer         instance     Return Python instance from buffer and
-              offset                      and offset
-_to_schema                   string       TODO String representation of the type to
-                                          deserialize objects
-============= ============== ============ ============================================
-
-
-Instance variables:
-
-=============  ========================================
-name           Description
-=============  ========================================
-_size          Optional: size in bytes for dynamic-size
-=============  ========================================
-
-
-Class methods:
-
-============= ============== ============ ============================================
-name          args           return                  Description
-============= ============== ============ ============================================
-_post_init                                Run after object creation in __init__
-copy          buffer or      None         TODO Return a copy into a buffer
-              context                      Assume sufficient size is available
-_update       value          instance     Update values of an exsiting objec
-_to_json                     json         TODO json
-============= ============== ============ ============================================
-
-
-
-**__init__**
-
-init is used to  create a new xobject by allocating memory on the buffer.
-Ref and Scalars cannot be initialized alone (maybe temporarily)
-
-Init can take by default:
-
-*  a json object:
-    *  dict for Struct
-    *  list for Array,
-    *  number of Scalars
-    *  String for String
-    *  (Typename, {}) for Ref of multiple types
-*  dimensions (for string or arrays)
-*  an xobject of the correct type
-*  None for Ref
-
-The data is dispatched to _pre_init using the following convetion:
-* a dict is passed with **
-* a tuple is passed with *
-* any other object is passed verbatim
-
-Init uses the following steps:
-
-*  pre_init to pre_process input
-*  inspect_args to calculate sizes and collect metadata
-*  get_a_buffer to allocate space
-*  _to_buffer to write to memory
-*  _from_buffer to build a python object
-*  post_init
-
-**_from_buffer**
-
-When accessing data inside compound object the _from_buffer method is used.
-For scalar and string, python data is returned. For coumpund object,
-XObjects are returned
-
-**setters**
-Setters uses to_buffer or _update to update existing data.

xobjects-0.7.0/docs/architecture.rst

@@ -1,16 +0,0 @@
-Architecture
-==============
-
-
-
-The architucture is based on
-
-* Context managers implementing buffer, compilation, running
-* Type system to specify data layout and user API
-
-
-.. toctree::
-    :maxdepth: 2
-
-    architecture/contexts
-    architecture/types