xnd 0.2.0dev3

data/ext/ruby_xnd/ruby_xnd.h

@@ -0,0 +1,61 @@
+/* BSD 3-Clause License
+ *
+ * Copyright (c) 2018, Quansight and Sameer Deshmukh
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the copyright holder nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+/* File containing headers for Ruby XND wrapper. 
+ *
+ * Author: Sameer Deshmukh (@v0dro)
+*/
+#ifndef RUBY_XND_H
+#define RUBY_XND_H
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#include "ruby.h"
+#include "ndtypes.h"
+#include "xnd.h"
+
+  size_t rb_xnd_hash_size(VALUE hash);
+  int rb_xnd_get_complex_values(VALUE comp, double *real, double *imag);
+  /* Return true if obj is of type XND. */
+  int rb_xnd_check_type(VALUE obj);
+  const xnd_t * rb_xnd_const_xnd(VALUE xnd);
+  VALUE rb_xnd_empty_from_type(ndt_t *t);
+  VALUE rb_xnd_from_xnd(xnd_t *x);
+  
+  typedef struct XndObject XndObject;
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif  /* RUBY_XND_H */

data/ext/ruby_xnd/ruby_xnd_internal.h

@@ -0,0 +1,85 @@
+/* BSD 3-Clause License
+ *
+ * Copyright (c) 2018, Quansight and Sameer Deshmukh
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the copyright holder nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+
+/* File containing internal declarations for Ruby XND wrapper.
+ *
+ * Author: Sameer Deshmukh (@v0dro)
+*/
+
+#ifndef RUBY_XND_INTERNAL_H
+#define RUBY_XND_INTERNAL_H
+
+//#define XND_DEBUG 1
+
+#ifdef XND_DEBUG
+#include <assert.h>
+#endif
+
+#include <float.h>
+#include "ruby.h"
+#include "ruby/encoding.h"
+#include "ruby_ndtypes.h"
+#include "ruby_xnd.h"
+#include "util.h"
+#include "float_pack_unpack.h"
+
+extern VALUE mRubyXND_GCGuard;
+
+/* typedefs */
+typedef struct XndObject XndObject;
+typedef struct MemoryBlockObject MemoryBlockObject;
+
+#include "gc_guard.h"
+
+/* macros */
+#if SIZEOF_LONG == SIZEOF_VOIDP
+# define PTR2NUM(x)   (LONG2NUM((long)(x)))
+# define NUM2PTR(x)   ((void*)(NUM2ULONG(x)))
+#elif SIZEOF_LONG_LONG == SIZEOF_VOIDP
+# define PTR2NUM(x)   (LL2NUM((LONG_LONG)(x)))
+# define NUM2PTR(x)   ((void*)(NUM2ULL(x)))
+#else
+# error ---->> ruby requires sizeof(void*) == sizeof(long) or sizeof(LONG_LONG) to be compiled. <<----
+#endif
+
+/* Convert C int 't' to Ruby 'true' or 'false'. */
+#define INT2BOOL(t) (t ? Qtrue : Qfalse)
+
+#ifdef WORDS_BIGENDIAN
+#define IEEE_BIG_ENDIAN_P 1
+#define IEEE_LITTLE_ENDIAN_P NULL
+#else
+#define IEEE_LITTLE_ENDIAN_P 1
+#define IEEE_BIG_ENDIAN_P NULL
+#endif
+
+#endif  /* RUBY_XND_INTERNAL_H */

data/ext/ruby_xnd/util.h

