Struct arrow::array::DictionaryArray [−][src]
pub struct DictionaryArray<K: ArrowPrimitiveType> { /* fields omitted */ }
A dictionary array where each element is a single value indexed by an integer key. This is mostly used to represent strings or a limited set of primitive types as integers, for example when doing NLP analysis or representing chromosomes by name.
Example with nullable data:
use arrow::array::{DictionaryArray, Int8Array}; use arrow::datatypes::Int8Type; let test = vec!["a", "a", "b", "c"]; let array : DictionaryArray<Int8Type> = test.iter().map(|&x| if x == "b" {None} else {Some(x)}).collect(); assert_eq!(array.keys(), &Int8Array::from(vec![Some(0), Some(0), None, Some(1)]));
Example without nullable data:
use arrow::array::{DictionaryArray, Int8Array}; use arrow::datatypes::Int8Type; let test = vec!["a", "a", "b", "c"]; let array : DictionaryArray<Int8Type> = test.into_iter().collect(); assert_eq!(array.keys(), &Int8Array::from(vec![0, 0, 1, 2]));
Implementations
impl<'a, K: ArrowPrimitiveType> DictionaryArray<K>
[src]
impl<'a, K: ArrowPrimitiveType> DictionaryArray<K>
[src]pub fn keys(&self) -> &PrimitiveArray<K>
[src]
Return an iterator to the keys of this dictionary.
pub fn keys_array(&self) -> PrimitiveArray<K>
[src]
Returns an array view of the keys of this dictionary
pub fn lookup_key(&self, value: &str) -> Option<K::Native>
[src]
Returns the lookup key by doing reverse dictionary lookup
pub fn values(&self) -> ArrayRef
[src]
Returns an ArrayRef
to the dictionary values.
pub fn value_type(&self) -> DataType
[src]
Returns a clone of the value type of this list.
pub fn len(&self) -> usize
[src]
The length of the dictionary is the length of the keys array.
pub fn is_empty(&self) -> bool
[src]
Whether this dictionary is empty
pub fn is_ordered(&self) -> bool
[src]
Trait Implementations
impl<T: ArrowPrimitiveType> Array for DictionaryArray<T>
[src]
impl<T: ArrowPrimitiveType> Array for DictionaryArray<T>
[src]fn as_any(&self) -> &dyn Any
[src]
fn data(&self) -> &ArrayData
[src]
fn get_buffer_memory_size(&self) -> usize
[src]
fn get_array_memory_size(&self) -> usize
[src]
fn data_ref(&self) -> &ArrayData
[src]
fn data_type(&self) -> &DataType
[src]
fn slice(&self, offset: usize, length: usize) -> ArrayRef
[src]
fn len(&self) -> usize
[src]
fn is_empty(&self) -> bool
[src]
fn offset(&self) -> usize
[src]
fn is_null(&self, index: usize) -> bool
[src]
fn is_valid(&self, index: usize) -> bool
[src]
fn null_count(&self) -> usize
[src]
fn to_raw(&self) -> Result<(*const FFI_ArrowArray, *const FFI_ArrowSchema)>
[src]
impl<T: ArrowPrimitiveType> Debug for DictionaryArray<T>
[src]
impl<T: ArrowPrimitiveType> Debug for DictionaryArray<T>
[src]impl<T: ArrowPrimitiveType> From<ArrayData> for DictionaryArray<T>
[src]
impl<T: ArrowPrimitiveType> From<ArrayData> for DictionaryArray<T>
[src]Constructs a DictionaryArray
from an array data reference.
impl<'a, T: ArrowPrimitiveType + ArrowDictionaryKeyType> FromIterator<&'a str> for DictionaryArray<T>
[src]
impl<'a, T: ArrowPrimitiveType + ArrowDictionaryKeyType> FromIterator<&'a str> for DictionaryArray<T>
[src]Constructs a DictionaryArray
from an iterator of strings.
fn from_iter<I: IntoIterator<Item = &'a str>>(iter: I) -> Self
[src]
impl<'a, T: ArrowPrimitiveType + ArrowDictionaryKeyType> FromIterator<Option<&'a str>> for DictionaryArray<T>
[src]
impl<'a, T: ArrowPrimitiveType + ArrowDictionaryKeyType> FromIterator<Option<&'a str>> for DictionaryArray<T>
[src]Constructs a DictionaryArray
from an iterator of optional strings.
fn from_iter<I: IntoIterator<Item = Option<&'a str>>>(iter: I) -> Self
[src]
impl<T: ArrowPrimitiveType> JsonEqual for DictionaryArray<T>
[src]
impl<T: ArrowPrimitiveType> JsonEqual for DictionaryArray<T>
[src]Auto Trait Implementations
impl<K> !RefUnwindSafe for DictionaryArray<K>
impl<K> !RefUnwindSafe for DictionaryArray<K>
impl<K> Send for DictionaryArray<K>
impl<K> Send for DictionaryArray<K>
impl<K> Sync for DictionaryArray<K>
impl<K> Sync for DictionaryArray<K>
impl<K> Unpin for DictionaryArray<K>
impl<K> Unpin for DictionaryArray<K>
impl<K> !UnwindSafe for DictionaryArray<K>
impl<K> !UnwindSafe for DictionaryArray<K>