numpy-quaddtype 0.1.0__tar.gz

numpy_quaddtype-0.1.0/PKG-INFO

@@ -0,0 +1,170 @@
+Metadata-Version: 2.1
+Name: numpy_quaddtype
+Version: 0.1.0
+Summary: Quad (128-bit) float dtype for numpy
+Author-Email: Swayam Singh <singhswayam008@gmail.com>
+Requires-Python: >=3.10.0
+Requires-Dist: numpy
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-run-parallel; extra == "test"
+Description-Content-Type: text/markdown
+
+# Numpy-QuadDType
+
+A cross-platform Quad (128-bit) float Data-Type for NumPy.
+
+## Installation
+
+```bash
+pip install numpy
+pip install numpy-quaddtype
+```
+
+## Usage
+
+```python
+import numpy as np
+from numpy_quaddtype import QuadPrecDType, QuadPrecision
+
+# using sleef backend (default)
+np.array([1,2,3], dtype=QuadPrecDType())
+np.array([1,2,3], dtype=QuadPrecDType("sleef"))
+
+# using longdouble backend
+np.array([1,2,3], dtype=QuadPrecDType("longdouble"))
+```
+
+## Installation from source
+
+The code needs the quad precision pieces of the sleef library, which is not available on most systems by default, so we have to generate that first. Choose the appropriate section below based on your operating system.
+
+### Linux/Unix/macOS
+
+The below assumes one has the required pieces to build sleef (cmake and libmpfr-dev), and that one is in the package directory locally.
+
+```bash
+git clone --branch 3.8 https://github.com/shibatch/sleef.git
+cd sleef
+cmake -S . -B build -DSLEEF_BUILD_QUAD:BOOL=ON -DSLEEF_BUILD_SHARED_LIBS:BOOL=ON -DCMAKE_POSITION_INDEPENDENT_CODE=ON
+cmake --build build/ --clean-first -j
+cd ..
+```
+
+Building the `numpy-quaddtype` package from locally installed sleef:
+
+```bash
+export SLEEF_DIR=$PWD/sleef/build
+export LIBRARY_PATH=$SLEEF_DIR/lib
+export C_INCLUDE_PATH=$SLEEF_DIR/include
+export CPLUS_INCLUDE_PATH=$SLEEF_DIR/include
+
+# setup the virtual env
+python3 -m venv temp
+source temp/bin/activate
+
+# Install the package
+pip install meson-python numpy pytest
+
+export LDFLAGS="-Wl,-rpath,$SLEEF_DIR/lib -fopenmp -latomic -lpthread"
+export CFLAGS="-fPIC"
+export CXXFLAGS="-fPIC"
+
+# To build without QBLAS (default for MSVC)
+# export CFLAGS="-fPIC -DDISABLE_QUADBLAS"
+# export CXXFLAGS="-fPIC -DDISABLE_QUADBLAS"
+
+python -m pip install . -v --no-build-isolation -Cbuilddir=build -C'compile-args=-v'
+
+# Run the tests
+cd ..
+python -m pytest
+```
+
+### Windows
+
+#### Prerequisites
+
+- **Visual Studio 2017 or later** (with MSVC compiler)
+- **CMake** (≥3.15)
+- **Python 3.10+** 
+- **Git**
+
+#### Step-by-Step Installation
+
+1. **Setup Development Environment**
+
+   Open a **Developer Command Prompt for VS** or **Developer PowerShell for VS** to ensure MSVC is properly configured.
+
+2. **Clone and Build SLEEF**
+
+   ```powershell
+   # Clone SLEEF library
+   git clone --branch 3.8 https://github.com/shibatch/sleef.git
+   cd sleef
+
+   # Configure with CMake for Windows
+   cmake -S . -B build -G "Visual Studio 17 2022" -A x64 -DSLEEF_BUILD_QUAD:BOOL=ON -DSLEEF_BUILD_SHARED_LIBS:BOOL=ON -DCMAKE_POSITION_INDEPENDENT_CODE=ON
+
+   # Build and install SLEEF
+   cmake --build build --config Release
+   cmake --install build --prefix "C:/sleef" --config Release
+
+   cd ..
+   ```
+
+3. **Setup Python Environment**
+
+   ```powershell
+   # Create and activate virtual environment
+   python -m venv numpy_quad_env
+   .\numpy_quad_env\Scripts\Activate.ps1
+
+   # Install build dependencies
+   pip install -U pip
+   pip install meson-python numpy pytest ninja meson
+   ```
+
+4. **Set Environment Variables**
+
+   ```powershell
+   # Set up paths and compiler flags
+   $env:INCLUDE = "C:/sleef/include;$env:INCLUDE"
+   $env:LIB = "C:/sleef/lib;$env:LIB"
+   $env:PATH = "C:/sleef/bin;$env:PATH"
+
+   # Note: QBLAS is disabled on Windows due to MSVC compatibility issues
+   $env:CFLAGS = "/IC:/sleef/include /DDISABLE_QUADBLAS"
+   $env:CXXFLAGS = "/IC:/sleef/include /DDISABLE_QUADBLAS"
+   $env:LDFLAGS = "C:/sleef/lib/sleef.lib C:/sleef/lib/sleefquad.lib"
+   ```
+
+5. **Build and Install numpy-quaddtype**
+
+   ```powershell
+   # Ensure submodules are initialized
+   git submodule update --init --recursive
+
+   # Build and install the package
+   python -m pip install . -v --no-build-isolation -Cbuilddir=build -C'compile-args=-v'
+   ```
+
+6. **Test Installation**
+
+   ```powershell
+   # Run tests
+   pytest -s tests/
+   ```
+
+1. **QBLAS Disabled**: QuadBLAS optimization is automatically disabled on Windows builds due to MSVC compatibility issues. This is handled by the `-DDISABLE_QUADBLAS` compiler flag.
+
+2. **Visual Studio Version**: The instructions assume Visual Studio 2022. For other versions, adjust the generator string:
+   - VS 2019: `"Visual Studio 16 2019"`
+   - VS 2017: `"Visual Studio 15 2017"`
+
+3. **Architecture**: The instructions are for x64. For x86 builds, change `-A x64` to `-A Win32`.
+
+4. **Alternative SLEEF Location**: If you prefer to install SLEEF elsewhere, update all path references accordingly.
+
+#### Windows Troubleshooting
+- **Link errors**: Verify that `sleef.lib` and `sleefquad.lib` exist in `C:/sleef/lib/`

