Class ArrayData

Namespace

Apache.Arrow

Assembly

Apache.Arrow.dll

public sealed class ArrayData : IDisposable

Inheritance

object

ArrayData

Implements

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ArrayData(IArrowType, int, int, int, ArrowBuffer[], ArrayData[])

public ArrayData(IArrowType dataType, int length, int nullCount, int offset, ArrowBuffer[] buffers, ArrayData[] children)

Parameters

dataType IArrowType

length int

nullCount int

offset int

buffers ArrowBuffer[]

children ArrayData[]

ArrayData(IArrowType, int, int, int, ArrowBuffer[], ArrayData[], ArrayData)

public ArrayData(IArrowType dataType, int length, int nullCount = 0, int offset = 0, ArrowBuffer[] buffers = null, ArrayData[] children = null, ArrayData dictionary = null)

Parameters

dataType IArrowType

length int

nullCount int

offset int

buffers ArrowBuffer[]

children ArrayData[]

dictionary ArrayData

ArrayData(IArrowType, int, int, int, IEnumerable<ArrowBuffer>, IEnumerable<ArrayData>)

public ArrayData(IArrowType dataType, int length, int nullCount, int offset, IEnumerable<ArrowBuffer> buffers, IEnumerable<ArrayData> children)

Parameters

dataType IArrowType

length int

nullCount int

offset int

buffers IEnumerable<ArrowBuffer>

children IEnumerable<ArrayData>

ArrayData(IArrowType, int, int, int, IEnumerable<ArrowBuffer>, IEnumerable<ArrayData>, ArrayData)

public ArrayData(IArrowType dataType, int length, int nullCount = 0, int offset = 0, IEnumerable<ArrowBuffer> buffers = null, IEnumerable<ArrayData> children = null, ArrayData dictionary = null)

Parameters

dataType IArrowType

length int

nullCount int

offset int

buffers IEnumerable<ArrowBuffer>

children IEnumerable<ArrayData>

dictionary ArrayData

Fields

Buffers

public readonly ArrowBuffer[] Buffers

Field Value

ArrowBuffer[]

Children

public readonly ArrayData[] Children

Field Value

ArrayData[]

DataType

public readonly IArrowType DataType

Field Value

IArrowType

Dictionary

public readonly ArrayData Dictionary

Field Value

ArrayData

Length

public readonly int Length

Field Value

int

NullCount

The number of null values in the Array. May be -1 if the null count has not been computed.

public int NullCount

Field Value

int

Offset

public readonly int Offset

Field Value

int

Methods

Clone(MemoryAllocator)

public ArrayData Clone(MemoryAllocator allocator = null)

Parameters

allocator MemoryAllocator

Returns

ArrayData

Dispose()

public void Dispose()

GetNullCount()

Get the number of null values in the Array, computing the count if required.

public int GetNullCount()

Returns

int

Retain()

Retain this ArrayData with shared ownership. The returned ArrayData keeps the underlying buffers alive via reference counting, and recursively retains any children and dictionary. The caller must dispose the returned ArrayData when done.

public ArrayData Retain()

Returns

ArrayData

Slice(int, int)

Slice this ArrayData without ownership tracking. The returned slice shares the underlying buffers but does not keep them alive — the caller must ensure the original ArrayData outlives the slice. Consider using SliceShared(int, int) instead, which uses reference counting to keep the underlying buffers alive for the lifetime of the slice.

public ArrayData Slice(int offset, int length)

Parameters

offset int

length int

Returns

ArrayData

SliceShared(int, int)

Slice this ArrayData with shared ownership. The returned slice keeps the underlying buffers alive via reference counting. The caller must dispose the returned ArrayData when done.

public ArrayData SliceShared(int offset, int length)

Parameters

offset int

length int

Returns

ArrayData