arrayops 1.0.0

Rust-backed acceleration for Python array.array

arrayops

Rust-backed acceleration for Python's array.array type

Fast, lightweight numeric operations for Python's array.array, numpy.ndarray (1D), and memoryview objects. Built with Rust and PyO3 for zero-copy, memory-safe performance.

✨ Features

• ⚡ High Performance: 10-100x faster than pure Python loops using Rust-accelerated operations
• 🔒 Memory Safe: Zero-copy buffer access with Rust's safety guarantees
• 🛡️ Security Focused: Comprehensive input validation, security testing, and dependency scanning
• 📦 Lightweight: No dependencies beyond Rust standard library (optional: parallel execution via rayon)
• 🔌 Compatible: Works directly with Python's array.array, numpy.ndarray (1D), memoryview, and Apache Arrow buffers - no new types
• ✅ Fully Tested: 100% code coverage (Python and Rust)
• 🎯 Type Safe: Full mypy type checking support

🚀 Quick Start

Installation

# Install maturin if not already installed
pip install maturin

# Install in development mode
maturin develop

# Or install from source
pip install -e .

# With optional features (recommended for large arrays)
maturin develop --features parallel

Basic Usage

import array
import arrayops as ao

# Create an array
data = array.array('i', [1, 2, 3, 4, 5])

# Fast operations
total = ao.sum(data)           # 15
ao.scale(data, 2.0)            # In-place: [2, 4, 6, 8, 10]
doubled = ao.map(data, lambda x: x * 2)  # New array: [4, 8, 12, 16, 20]
evens = ao.filter(data, lambda x: x % 2 == 0)  # [4, 8, 12, 16, 20]
product = ao.reduce(data, lambda acc, x: acc * x, initial=1)  # 3840

# Statistical operations
avg = ao.mean(data)            # 3.0
min_val = ao.min(data)         # 1
max_val = ao.max(data)         # 5
std_dev = ao.std(data)         # 1.41...
median_val = ao.median(data)   # 3

# Element-wise operations
arr2 = array.array('i', [10, 20, 30, 40, 50])
summed = ao.add(data, arr2)    # [11, 22, 33, 44, 55]
product = ao.multiply(data, arr2)  # [10, 40, 90, 160, 250]
ao.clip(data, 2.0, 4.0)        # In-place: [2, 2, 3, 4, 4]
ao.normalize(data)             # In-place: [0.0, 0.25, 0.5, 0.75, 1.0]

# Array manipulation
ao.reverse(data)               # In-place: [5, 4, 3, 2, 1]
ao.sort(data)                  # In-place: [1, 2, 3, 4, 5]
unique_vals = ao.unique(data)  # [1, 2, 3, 4, 5]

# Zero-copy slicing
sliced = ao.slice(data, 1, 4)  # Returns memoryview: [2, 3, 4]

# Lazy evaluation (chain operations without intermediate allocations)
lazy = ao.lazy_array(data)
result = lazy.map(lambda x: x * 2).filter(lambda x: x > 5).collect()
# Efficiently chains map and filter, executes only when collect() is called

📚 For complete documentation, examples, and API reference, see arrayops.readthedocs.io

📚 Supported Types

arrayops supports all numeric array.array typecodes, numpy.ndarray (1D, contiguous), Python memoryview objects, and Apache Arrow buffers/arrays:

Type	Code	Description
Signed integers	b, h, i, l	int8, int16, int32, int64
Unsigned integers	B, H, I, L	uint8, uint16, uint32, uint64
Floats	f, d	float32, float64

📖 Documentation

Complete documentation is available at arrayops.readthedocs.io:

• Getting Started - Installation and basic usage
• API Reference - Complete function documentation
• Examples - Practical usage patterns and cookbook
• Performance Guide - Benchmark results and optimization tips
• Troubleshooting - Common issues and solutions

⚡ Performance

arrayops provides significant speedups over pure Python operations:

