ndtypes 0.2.0dev6 → 0.2.0dev8

data/ext/ruby_ndtypes/ndtypes/libndtypes/grammar.y

@@ -123,8 +123,6 @@ yylex(YYSTYPE *val, YYLTYPE *loc, yyscan_t scanner, ndt_context_t *ctx)
 %type <ndt> fixed_string
 %type <ndt> bytes
 %type <ndt> fixed_bytes
-%type <ndt> array_dimensions
-%type <ndt> array
 %type <ndt> ref
 
 %type <ndt> tuple_type
@@ -225,7 +223,7 @@ datashape_with_ellipsis:
 | fixed_ellipsis                           { $$ = $1; }
 | NAME_UPPER LBRACK fixed_ellipsis RBRACK  { $$ = mk_contig($1, (ndt_t *)$3, ctx); if ($$ == NULL) YYABORT; }
 | VAR ELLIPSIS STAR dtype                  { $$ = mk_var_ellipsis($4, ctx); if ($$ == NULL) YYABORT; }
-| array_dimensions                         { $$ = $1; }
+| ARRAY ELLIPSIS STAR datashape            { $$ = mk_array_ellipsis($4, ctx); if ($$ == NULL) YYABORT; }
 
 fixed_ellipsis:
   ELLIPSIS STAR dimensions_tail            { $$ = mk_ellipsis_dim(NULL, $3, ctx); if ($$ == NULL) YYABORT; }
@@ -246,7 +244,8 @@ dimensions_nooption:
 | NAME_UPPER STAR dimensions_tail                        { $$ = mk_symbolic_dim($1, $3, ctx); if ($$ == NULL) YYABORT; }
 | VAR arguments_opt STAR dimensions_tail                 { $$ = mk_var_dim($2, $4, false, ctx); if ($$ == NULL) YYABORT; }
 | QUESTIONMARK VAR arguments_opt STAR dimensions_tail    { $$ = mk_var_dim($3, $5, true, ctx); if ($$ == NULL) YYABORT; }
-
+| ARRAY STAR datashape                                   { $$ = mk_array($3, false, ctx); if ($$ == NULL) YYABORT; }
+| QUESTIONMARK ARRAY STAR datashape                      { $$ = mk_array($4, true, ctx); if ($$ == NULL) YYABORT; }
 
 dimensions_tail:
   dtype              { $$ = $1; }
@@ -347,15 +346,6 @@ encoding:
 bytes:
   option_opt BYTES arguments_opt { $$ = mk_bytes($3, $1, ctx); if ($$ == NULL) YYABORT; }
 
-array_dimensions:
-  array                                  { $$ = $1; }
-| option_opt ARRAY ELLIPSIS OF datashape { $$ = mk_array_ellipsis($5, ctx); if ($$ == NULL) YYABORT; }
-| option_opt ARRAY ELLIPSIS OF array     { $$ = mk_array_ellipsis($5, ctx); if ($$ == NULL) YYABORT; }
-
-array:
-  option_opt ARRAY OF datashape { $$ = mk_array($4, $1, ctx); if ($$ == NULL) YYABORT; }
-| option_opt ARRAY OF array     { $$ = mk_array($4, $1, ctx); if ($$ == NULL) YYABORT; }
-
 fixed_bytes:
   option_opt FIXED_BYTES LPAREN attribute_seq RPAREN { $$ = mk_fixed_bytes($4, $1, ctx); if ($$ == NULL) YYABORT; }
 

data/ext/ruby_ndtypes/ndtypes/libndtypes/io.c