numpy_quaddtype-0.1.0/README.md

@@ -0,0 +1,158 @@
+# Numpy-QuadDType
+
+A cross-platform Quad (128-bit) float Data-Type for NumPy.
+
+## Installation
+
+```bash
+pip install numpy
+pip install numpy-quaddtype
+```
+
+## Usage
+
+```python
+import numpy as np
+from numpy_quaddtype import QuadPrecDType, QuadPrecision
+
+# using sleef backend (default)
+np.array([1,2,3], dtype=QuadPrecDType())
+np.array([1,2,3], dtype=QuadPrecDType("sleef"))
+
+# using longdouble backend
+np.array([1,2,3], dtype=QuadPrecDType("longdouble"))
+```
+
+## Installation from source
+
+The code needs the quad precision pieces of the sleef library, which is not available on most systems by default, so we have to generate that first. Choose the appropriate section below based on your operating system.
+
+### Linux/Unix/macOS
+
+The below assumes one has the required pieces to build sleef (cmake and libmpfr-dev), and that one is in the package directory locally.
+
+```bash
+git clone --branch 3.8 https://github.com/shibatch/sleef.git
+cd sleef
+cmake -S . -B build -DSLEEF_BUILD_QUAD:BOOL=ON -DSLEEF_BUILD_SHARED_LIBS:BOOL=ON -DCMAKE_POSITION_INDEPENDENT_CODE=ON
+cmake --build build/ --clean-first -j
+cd ..
+```
+
+Building the `numpy-quaddtype` package from locally installed sleef:
+
+```bash
+export SLEEF_DIR=$PWD/sleef/build
+export LIBRARY_PATH=$SLEEF_DIR/lib
+export C_INCLUDE_PATH=$SLEEF_DIR/include
+export CPLUS_INCLUDE_PATH=$SLEEF_DIR/include
+
+# setup the virtual env
+python3 -m venv temp
+source temp/bin/activate
+
+# Install the package
+pip install meson-python numpy pytest
+
+export LDFLAGS="-Wl,-rpath,$SLEEF_DIR/lib -fopenmp -latomic -lpthread"
+export CFLAGS="-fPIC"
+export CXXFLAGS="-fPIC"
+
+# To build without QBLAS (default for MSVC)
+# export CFLAGS="-fPIC -DDISABLE_QUADBLAS"
+# export CXXFLAGS="-fPIC -DDISABLE_QUADBLAS"
+
+python -m pip install . -v --no-build-isolation -Cbuilddir=build -C'compile-args=-v'
+
+# Run the tests
+cd ..
+python -m pytest
+```
+
+### Windows
+
+#### Prerequisites
+
+- **Visual Studio 2017 or later** (with MSVC compiler)
+- **CMake** (≥3.15)
+- **Python 3.10+** 
+- **Git**
+
+#### Step-by-Step Installation
+
+1. **Setup Development Environment**
+
+   Open a **Developer Command Prompt for VS** or **Developer PowerShell for VS** to ensure MSVC is properly configured.
+
+2. **Clone and Build SLEEF**
+
+   ```powershell
+   # Clone SLEEF library
+   git clone --branch 3.8 https://github.com/shibatch/sleef.git
+   cd sleef
+
+   # Configure with CMake for Windows
+   cmake -S . -B build -G "Visual Studio 17 2022" -A x64 -DSLEEF_BUILD_QUAD:BOOL=ON -DSLEEF_BUILD_SHARED_LIBS:BOOL=ON -DCMAKE_POSITION_INDEPENDENT_CODE=ON
+
+   # Build and install SLEEF
+   cmake --build build --config Release
+   cmake --install build --prefix "C:/sleef" --config Release
+
+   cd ..
+   ```
+
+3. **Setup Python Environment**
+
+   ```powershell
+   # Create and activate virtual environment
+   python -m venv numpy_quad_env
+   .\numpy_quad_env\Scripts\Activate.ps1
+
+   # Install build dependencies
+   pip install -U pip
+   pip install meson-python numpy pytest ninja meson
+   ```
+
+4. **Set Environment Variables**
+
+   ```powershell
+   # Set up paths and compiler flags
+   $env:INCLUDE = "C:/sleef/include;$env:INCLUDE"
+   $env:LIB = "C:/sleef/lib;$env:LIB"
+   $env:PATH = "C:/sleef/bin;$env:PATH"
+
+   # Note: QBLAS is disabled on Windows due to MSVC compatibility issues
+   $env:CFLAGS = "/IC:/sleef/include /DDISABLE_QUADBLAS"
+   $env:CXXFLAGS = "/IC:/sleef/include /DDISABLE_QUADBLAS"
+   $env:LDFLAGS = "C:/sleef/lib/sleef.lib C:/sleef/lib/sleefquad.lib"
+   ```
+
+5. **Build and Install numpy-quaddtype**
+
+   ```powershell
+   # Ensure submodules are initialized
+   git submodule update --init --recursive
+
+   # Build and install the package
+   python -m pip install . -v --no-build-isolation -Cbuilddir=build -C'compile-args=-v'
+   ```
+
+6. **Test Installation**
+
+   ```powershell
+   # Run tests
+   pytest -s tests/
+   ```
+
+1. **QBLAS Disabled**: QuadBLAS optimization is automatically disabled on Windows builds due to MSVC compatibility issues. This is handled by the `-DDISABLE_QUADBLAS` compiler flag.
+
+2. **Visual Studio Version**: The instructions assume Visual Studio 2022. For other versions, adjust the generator string:
+   - VS 2019: `"Visual Studio 16 2019"`
+   - VS 2017: `"Visual Studio 15 2017"`
+
+3. **Architecture**: The instructions are for x64. For x86 builds, change `-A x64` to `-A Win32`.
+
+4. **Alternative SLEEF Location**: If you prefer to install SLEEF elsewhere, update all path references accordingly.
+
+#### Windows Troubleshooting
+- **Link errors**: Verify that `sleef.lib` and `sleefquad.lib` exist in `C:/sleef/lib/`