@@ -0,0 +1,170 @@
+/* BSD 3-Clause License
+ *
+ * Copyright (c) 2018, Quansight and Sameer Deshmukh
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the copyright holder nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+/* Utility functions for Ruby XND wrapper. 
+ * 
+ * Author: Sameer Deshmukh (@v0dro)
+ */
+
+#ifndef UTIL_H
+#define UTIL_H
+
+#include "ruby.h"
+#include <stdlib.h>
+#include <stdint.h>
+#include <inttypes.h>
+#include "ndtypes.h"
+
+/* Raise an error stored in $!. Clears it before raising. */
+inline void
+raise_error(void)
+{
+  VALUE exeception = rb_errinfo();
+
+  rb_set_errinfo(Qnil);
+  rb_exc_raise(exeception);
+}
+
+inline void
+set_error_info(VALUE err, const char * msg)
+{
+  rb_set_errinfo(rb_exc_new2(err, msg));
+}
+
+static inline size_t
+safe_downcast(int64_t size)
+{
+#if SIZE_MAX < INT64_MAX
+    if (size > INT32_MAX) {
+      rb_raise(rb_eSizeError,
+                "sizes should never exceed INT32_MAX on 32-bit platforms.");
+    }
+#endif
+    return (size_t)size;
+}
+
+static inline bool
+check_invariants(const ndt_t *t)
+{
+#if SIZE_MAX < INT64_MAX
+    return safe_downcast(t->datasize) >= 0;
+#else
+    (void)t;
+    return 1;
+#endif
+}
+
+static inline VALUE
+array_new(int64_t size)
+{
+#if SIZE_MAX < INT64_MAX
+    size_t n = safe_downcast(size);
+    return n < 0 ? NULL : rb_ary_new2(n);
+#else
+    return rb_ary_new2(size);
+#endif
+}
+
+static inline VALUE
+bytes_from_string_and_size(const char *str, int64_t size)
+{
+#if SIZE_MAX < INT64_MAX
+    size_t n = safe_downcast(size);
+    return n < 0 ? NULL : rb_str_new(str, n);
+#else
+    return rb_str_new(str, size);
+#endif
+}
+
+static long long
+mod(long long a, long long b)
+{
+    long long r = a % b;
+    return r < 0 ? r + b : r;
+}
+
+static inline int
+rb_range_unpack(VALUE range, long long *begin, long long *end, long long *step, size_t size)
+{
+  /* FIXME: As of 27 Aug. 2018 Ruby trunk implements step as a property of
+     Range and XND will support it as and when it is available. Maybe for 
+     now we can implement a #step iterator in a separate method.
+  */
+ *step = 1;
+ VALUE rb_begin = rb_funcall(range, rb_intern("begin"), 0, NULL);
+ VALUE rb_end = rb_funcall(range, rb_intern("end"), 0, NULL);
+ int exclude_end = RTEST(rb_funcall(range, rb_intern("exclude_end?"), 0, NULL));
+ 
+ if (RB_TYPE_P(rb_begin, T_FLOAT)) {
+   double value = RFLOAT_VALUE(rb_begin);
+
+   if (isinf(value)) {
+     *begin = 0;  
+   }
+ }
+ else {
+   long long temp = NUM2LL(rb_begin);
+
+   if (temp < 0) {            /* if negative index map to positive. */
+     temp = mod(temp, (long long)size);
+   }
+
+   *begin = temp;
+ }
+
+ if (RB_TYPE_P(rb_end, T_FLOAT)) {
+   double value = RFLOAT_VALUE(rb_end);
+
+   if (isinf(value)) {
+     *end = INT64_MAX;
+     return;
+   }
+ }
+ else {
+   long long temp = NUM2LL(rb_end);
+
+   if (temp < 0) {              /* if negative index map to ppositive. */
+     temp = mod(temp, (long long)size);
+   }
+   
+   *end = temp;
+ }
+
+ /* a[0..0] in Ruby returns the 0th index. 
+    a[0...0] in Ruby returns empty array like a[0:0] in Python.
+    libxnd does not include the last index by default.  
+*/
+ if (!exclude_end) {          
+   *end += 1;
+ }
+}
+
+#endif  /* UTIL_H */

data/ext/ruby_xnd/xnd/AUTHORS.txt

@@ -0,0 +1,5 @@
+
+Version 0.2.0
+-------------
+
+Stefan Krah <skrah@bytereef.org>, sponsored by Anaconda Inc. and Quansight LLC.

data/ext/ruby_xnd/xnd/INSTALL.txt

@@ -0,0 +1,134 @@
+
+
+Requirements (libndtypes)
+=========================
+
+Unless libndtypes has already been installed in the system directories,
+it is recommended to clone libndtypes into the xnd directory.
+
+
+Get ndtypes
+-----------
+git clone https://github.com/plures/ndtypes.git
+
+
+For building libxnd only
+------------------------
+cd ndtypes
+./configure
+make
+cd ..
+
+
+For building the xnd Python module
+----------------------------------
+# This also builds libndtypes and copies the ndtypes Python package into
+# the python directory next to the xnd package.
+cd ndtypes
+python3 setup.py install --local=../python
+cd ..
+
+
+Unix: libxnd build instructions
+===============================
+
+# Build
+./configure
+make
+
+# Test
+make check
+
+# Install
+make install
+
+# Clean
+make clean
+
+# Distclean
+make distclean
+
+
+Windows: libxnd build instructions
+==================================
+
+See vcbuild/INSTALL.txt.
+
+
+Unix/Windows: Python module build instructions
+==============================================
+
+To avoid shared library mismatches, the Python module builds with an rpath
+and ships the library inside the package.
+
+Unless you are a distributor with tight control over the system library
+versions, it is not recommended to install the library for the Python
+module.
+
+
+Build all
+---------
+
+# Build libxnd and the module (libxnd is copied into the package)
+python3 setup.py build
+
+# Test
+python3 setup.py test
+
+# Doctest (optional, relies on Sphinx)
+python3 setup.py doctest
+
+# Install
+python3 setup.py install
+
+# Clean libxnd and the module
+python3 setup.py distclean
+
+
+Build the module only (for developing)
+--------------------------------------
+
+First, build libxnd as above. This also copies the shared library into
+the package.  Then, to avoid rebuilding the library repeatedly, use:
+
+# Build the module
+python3 setup.py module
+
+# Clean the module
+python3 setup.py clean
+
+
+Alternative install (for developing)
+------------------------------------
+
+# Install the package into a local directory.  This is mainly useful for
+# developing gufuncs:
+python3 setup.py install --local="$PWD/../python"
+
+# Windows:
+python.exe setup.py install --local="%cd%\..\python"
+
+
+Alternative install with conda (for developing)
+-----------------------------------------------
+
+# Install the xnd package into a local directory.
+
+# Create and activate a new conda environment:
+conda create --name xnd python=3.7
+conda activate xnd
+
+# Use conda to install ndtypes (if you also want to work on ndtypes, please
+# check the project repository https://github.com/plures/ndtypes):
+conda install -c xnd/label/dev ndtypes
+
+# Use conda to install numpy (optional, some tests require the library):
+conda install numpy
+
+# Use conda to build libxnd and xnd:
+conda build .conda/libxnd -c xnd/label/dev
+conda build .conda/xnd -c xnd/label/dev
+
+# Use conda to install the local version of the library and the
+# Python module:
+conda install --use-local xnd