xnd 0.2.0dev3

data/ext/ruby_xnd/xnd/configure.ac

@@ -0,0 +1,164 @@
+
+AC_PREREQ([2.67])
+AC_INIT(xnd, 0.2.0dev3, skrah@bytereef.org, xnd, https://github.com/plures/)
+AC_CONFIG_HEADER(config.h)
+AC_CONFIG_FILES([Makefile libxnd/Makefile libxnd/tests/Makefile])
+
+# System and machine type (only used for Darwin):
+AC_MSG_CHECKING(system as reported by uname -s)
+ac_sys_system=`uname -s`
+AC_MSG_RESULT($ac_sys_system)
+
+LIBSTATIC=libxnd.a
+case $ac_sys_system in
+    darwin*|Darwin*)
+        LIBRARY_PATH="DYLD_LIBRARY_PATH"
+        LIBNAME="libxnd.dylib"
+        LIBSONAME="libxnd.0.dylib"
+        LIBSHARED="libxnd.0.2.0dev3.dylib"
+        CONFIGURE_LDFLAGS="-dynamiclib -install_name @rpath/$LIBSONAME -undefined dynamic_lookup -compatibility_version 0.2 -current_version 0.2.0"
+        ;;
+    *)
+        LIBRARY_PATH="LD_LIBRARY_PATH"
+        LIBNAME="libxnd.so"
+        LIBSONAME="libxnd.so.0"
+        LIBSHARED="libxnd.so.0.2.0dev3"
+        CONFIGURE_LDFLAGS="-shared -Wl,-soname,$LIBSONAME"
+        ;;
+esac
+
+AC_SUBST(LIBSTATIC)
+AC_SUBST(LIBRARY_PATH)
+AC_SUBST(LIBNAME)
+AC_SUBST(LIBSONAME)
+AC_SUBST(LIBSHARED)
+
+
+# Apparently purely informational for this particular build:
+AC_CANONICAL_HOST
+AC_SUBST(build)
+AC_SUBST(host)
+
+# Language and compiler:
+AC_LANG_C
+saved_cflags=$CFLAGS
+AC_PROG_CC
+CFLAGS=$saved_cflags
+
+# ar and ranlib:
+AC_CHECK_TOOL(AR, ar, ar)
+AC_PROG_RANLIB
+AC_SUBST(RANLIB)
+
+
+# Checks for header files:
+AC_HEADER_STDC
+
+# Install program:
+AC_PROG_INSTALL
+AC_SUBST(INSTALL)
+
+# Add an explicit include directory.
+AC_MSG_CHECKING(for --with-includes)
+AC_ARG_WITH(includes,
+            AS_HELP_STRING([--with-includes="/usr/local/include"],
+            [absolute path to an include directory]),
+            [],
+            [with_includes="none"])
+
+AC_MSG_RESULT($with_includes)
+
+if test "$with_includes" = "none"; then
+    CONFIGURE_INCLUDES=../ndtypes/libndtypes
+    CONFIGURE_INCLUDES_TEST=../../ndtypes/libndtypes
+else
+    CONFIGURE_INCLUDES=$with_includes
+    CONFIGURE_INCLUDES_TEST=$with_includes
+fi
+
+AC_SUBST(CONFIGURE_INCLUDES)
+AC_SUBST(CONFIGURE_INCLUDES_TEST)
+
+# Add an explicit library path.
+AC_MSG_CHECKING(for --with-libs)
+AC_ARG_WITH(libs,
+            AS_HELP_STRING([--with-libs="/usr/local/lib"],
+            [absolute path to a library directory]),
+            [],
+            [with_libs="none"])
+
+AC_MSG_RESULT($with_libs)
+
+if test "$with_libs" = "none"; then
+    CONFIGURE_LIBS=../ndtypes/libndtypes
+    CONFIGURE_LIBS_TEST=../../ndtypes/libndtypes
+else
+    CONFIGURE_LIBS=$with_libs
+    CONFIGURE_LIBS_TEST=$with_libs
+fi
+
+AC_SUBST(CONFIGURE_LIBS)
+AC_SUBST(CONFIGURE_LIBS_TEST)
+
+# Without documentation:
+AC_MSG_CHECKING([for --with-docs])
+AC_ARG_WITH([docs],
+  AS_HELP_STRING([--with-docs], [install documentation - enabled by default]),,
+  with_docs=yes)
+AC_MSG_RESULT([$with_docs])
+if test "$with_docs" = yes; then
+   NDT_INSTALL_DOCS="install_docs"
+else
+   NDT_INSTALL_DOCS=""
+fi
+
+AC_SUBST(NDT_INSTALL_DOCS)
+
+# Compiler dependent settings:
+XND_WARN=
+XND_OPT="-O2"
+case $CC in
+    *gcc*)
+        XND_WARN="-Wall -Wextra -std=c11 -pedantic"
+        XND_OPT="-O2"
+        ;;
+    *icc*)
+        AR=xiar
+        XND_WARN="-Wall"
+        XND_OPT="-O2"
+        ;;
+    *clang*)
+        XND_WARN="-Wall -Wextra -std=c11 -pedantic"
+        XND_OPT="-O2"
+        ;;
+esac
+
+
+
+# Substitute variables and generate output:
+if test -z "$LD"; then
+    LD="$CC"
+fi
+AC_SUBST(LD)
+AC_SUBST(AR)
+AC_SUBST(XND_WARN)
+AC_SUBST(XND_OPT)
+
+
+if test -z "$CFLAGS"; then
+    CONFIGURE_CFLAGS="$XND_INCLUDE $XND_WARN $XND_CONFIG $XND_OPT"
+else
+    CONFIGURE_CFLAGS="$XND_INCLUDE $XND_WARN $XND_CONFIG $XND_OPT $CFLAGS"
+fi
+
+if test -z "$LDFLAGS"; then
+    CONFIGURE_LDFLAGS="$XND_LINK $CONFIGURE_LDFLAGS"
+else
+    CONFIGURE_LDFLAGS="$XND_LINK $CONFIGURE_LDFLAGS $LDFLAGS"
+fi
+
+AC_SUBST(CONFIGURE_CFLAGS)
+AC_SUBST(CONFIGURE_LDFLAGS)
+
+AC_OUTPUT
+