numpy_quaddtype-0.1.0/meson.build

@@ -0,0 +1,88 @@
+project('numpy_quaddtype', 'c', 'cpp', default_options : ['cpp_std=c++20', 'b_pie=true'])
+
+py_mod = import('python')
+py = py_mod.find_installation()
+py_dep = py.dependency()
+
+c = meson.get_compiler('c')
+cpp = meson.get_compiler('cpp')
+
+is_windows = build_machine.system() == 'windows'
+
+if is_windows
+  add_project_arguments('-DWIN32', '-D_WINDOWS', language : ['c', 'cpp'])
+endif
+
+sleef_dep = [
+  c.find_library('sleef', required : true),
+  c.find_library('sleefquad', required : true)
+]
+
+incdir_numpy = run_command(py,
+  ['-c', 'import numpy; print(numpy.get_include())'],
+  check : true
+).stdout().strip()
+
+# Add OpenMP dependency (optional, for threading)
+openmp_dep = dependency('openmp', required: false)
+dependencies = [sleef_dep, py_dep]
+if openmp_dep.found()
+    dependencies += openmp_dep
+endif
+
+includes = include_directories(
+    [
+        incdir_numpy,
+        'numpy_quaddtype/QBLAS/include',
+        'numpy_quaddtype/src',
+    ]
+)
+
+srcs = [
+    'numpy_quaddtype/src/quad_common.h',
+    'numpy_quaddtype/src/casts.h',
+    'numpy_quaddtype/src/casts.cpp',
+    'numpy_quaddtype/src/scalar.h',
+    'numpy_quaddtype/src/scalar.c',
+    'numpy_quaddtype/src/dtype.h',
+    'numpy_quaddtype/src/dtype.c',
+    'numpy_quaddtype/src/quaddtype_main.c',
+    'numpy_quaddtype/src/scalar_ops.h',
+    'numpy_quaddtype/src/scalar_ops.cpp',
+    'numpy_quaddtype/src/ops.hpp',
+    'numpy_quaddtype/src/dragon4.h',
+    'numpy_quaddtype/src/dragon4.c',
+    'numpy_quaddtype/src/quadblas_interface.h',
+    'numpy_quaddtype/src/quadblas_interface.cpp',
+    'numpy_quaddtype/src/umath/umath.h',
+    'numpy_quaddtype/src/umath/umath.cpp',
+    'numpy_quaddtype/src/umath/binary_ops.h',
+    'numpy_quaddtype/src/umath/binary_ops.cpp',
+    'numpy_quaddtype/src/umath/unary_ops.h',
+    'numpy_quaddtype/src/umath/unary_ops.cpp',
+    'numpy_quaddtype/src/umath/unary_props.h',
+    'numpy_quaddtype/src/umath/unary_props.cpp',
+    'numpy_quaddtype/src/umath/comparison_ops.h',
+    'numpy_quaddtype/src/umath/comparison_ops.cpp',
+    'numpy_quaddtype/src/umath/promoters.hpp',
+    'numpy_quaddtype/src/umath/matmul.h',
+    'numpy_quaddtype/src/umath/matmul.cpp',
+]
+
+py.install_sources(
+    [
+        'numpy_quaddtype/__init__.py',
+    ],
+    subdir: 'numpy_quaddtype',
+    pure: false
+)
+
+py.extension_module('_quaddtype_main',
+  srcs,
+  link_args: is_windows ? ['/DEFAULTLIB:sleef', '/DEFAULTLIB:sleefquad'] : ['-lsleef', '-lsleefquad'],
+  link_language: 'cpp',
+  dependencies: dependencies,
+  install: true,
+  subdir: 'numpy_quaddtype',
+  include_directories: includes
+)

