From 5b224f9603e8d18b5e52e6fbef485b751626a82b Mon Sep 17 00:00:00 2001 From: Stefan Krah Date: Sat, 27 Apr 2024 19:19:01 +0200 Subject: [PATCH] Add README. --- xnd/README.rst | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/xnd/README.rst b/xnd/README.rst index e69de29..c2014fd 100644 --- a/xnd/README.rst +++ b/xnd/README.rst @@ -0,0 +1,19 @@ +Overview +-------- + +The ``xnd`` module implements a container type that maps most Python values +relevant for scientific computing directly to typed memory. + +Whenever possible, a single, pointer-free memory block is used. + +``xnd`` supports ragged arrays, categorical types, indexing, slicing, aligned +memory blocks and type inference. + +Operations like indexing and slicing return zero-copy typed views on the data. + +Importing PEP-3118 buffers is supported. + +Links +----- + +* https://github.com/xnd-project/