data/ext/ruby_xnd/xnd/doc/Makefile

@@ -0,0 +1,14 @@
+# Makefile for Sphinx documentation.
+SPHINXBUILD = sphinx-build
+BUILDDIR = build
+
+default: html
+
+html:
+	sphinx-build -b html -d build/doctrees . build/html
+
+doctest:
+	sphinx-build -b doctest -d build/doctrees . build/html
+
+clean:
+	rm -rf $(BUILDDIR)/*

data/ext/ruby_xnd/xnd/doc/_static/copybutton.js

@@ -0,0 +1,66 @@
+// Copyright 2014 PSF. Licensed under the PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2
+// File originates from the cpython source found in Doc/tools/sphinxext/static/copybutton.js
+
+$(document).ready(function() {
+    /* Add a [>>>] button on the top-right corner of code samples to hide
+     * the >>> and ... prompts and the output and thus make the code
+     * copyable. */
+    var div = $('.highlight-py .highlight,' +
+                '.highlight-default .highlight,' +
+                '.highlight-py3 .highlight')
+    var pre = div.find('pre');
+
+    // get the styles from the current theme
+    pre.parent().parent().css('position', 'relative');
+    var hide_text = 'Hide the prompts and output';
+    var show_text = 'Show the prompts and output';
+    var border_width = pre.css('border-top-width');
+    var border_style = pre.css('border-top-style');
+    var border_color = pre.css('border-top-color');
+    var button_styles = {
+        'cursor':'pointer', 'position': 'absolute', 'top': '0', 'right': '0',
+        'border-color': border_color, 'border-style': border_style,
+        'border-width': border_width, 'color': border_color, 'text-size': '75%',
+        'font-family': 'monospace', 'padding-left': '0.2em', 'padding-right': '0.2em',
+        'border-radius': '0 3px 0 0'
+    }
+
+    // create and add the button to all the code blocks that contain >>>
+    div.each(function(index) {
+        var jthis = $(this);
+        if (jthis.find('.gp').length > 0) {
+            var button = $('<span class="copybutton">&gt;&gt;&gt;</span>');
+            button.css(button_styles)
+            button.attr('title', hide_text);
+            button.data('hidden', 'false');
+            jthis.prepend(button);
+        }
+        // tracebacks (.gt) contain bare text elements that need to be
+        // wrapped in a span to work with .nextUntil() (see later)
+        jthis.find('pre:has(.gt)').contents().filter(function() {
+            return ((this.nodeType == 3) && (this.data.trim().length > 0));
+        }).wrap('<span>');
+    });
+
+    // define the behavior of the button when it's clicked
+    $('.copybutton').click(function(e){
+        e.preventDefault();
+        var button = $(this);
+        if (button.data('hidden') === 'false') {
+            // hide the code output
+            button.parent().find('.go, .gp, .gt').hide();
+            button.next('pre').find('.gt').nextUntil('.gp, .go').css('visibility', 'hidden');
+            button.css('text-decoration', 'line-through');
+            button.attr('title', show_text);
+            button.data('hidden', 'true');
+        } else {
+            // show the code output
+            button.parent().find('.go, .gp, .gt').show();
+            button.next('pre').find('.gt').nextUntil('.gp, .go').css('visibility', 'visible');
+            button.css('text-decoration', 'none');
+            button.attr('title', hide_text);
+            button.data('hidden', 'false');
+        }
+    });
+});
+