@@ -610,7 +610,7 @@ datashape(buf_t *buf, const ndt_t *t, int d, ndt_context_t *ctx)
 
             if (t->EllipsisDim.name) {
                 if (strcmp(t->EllipsisDim.name, "array") == 0) {
-                    n = ndt_snprintf(ctx, buf, "array... of ");
+                    n = ndt_snprintf(ctx, buf, "array... * ");
                 }
                 else {
                     n = ndt_snprintf(ctx, buf, "%s... * ", t->EllipsisDim.name);
@@ -628,7 +628,7 @@ datashape(buf_t *buf, const ndt_t *t, int d, ndt_context_t *ctx)
         }
 
         case Array: {
-            n = ndt_snprintf(ctx, buf, "array of ");
+            n = ndt_snprintf(ctx, buf, "array * ");
             if (n < 0) return -1;
 
             return datashape(buf, t->Array.type, d, ctx);

data/ext/ruby_ndtypes/ndtypes/libndtypes/tests/test_match.c

@@ -2384,14 +2384,14 @@ const match_testcase_t match_tests[] = {
     "!10 * 3 * 2 * float64", 0 },
 
   /* array... */
-  { "array... of float64",
+  { "array... * float64",
     "2 * 3 * float64", 0 },
 
-  { "array... of float64",
-    "array of float64", 1 },
+  { "array... * float64",
+    "array * float64", 1 },
 
-  { "array... of float64",
-    "array of array of float64", 1 },
+  { "array... * float64",
+    "array * array * float64", 1 },
 
   /* END MANUALLY GENERATED */
 

data/ext/ruby_ndtypes/ndtypes/libndtypes/tests/test_parse.c

@@ -45,8 +45,8 @@ const char *parse_tests[] = {
   "10 * L * Any",
   "10 * 10 * L * Any",
   "var * Any",
-  "array of Any",
-  "array of array of Any",
+  "array * Any",
+  "array * array * Any",
   "... * Any",
   "10 * Any",
   "Any",
@@ -259,26 +259,26 @@ const char *parse_tests[] = {
   "1286044356 * LbR6JPFI * 2096958782 * uint8",
   "categorical(-507014936.36, -25910, 'xM3Mys0XqH', 4265882500)",
   "var * var * FixedBytesKind",
-  "array of FixedBytesKind",
-  "array of array of FixedBytesKind",
+  "array * FixedBytesKind",
+  "array * array * FixedBytesKind",
   "var * var * var * fixed_bytes(size=2816010912, align=16)",
-  "array of fixed_bytes(size=2816010912, align=16)",
+  "array * fixed_bytes(size=2816010912, align=16)",
   "36 * 16 * fixed_bytes(size=912328236, align=2)",
   "var * var * float64",
-  "array of float64",
+  "array * float64",
   "var * var * var * ZcTmBXnKPi",
-  "array of ZcTmBXnKPi",
+  "array * ZcTmBXnKPi",
   "categorical('omhwkoWVWw', 43, 946986991)",
   "var * float32",
   "var * var * var * uint16",
   "var * var * var * ScalarKind",
-  "array of ScalarKind",
+  "array * ScalarKind",
   "fixed_bytes(size=280180380, align=2)",
   "fixed_string(1901614748, 'utf-32')",
   "var * M7",
   "var * bytes(align=2)",
   "var * var * ULy8(char)",
-  "array of ULy8(char)",
+  "array * ULy8(char)",
   "fixed_bytes(size=1882259744, align=16)",
   "categorical(-136747211.015, -58, -83)",
   "3739637665 * 1476113530 * 1701021063 * IKd * 450514382 * WXn",
@@ -286,7 +286,7 @@ const char *parse_tests[] = {
   "var * R8KFFEabJ",
   "var * QoFb",
   "var * fixed_string(1233383142, 'utf-32')",
-  "array of fixed_string(1233383142, 'utf-32')",
+  "array * fixed_string(1233383142, 'utf-32')",
   "fixed_bytes(size=2882797968, align=4)",
   "fixed_bytes(size=1233209904, align=8)",
   "WhRsMHHXYp(categorical(145))",
@@ -349,7 +349,7 @@ const char *parse_tests[] = {
   "2 * 3  * ThisRecord of {first: (int64, complex128), second: string}",
   "2 * 3  * ThisRecord of {first: (int64, complex128), second: string} | ThatTuple of (bytes, string)",
   "2 * 3  * Int of int64 | ThisRecord of {first: (int64, complex128), second: string} | ThatTuple of (bytes, string)",
-  "array of Int of int64 | ThisRecord of {first: (int64, complex128), second: uint8} | ThatTuple of (float64, float64)",
+  "array * Int of int64 | ThisRecord of {first: (int64, complex128), second: uint8} | ThatTuple of (float64, float64)",
 
   "fixed(shape=10) * complex128",
 
@@ -377,7 +377,7 @@ const char *parse_tests[] = {
 
   /* var..., array... */
   "var... * (int8, int64)",
-  "array... of (int8, int64)",
+  "array... * (int8, int64)",
 
   /* END MANUALLY GENERATED */
 

data/ext/ruby_ndtypes/ndtypes/libndtypes/tests/test_parse_error.c

@@ -396,7 +396,7 @@ const char *parse_error_tests[] = {
   "?[10 * 10 $ X * Any$",
   "?[10 * 10 $ X * Any$",
   "$var * Any",
-  "$array of Any",
+  "$array * Any",
   "=var * Any",
   "$[var * Any]",
   "xxx[var * Any]",
@@ -27748,13 +27748,13 @@ const char *parse_error_tests[] = {
   "fixed_bytes(1342281638, align=xxx)",
   "Y5vtk * var * 905934102 * 1310846899 * fixed[3359714476] * LKgwlEDf * 2822334059 * ; PKI_8Ob8(fixed_string(795133707))",
   "?(E00Lr_HMM * ... * UAzC * var * M4nJaK * , var * var * 1002912577 * PZPD)",
-  "?(E00Lr_HMM * ... * UAzC * array of M4nJaK * , array of array of 1002912577 * PZPD)",
+  "?(E00Lr_HMM * ... * UAzC * array * M4nJaK * , array * array * 1002912577 * PZPD)",
   "?ref(fixed_string(3865363101, 'ucs-10'))",
   "fixed[3622391868] * SUc9IusL * CaPaWth4m * CEwSPY_6Z * HPW * SbvgP * 29709a97707 * 1300296096 * Fixed * VA8O",
   "fixed[1603107638)] * 2764230114 * IRXLe * Odlw6RSx * ... * Fixed * var * 2484716214 * ScalarKind",
-  "fixed[1603107638)] * 2764230114 * IRXLe * Odlw6RSx * ... * Fixed * array of 2484716214 * ScalarKind",
+  "fixed[1603107638)] * 2764230114 * IRXLe * Odlw6RSx * ... * Fixed * array * 2484716214 * ScalarKind",
   "ZmQxcy * var * 1098824011 * var * var * (,,,)",
-  "ZmQxcy * array of 1098824011 of array of array * (,,,)",
+  "ZmQxcy * array * 1098824011 * array * array * (,,,)",
   "ref(?x1869144321 * Y3_Dm0 * int32)",
   "categorical[\"a\", 1619552300, 490620000000000000000000000000000000000000, 18772, -84, 'l']",
   "?fixed[2889099917] * ... * var * JgdIXy5M * var * Wr2[categorical['gLsA7BM43V', 16460]]",
@@ -27762,7 +27762,7 @@ const char *parse_error_tests[] = {
   "?var * Fixed * FdN_HERKv * 4204012258 * var * fixed[233758212000000000000000000000000000] * Fixed * FixedBytesKind",
   "?categorical[30987, -16536, -270032755.642, -189, -823800099]",
   "?Fixed * 1998811088 * var * var * var * var * bytes(align=-58)",
-  "?Fixed * 1998811088 * array of array of array of array of bytes(align=-58)",
+  "?Fixed * 1998811088 * array * array * array * array * bytes(align=-58)",
   "257051452 * QRgi * Fixed * 4147849906 * var * P4h8i8 * var * 3924618173 * fixed[207255421] * int100",
   "categorical[408786241.474, 2840608325, 44038, 1763886348, \"jOt', 24]",
   "?[OQ78AW32d[categorical[49]%]",
@@ -27866,9 +27866,9 @@ const char *parse_error_tests[] = {
 
   /* var... and array... */
   "var... of float64",
-  "var... * (int64, str)",
-  "array... * float64",
-  "array... * (int64, str)",
+  "var... of (int64, str)",
+  "array... of float64",
+  "array... of (int64, str)",
   /* END MANUALLY GENERATED */
 
   NULL

data/ext/ruby_ndtypes/ndtypes/libndtypes/tests/test_parse_roundtrip.c

@@ -276,7 +276,7 @@ const char *parse_roundtrip_tests[] = {
   /* BEGIN RANDOM */
   "fixed_bytes(size=1342281600, align=16)",
   "var * var * var * (...)",
-  "array of (...)",
+  "array * (...)",
   "categorical(-84, 18772, 49062, 1619552300, 'a', 'l')",
   "categorical(24, 44038, 1763886348, 2840608325, 1.2e-32, 'jOt')",
   "categorical(-2049848438, 94, 3577056037, 3599739756, 1.2e-32)",
@@ -284,15 +284,15 @@ const char *parse_roundtrip_tests[] = {
   "1286044356 * LbR6JPFI * 2096958782 * uint8",
   "categorical(-25910, 4265882500, 1.2e-32, 'xM3Mys0XqH')",
   "var * var * FixedBytesKind",
-  "array of FixedBytesKind",
+  "array * FixedBytesKind",
   "var * var * var * fixed_bytes(size=2816010912, align=16)",
   "36 * 16 * fixed_bytes(size=912328236, align=2)",
   "var * var * var * ZcTmBXnKPi",
   "categorical(946986991, 43, 'omhwkoWVWw')",
   "var * float32",
-  "array of float32",
+  "array * float32",
   "var * var * var * uint16",
-  "array of uint16",
+  "array * uint16",
   "var * var * var * ScalarKind",
   "fixed_bytes(size=280180300, align=2)",
   "fixed_string(1901614748, 'utf32')",
@@ -308,7 +308,7 @@ const char *parse_roundtrip_tests[] = {
   "fixed_bytes(size=1233209904, align=8)",
   "WhRsMHHXYp(categorical(145))",
   "var * var * bytes(align=2)",
-  "array of fixed_bytes(size=2882797900, align=2)",
+  "array * fixed_bytes(size=2882797900, align=2)",
   "categorical(-85, -49, -26791, 8094, 1780, 1.2e-32, 'pX')",
   "D6nfBg_(categorical(16278, 26651, 147170982, 1.2e-32, 'ylR7'))",
   "categorical(482331467, 3229733591, -1.2e-32, 1.2e-32)",
@@ -358,7 +358,7 @@ const char *parse_roundtrip_tests[] = {
 
   /* var... and array... */
   "var... * float64",
-  "array... of float64",
+  "array... * float64",
 
   /* END MANUALLY GENERATED */
 

data/ext/ruby_ndtypes/ndtypes/libndtypes/tests/test_typecheck.c

@@ -801,28 +801,28 @@ const typecheck_testcase_t typecheck_tests[] = {
   { .loc = loc(),
     .success=true,
 
-    .signature="array... of float64 -> array... of int64",
-    .args={"array of float64"},
+    .signature="array... * float64 -> array... * int64",
+    .args={"array * float64"},
     .kwargs={NULL},
 
     .outer_dims=1,
     .nin=1,
     .nout=1,
     .nargs=2,
-    .types={ "array of float64", "array of int64" } },
+    .types={ "array * float64", "array * int64" } },
 
   { .loc = loc(),
     .success=true,
 
-    .signature="array... of array of float64, array... of uint8 -> array... of array of int64",
-    .args={"array of array of float64", "array of uint8"},
+    .signature="array... * array * float64, array... * uint8 -> array... * array * int64",
+    .args={"array * array * float64", "array * uint8"},
     .kwargs={NULL},
 
     .outer_dims=1,
     .nin=2,
     .nout=1,
     .nargs=3,
-    .types={ "array of array of float64", "array of uint8", "array of array of int64" } },
+    .types={ "array * array * float64", "array * uint8", "array * array * int64" } },
 
   { .loc=NULL, .success=false, .signature= NULL, .args={NULL}, .kwargs={NULL} }
 };

data/ext/ruby_ndtypes/ndtypes/python/ndtypes/_ndtypes.c

@@ -229,7 +229,7 @@ from_string(PyObject *v)
         return NULL;
     }
 
-   return t;
+    return t;
 }
 
 static PyObject *
@@ -1100,7 +1100,7 @@ static PyMethodDef ndtype_methods [] =
   /* Boolean functions on array types */
   { "is_c_contiguous", (PyCFunction)ndtype_ndt_is_c_contiguous, METH_NOARGS, doc_is_c_contiguous },
   { "is_f_contiguous", (PyCFunction)ndtype_ndt_is_f_contiguous, METH_NOARGS, doc_is_f_contiguous },
-  { "is_var_contiguous", (PyCFunction)dtype_ndt_is_var_contiguous, METH_NOARGS, NULL },
+  { "is_var_contiguous", (PyCFunction)ndtype_ndt_is_var_contiguous, METH_NOARGS, NULL },
 
   /* Binary functions */
   { "at", (PyCFunction)ndtype_at, METH_VARARGS|METH_KEYWORDS, NULL },

data/ext/ruby_ndtypes/ndtypes/python/test_ndtypes.py

@@ -601,10 +601,11 @@ class TestEllipsisDim(unittest.TestCase):
         self.assertRaises(TypeError, getattr, t, 'shape')
         self.assertRaises(TypeError, getattr, t, 'strides')
 
+
 class TestArray(unittest.TestCase):
 
     def test_array_predicates(self):
-        t = ndt("array of complex128")
+        t = ndt("array * complex128")
         check_serialize(self, t)
 
         self.assertFalse(t.isabstract())
@@ -621,7 +622,7 @@ class TestArray(unittest.TestCase):
 
     def test_array_dim_common_fields(self):
         dt = "{a: complex64, b: float64}"
-        t = ndt("array of %s" % dt)
+        t = ndt("array * %s" % dt)
         check_serialize(self, t)
         dtype = ndt(dt)
 
@@ -637,8 +638,25 @@ class TestArray(unittest.TestCase):
 
     def test_array_invariants(self):
         # Mixing array with fixed/var dimensions is disallowed.
-        self.assertRaises(TypeError, ndt, "array of 2 * int64")
-        self.assertRaises(TypeError, ndt, "array of var * int64")
+        self.assertRaises(TypeError, ndt, "array * 2 * int64")
+        self.assertRaises(TypeError, ndt, "array * var * int64")
+
+    def test_array_geojson(self):
+        typedef("id", """
+          String of string
+        | Int of int64
+        """)
+
+        typedef("position", "array * float64")
+
+        typedef("geometry", """
+          Point of position
+        | MultiPoint of array * position
+        | LineString of array * position
+        | MultiLineString of array * array * position
+        | Polygon of array * position
+        | MultiPolygon of array * array * position
+        """)
 
 
 class TestTuple(unittest.TestCase):

data/ext/ruby_ndtypes/ruby_ndtypes.c

@@ -12,7 +12,6 @@ static const rb_data_type_t NdtObject_type;
 /* Class declarations. */
 VALUE cNDTypes;
 VALUE mNDTypes_GCGuard;
-static VALUE cNDTypes_RBuf;
 
 static VALUE rb_eValueError;
 
@@ -941,36 +940,29 @@ rb_ndtypes_from_type(const ndt_t *type)
   return self;
 }
 
-/* Return 1 if obj is of type NDTypes. 0 otherwise. */
 int
 rb_ndtypes_check_type(VALUE obj)
 {
   return NDT_CHECK_TYPE(obj);
 }
 
-/* Get a pointer to the NdtObject struct that is contained within obj. */
 NdtObject *
 rb_ndtypes_get_ndt_object(VALUE obj)
 {
   NdtObject *ndt_p;
-
   if (!NDT_CHECK_TYPE(obj)) {
     /* raise error */
   }
-  
   GET_NDT(obj, ndt_p);
-
   return ndt_p;
 }
 
-/* Get an allocated Ruby object of type NDTypes. ndt_p should have been allocated already. */
 VALUE
 rb_ndtypes_make_ndt_object(NdtObject *ndt_p)
 {
   return MAKE_NDT(cNDTypes, ndt_p);
 }
 
-/* Perform allocation and get a Ruby object of type NDTypes. */
 VALUE
 rb_ndtypes_wrap_ndt_object(void)
 {
@@ -979,7 +971,6 @@ rb_ndtypes_wrap_ndt_object(void)
   return WRAP_NDT(cNDTypes, ndt_p);
 }
 
-/* Get pointer to the internal ndt_t object from the NDTypes Ruby object ndt. */
 const ndt_t *
 rb_ndtypes_const_ndt(VALUE ndt)
 {
@@ -994,11 +985,6 @@ rb_ndtypes_const_ndt(VALUE ndt)
   return ndt_p->ndt;
 }
 
-/* Function for taking a source type and moving it accross the subtree.
-
-   @param src NDTypes Ruby object of the source XND object.
-   @param t Pointer to type of the view of XND object.
-*/
 VALUE
 rb_ndtypes_move_subtree(VALUE src, ndt_t *t)
 {
@@ -1021,11 +1007,6 @@ rb_ndtypes_move_subtree(VALUE src, ndt_t *t)
   return dest;
 }
 
-/* Create NDT object from String. Returns the same object if type is NDT. 
-   
-   @param type String object containing description of type.
-   @return New NDT object.
-*/
 VALUE
 rb_ndtypes_from_object(VALUE type)
 {
@@ -1073,7 +1054,6 @@ void Init_ruby_ndtypes(void)
 
   /* define classes */
   cNDTypes = rb_define_class("NDTypes", rb_cObject);
-  cNDTypes_RBuf = rb_define_class_under(cNDTypes, "RBuf", rb_cObject);
   mNDTypes_GCGuard = rb_define_module_under(cNDTypes, "GCGuard");
 
   /* errors */

data/ext/ruby_ndtypes/ruby_ndtypes.h

@@ -18,14 +18,104 @@ extern "C" {
 typedef struct NdtObject NdtObject;
 extern VALUE cNDTypes;
 
+/**
+ * @brief    Return 1 if obj is of type NDTypes. 0 otherwise.
+ *
+ * @param    obj Ruby object whose type has to be checked.
+ *
+ * @return   Boolean value whether it is NDT object or not.
+ */
+
 int rb_ndtypes_check_type(VALUE obj);
+
+/**
+ * @brief    Get a pointer to the NdtObject struct that obj contains.
+ *
+ * @details  This function unwraps the Ruby object obj passed to it and
+ * returns a pointer to the `NdtObject` struct that is contained within it.
+ * You must passed an NDT Ruby object.
+ *
+ * @param    obj Ruby object of type NDT.
+ *
+ * @return   Pointer to the NdtObject encapsulated within the Ruby object.
+ */
 NdtObject * rb_ndtypes_get_ndt_object(VALUE obj);
+
+/**
+ * @brief    Calls TypedData_Make_Struct and returns a Ruby object wrapping over ndt_p.
+ *
+ * @details  This function calls the TypedData_Make_Struct macro from the Ruby
+ * C API for wrapping over argument passed to it. The ndt_p pointer must be allocated
+ * and data assingned to its contents before calling this function.
+ *
+ * @param    ndt_p Pointer to NdtObject allocated by the caller.
+ *
+ * @return   Ruby object wrapping over NdtObject.
+ */
 VALUE rb_ndtypes_make_ndt_object(NdtObject *ndt_p);
+
+/**
+ * @brief    Perform allocation using TypedData_Wrap_Struct and return a Ruby NDT object.
+ *
+ * @details  This function does not set any of the data within the struct and assigns
+ * the NdtObject struct within the Ruby object to NULL. For allocating an already allocated
+ * NdtObject within a Ruby object use the rb_ndtypes_make_ndt_object() function.
+ *
+ * @return   NDT Ruby object.
+ */
 VALUE rb_ndtypes_wrap_ndt_object(void);
+
+/**
+ * @brief    Unwrap the Ruby object ndt and return the pointer to ndt_t placed within it.
+ *
+ * @param    ndt Ruby NDT object.
+ *
+ * @return   Pointer to ndt_t type wrapped within the passed Ruby object.
+ */
 const ndt_t * rb_ndtypes_const_ndt(VALUE ndt);
+
+/**
+ * @brief    Function for taking a source type and moving it across the subtree.
+ *
+ * @param    src NDTypes Ruby object of the source XND object.
+ * @param    t Pointer to type of the view of XND object.
+ *
+ * @return   NDT Ruby object of the moved subtree.
+ */
 VALUE rb_ndtypes_move_subtree(VALUE src, ndt_t *t);
+
+/**
+ * @brief    Create NDT object from Ruby String. Returns the same object if type is NDT.
+ * If you pass a String as an argument, read the string and create an NDT from it.
+ *
+ * @param    type Ruby object. Can be Ruby String or NDT object.
+ *
+ * @return   Ruby object of type NDT.
+ */
 VALUE rb_ndtypes_from_object(VALUE type);
+
+/**
+ * @brief    Make Ruby aware of the error condition raised by libndtypes by using
+ * the set_error_info() Ruby C API function.
+ *
+ * @param    ctx Struct of type ndt_context_t.
+ *
+ * @return   Ruby error class object.
+ */
+
 VALUE rb_ndtypes_set_error(ndt_context_t *ctx);
+
+/**
+ * @brief    Create an NDT Ruby object from an ndt_t struct.
+ *
+ * @details  The caller can use this function for creating a Ruby NDT
+ * object from a ndt_t struct that has already been allocated using one
+ * of the allocation functions from libndtypes like ndt_from_string().
+ *
+ * @param    type An allocated pointer to a struct of type ndt_t.
+ *
+ * @return   Ruby object of type NDT.
+ */
 VALUE rb_ndtypes_from_type(const ndt_t *type);
 
 #define INT2BOOL(t) (t ? Qtrue : Qfalse)