numpy_quaddtype-0.1.0/numpy_quaddtype/__init__.py

@@ -0,0 +1,45 @@
+from ._quaddtype_main import (
+    QuadPrecision,
+    QuadPrecDType,
+    is_longdouble_128,
+    get_sleef_constant,
+    set_num_threads,
+    get_num_threads,
+    get_quadblas_version
+)
+
+__all__ = [
+    'QuadPrecision', 'QuadPrecDType', 'SleefQuadPrecision', 'LongDoubleQuadPrecision',
+    'SleefQuadPrecDType', 'LongDoubleQuadPrecDType', 'is_longdouble_128', 
+    # Constants
+    'pi', 'e', 'log2e', 'log10e', 'ln2', 'ln10', 'max_value', 'epsilon',
+    'smallest_normal', 'smallest_subnormal', 'bits', 'precision', 'resolution',
+    # QuadBLAS related functions
+    'set_num_threads', 'get_num_threads', 'get_quadblas_version'
+]
+
+def SleefQuadPrecision(value):
+    return QuadPrecision(value, backend='sleef')
+
+def LongDoubleQuadPrecision(value):
+    return QuadPrecision(value, backend='longdouble')
+
+def SleefQuadPrecDType():
+    return QuadPrecDType(backend='sleef')
+
+def LongDoubleQuadPrecDType():
+    return QuadPrecDType(backend='longdouble')
+
+pi = get_sleef_constant("pi")
+e = get_sleef_constant("e")
+log2e = get_sleef_constant("log2e")
+log10e = get_sleef_constant("log10e")
+ln2 = get_sleef_constant("ln2")
+ln10 = get_sleef_constant("ln10")
+max_value = get_sleef_constant("max_value")
+epsilon = get_sleef_constant("epsilon")
+smallest_normal = get_sleef_constant("smallest_normal")
+smallest_subnormal = get_sleef_constant("smallest_subnormal")
+bits = get_sleef_constant("bits")
+precision = get_sleef_constant("precision")
+resolution = get_sleef_constant("resolution")