Add Subarray getter APIs for dimension labels.

Author: teo-tsirpanis

sources/TileDB.CSharp/Subarray.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 using System.Runtime.CompilerServices;
 using System.Runtime.InteropServices;
 using TileDB.CSharp.Marshalling;
@@ -306,6 +306,83 @@ public void AddRange(string dimensionName, string start, string end)
             _ctx.handle_error(Methods.tiledb_subarray_add_range_var_by_name(ctxHandle, handle, ms_name, ms_start, (ulong)ms_start.Length, ms_end, (ulong)ms_end.Length));
         }
 
+        /// <summary>
+        /// Gets the name of the dimension label for label ranges set on this dimension of the <see cref="Subarray"/>.
+        /// </summary>
+        /// <param name="dimensionIndex">The dimension's index.</param>
+        /// <remarks>This API is experimental and subject to breaking changes without advance notice.</remarks>
+        public string GetLabelName(uint dimensionIndex)
+        {
+            using var ctxHandle = _ctx.Handle.Acquire();
+            using var handle = _handle.Acquire();
+            sbyte* result;
+            _ctx.handle_error(Methods.tiledb_subarray_get_label_name(ctxHandle, handle, dimensionIndex, &result));
+            return MarshaledStringOut.GetStringFromNullTerminated(result);
+        }
+
+        /// <summary>
+        /// Gets the range for a given dimension label and range index.
+        /// </summary>
+        /// <typeparam name="T">The dimension label's type.</typeparam>
+        /// <param name="labelName">The dimension label's name.</param>
+        /// <param name="rangeIndex">The range's index.</param>
+        /// <returns>The dimension's start and end values.</returns>
+        /// <exception cref="NotSupportedException"><typeparamref name="T"/> is not supported.</exception>
+        /// <remarks>This API is experimental and subject to breaking changes without advance notice.</remarks>
+        public (T Start, T End) GetLabelRange<T>(string labelName, uint rangeIndex) where T : struct
+        {
+            ValidateLabelType<T>(labelName);
+            using var ctxHandle = _ctx.Handle.Acquire();
+            using var handle = _handle.Acquire();
+            using var ms_dimensionName = new MarshaledString(labelName);
+            void* startPtr, endPtr, stridePtr_unused;
+            _ctx.handle_error(Methods.tiledb_subarray_get_label_range(ctxHandle, handle, ms_dimensionName, rangeIndex, &startPtr, &endPtr, &stridePtr_unused));
+            return (Unsafe.ReadUnaligned<T>(startPtr), Unsafe.ReadUnaligned<T>(endPtr));
+        }
+
+        /// <summary>
+        /// Gets the string range for a given dimension label and range index.
+        /// </summary>
+        /// <param name="labelName">The dimension label's name.</param>
+        /// <param name="rangeIndex">The range's index.</param>
+        /// <returns>The dimension's start and end values.</returns>
+        /// <remarks>This API is experimental and subject to breaking changes without advance notice.</remarks>
+        public (string Start, string End) GetStringLabelRange(string labelName, uint rangeIndex)
+        {
+            using var ctxHandle = _ctx.Handle.Acquire();
+            using var handle = _handle.Acquire();
+            using var ms_dimensionName = new MarshaledString(labelName);
+            ulong start_size;
+            ulong end_size;
+            _ctx.handle_error(Methods.tiledb_subarray_get_label_range_var_size(ctxHandle, handle, ms_dimensionName, rangeIndex, &start_size, &end_size));
+
+            using var startBuffer = new ScratchBuffer<byte>(checked((int)start_size), stackalloc byte[128]);
+            using var endBuffer = new ScratchBuffer<byte>(checked((int)end_size), stackalloc byte[128]);
+            fixed (byte* startPtr = startBuffer, endPtr = endBuffer)
+            {
+                _ctx.handle_error(Methods.tiledb_subarray_get_label_range_var(ctxHandle, handle, ms_dimensionName, rangeIndex, startPtr, endPtr));
+            }
+
+            var startStr = MarshaledStringOut.GetString(startBuffer.Span);
+            var endStr = MarshaledStringOut.GetString(endBuffer.Span);
+            return (startStr, endStr);
+        }
+
+        /// <summary>
+        /// Gets the number of ranges for a given dimension label name.
+        /// </summary>
+        /// <param name="labelName">The dimension label's name.</param>
+        /// <remarks>This API is experimental and subject to breaking changes without advance notice.</remarks>
+        public ulong GetLabelRangeCount(string labelName)
+        {
+            using var ctxHandle = _ctx.Handle.Acquire();
+            using var handle = _handle.Acquire();
+            using var ms_dimensionName = new MarshaledString(labelName);
+            ulong result;
+            _ctx.handle_error(Methods.tiledb_subarray_get_label_range_num(ctxHandle, handle, ms_dimensionName, &result));
+            return result;
+        }
+
         /// <summary>
         /// Gets the number of ranges for a given dimension index.
         /// </summary>
@@ -422,5 +499,19 @@ public ulong GetRangeCount(string dimensionName)
             var endStr = MarshaledStringOut.GetString(endBuffer.Span);
             return (startStr, endStr);
         }
+
+        /// <summary>
+        /// Checks whether the <see cref="Subarray"/> has label ranges set on the requested dimension.
+        /// </summary>
+        /// <param name="dimensionIndex">The dimension's index.</param>
+        /// <remarks>This API is experimental and subject to breaking changes without advance notice.</remarks>
+        public bool HasLabelRanges(uint dimensionIndex)
+        {
+            using var ctxHandle = _ctx.Handle.Acquire();
+            using var handle = _handle.Acquire();
+            int result;
+            _ctx.handle_error(Methods.tiledb_subarray_has_label_ranges(ctxHandle, handle, dimensionIndex, &result));
+            return result != 0;
+        }
     }
 }