data/ext/ruby_xnd/xnd/doc/conf.py

@@ -0,0 +1,26 @@
+import sys, os, docutils
+
+
+extensions = ['sphinx.ext.intersphinx', 'sphinx.ext.doctest']
+
+source_suffix = '.rst'
+master_doc = 'index'
+project = 'xnd'
+copyright = '2017-2018, Plures Project'
+version = 'v0.2.0dev3'
+release = 'v0.2.0dev3'
+exclude_patterns = ['doc', 'build']
+pygments_style = 'sphinx'
+html_static_path = ['_static']
+
+primary_domain = 'py'
+add_function_parentheses = False
+
+
+def setup(app):
+    app.add_crossref_type('topic', 'topic', 'single: %s',
+                          docutils.nodes.strong)
+    app.add_javascript("copybutton.js")
+
+
+

data/ext/ruby_xnd/xnd/doc/index.rst

@@ -0,0 +1,44 @@
+.. meta::
+   :robots: index, follow
+   :description: xnd documentation
+   :keywords: libxnd, xnd, C, Python, array computing
+
+.. sectionauthor:: Stefan Krah <skrah at bytereef.org>
+
+
+xnd
+===
+
+xnd is a package for typed memory blocks.
+
+
+Libxnd
+------
+
+C library.
+
+.. toctree::
+   :maxdepth: 1
+
+   libxnd/index.rst
+
+
+Xnd
+---
+
+Python module.
+
+
+.. toctree::
+   :maxdepth: 1
+
+   xnd/index.rst
+
+
+Releases
+--------
+
+.. toctree::
+   :maxdepth: 1
+
+   releases/index.rst

data/ext/ruby_xnd/xnd/doc/libxnd/data-structures.rst