Operation	Python	arrayops	Speedup
Sum (1M ints)	~50ms	~0.5ms	100x
Scale (1M ints)	~80ms	~1.5ms	50x
Map (1M ints)	~100ms	~5ms	20x
Filter (1M ints)	~120ms	~8ms	15x
Reduce (1M ints)	~150ms	~6ms	25x
Memory overhead	N/A	Zero-copy	—

See the Performance Guide for detailed benchmarks and optimization tips.

Performance Features

arrayops supports optional performance optimizations via feature flags:

Parallel Execution (--features parallel)

For large arrays, parallel execution can provide significant speedups on multi-core systems:

• Enabled operations: sum, scale
• Threshold: Arrays larger than 10,000 elements (sum) or 5,000 elements (scale) automatically use parallel processing
• Installation: maturin develop --features parallel
• Performance: 2-4x additional speedup on multi-core systems

SIMD Optimizations (--features simd)

SIMD (Single Instruction, Multiple Data) optimizations are in development:

• Status: Infrastructure in place, full implementation pending std::simd API stabilization
• Expected performance: 2-4x additional speedup on supported CPUs
• Target operations: sum, scale (primary), element-wise operations
• Installation: maturin develop --features simd

🔄 Comparison

Feature	array.array	arrayops	NumPy
Memory efficient	✅	✅	❌
Fast operations	❌	✅	✅
Multi-dimensional	❌	❌	✅
Zero dependencies	✅	✅ (NumPy optional)	❌
C-compatible	✅	✅	✅
Type safety	✅	✅	⚠️
NumPy interop	❌	✅ (1D only)	✅
Memoryview support	❌	✅	❌
Arrow interop	❌	✅	✅
Zero-copy slicing	❌	✅	⚠️
Lazy evaluation	❌	✅	❌
Use case	Binary I/O	Scripting/ETL	Scientific computing

🏗️ Architecture

┌─────────────────────────────────────────┐
│           Python Layer                  │
│  array.array → arrayops → _arrayops     │
└────────────────┬────────────────────────┘
                 │ Buffer Protocol
                 │ (Zero-copy)
                 ▼
┌─────────────────────────────────────────┐
│           Rust Layer (PyO3)             │
│  Typed operations                       │
│  SIMD / Parallel optimizations          │
└─────────────────────────────────────────┘

🧪 Testing

# Run all tests
pytest tests/ -v

# With coverage
pytest tests/ --cov=arrayops --cov-report=html

# Type checking
mypy arrayops tests

Coverage: 100% Python code coverage

🔧 Development

Prerequisites

• Python 3.8+
• Rust 1.75+ (for SIMD features)
• maturin (install with pip install maturin)

Building

# Development build
maturin develop

# Release build
maturin build --release

# With features
maturin develop --features parallel,simd

Contributing

See the Contributing Guide for details on:

• Development workflow
• Code style guidelines
• Testing requirements
• Pull request process

📝 Error Handling

arrayops provides clear error messages:

import arrayops as ao

# Wrong type
ao.sum([1, 2, 3])  # TypeError: Expected array.array, numpy.ndarray, or memoryview

# Unsupported typecode
arr = array.array('c', b'abc')
ao.sum(arr)  # TypeError: Unsupported typecode: 'c'

🔒 Security

arrayops takes security seriously. For security-related issues:

• Report vulnerabilities: See SECURITY.md for responsible disclosure
• Security documentation: See Security Documentation for security guarantees and best practices
• Security updates: Keep arrayops and dependencies up to date

📄 License

MIT License - see LICENSE file for details.

🙏 Acknowledgments

• Built with PyO3 for Python-Rust interop
• Built with maturin for packaging
• Inspired by the need for fast, lightweight array operations for Python's built-in array type

📞 Support

• Documentation: arrayops.readthedocs.io
• Issues: Report bugs or request features on GitHub
• Questions: Open a discussion on GitHub

---

For detailed documentation, examples, and API reference, visit arrayops.readthedocs.io