@@ -0,0 +1,186 @@
+.. meta::
+   :robots: index,follow
+   :description: libxnd documentation
+
+.. sectionauthor:: Stefan Krah <skrah at bytereef.org>
+
+
+Data structures
+===============
+
+libxnd is a lightweight container library that leaves most of the work to
+libndtypes. The underlying idea is to have a small struct that contains
+bitmaps, a linear index, a type and a data pointer.
+
+The type contains all low level access information.
+
+Since the struct is small, it can easily be passed around by value when
+it serves as a view on the data.
+
+The owner of the data is a master buffer with some additional bookkeeping
+fields.
+
+
+Bitmaps
+-------
+
+.. topic:: bitmaps
+
+.. code-block:: c
+
+   typedef struct xnd_bitmap xnd_bitmap_t;
+
+   struct xnd_bitmap {
+       uint8_t *data;      /* bitmap */
+       int64_t size;       /* number of subtree bitmaps in the "next" array */
+       xnd_bitmap_t *next; /* array of bitmaps for subtrees */
+   };
+
+libxnd supports data with optional values. Any type can have a bitmap for its
+data.  Bitmaps are addressed using the linear index in the :c:macro:`xnd_t`
+struct.
+
+For a scalar, the bitmap contains just one addressable bit.
+
+For fixed and variable arrays, the bitmap contains one bit for each item.
+
+Container types like tuples and records have new bitmaps for each of their
+fields if any of the field subtrees contains optional data.
+
+These field bitmaps are in the *next* array.
+
+
+View
+----
+
+.. topic:: xnd_view
+
+.. code-block:: c
+
+
+   /* Typed memory block, usually a view. */
+   typedef struct xnd {
+       xnd_bitmap_t bitmap; /* bitmap tree */
+       int64_t index;       /* linear index for var dims */
+       const ndt_t *type;   /* type of the data */
+       char *ptr;           /* data */
+   } xnd_t;
+
+This is the xnd view, with a typed data pointer, the current linear index
+and a bitmap.
+
+When passing the view around, the linear index needs to be maintained because
+it is required to determine if a value is missing (NA).
+
+The convention is to apply the linear index (adjust the *ptr* and set it
+to *0*) only when a non-optional element at *ndim == 0* is actually
+accessed.
+
+This happens for example when getting the value of an element or when
+descending into a record.
+
+
+Flags
+-----
+
+.. topic:: flags
+
+.. code-block:: c
+
+   #define XND_OWN_TYPE     0x00000001U /* type pointer */
+   #define XND_OWN_DATA     0x00000002U /* data pointer */
+   #define XND_OWN_STRINGS  0x00000004U /* embedded string pointers */
+   #define XND_OWN_BYTES    0x00000008U /* embedded bytes pointers */
+   #define XND_OWN_POINTERS 0x00000010U /* embedded pointers */
+
+   #define XND_OWN_ALL (XND_OWN_TYPE |    \
+                        XND_OWN_DATA |    \
+                        XND_OWN_STRINGS | \
+                        XND_OWN_BYTES |   \
+                        XND_OWN_POINTERS)
+
+   #define XND_OWN_EMBEDDED (XND_OWN_DATA |    \
+                             XND_OWN_STRINGS | \
+                             XND_OWN_BYTES |   \
+                             XND_OWN_POINTERS)
+
+
+The ownership flags for the xnd master buffer (see below).  Like libndtypes,
+libxnd itself has no notion of how many exported views a master buffer has.
+
+This is deliberately done in order to prevent two different memory management
+schemes from getting in each other's way.
+
+However, for deallocating a master buffer the flags must be set correctly.
+
+:c:macro:`XND_OWN_TYPE` is set if the master buffer owns the :c:macro:`ndt_t`.
+
+:c:macro:`XND_OWN_DATA` is set if the master buffer owns the data pointer.
+
+
+The *string*, *bytes* and *ref* types have pointers that are embedded in the
+data.  Usually, these are owned and deallocated by libxnd.
+
+For strings, the Python bindings use the convention that :c:macro:`NULL` strings
+are interpreted as the empty string. Once a string pointer is initialized it
+belongs to the master buffer.
+
+
+Macros
+------
+
+.. topic:: macros
+
+.. code-block:: c
+
+   /* Convenience macros to extract embedded values. */
+   #define XND_POINTER_DATA(ptr) (*((char **)ptr))
+   #define XND_BYTES_SIZE(ptr) (((ndt_bytes_t *)ptr)->size)
+   #define XND_BYTES_DATA(ptr) (((ndt_bytes_t *)ptr)->data)
+
+These macros should be used to extract embedded *ref*, *string* and *bytes*
+data.
+
+
+
+Master buffer
+-------------
+
+.. topic:: xnd_master
+
+.. code-block:: c
+
+   /* Master memory block. */
+   typedef struct xnd_master {
+       uint32_t flags; /* ownership flags */
+       xnd_t master;   /* typed memory */
+   } xnd_master_t;
+
+This is the master buffer.  *flags* are explained above, the *master* buffer
+should be considered constant.
+
+For traversing memory, copy a new view buffer by value.
+
+
+Slice and index keys
+--------------------
+
+.. topic:: xnd_key
+
+.. code-block:: c
+
+   enum xnd_key { Index, FieldName, Slice };
+   typedef struct {
+     enum xnd_key tag;
+     union {
+       int64_t Index;
+       const char *FieldName;
+       ndt_slice_t Slice;
+     };
+   } xnd_index_t;
+
+Slicing and indexing uses the same model as Python.  Indices are usually
+integers, but record fields may also be indexed with field names.
+
+*ndt_slice_t* has *start*, *stop*, *step* fields that must be filled in with
+normalized values following the same protocol as :c:func:`PySlice_Unpack`.