Struct polars_core::datatypes::Logical

pub struct Logical<Logical: PolarsDataType, Physical: PolarsDataType>(pub ChunkedArray<Physical>, _, pub Option<DataType>);

Maps a logical type to a a chunked array implementation of the physical type. This saves a lot of compiler bloat and allows us to reuse functionality.

Tuple Fields

0: ChunkedArray<Physical>

2: Option<DataType>

Implementations

impl<K: PolarsDataType, T: PolarsDataType> Logical<K, T>

pub fn new_logical<J: PolarsDataType>(ca: ChunkedArray<T>) -> Logical<J, T>

impl<K: PolarsDataType, T: PolarsDataType> Logical<K, T>where
    Self: LogicalType,

pub fn field(&self) -> Field

impl Logical<DateType, Int32Type>

pub fn as_date_iter(
    &self
) -> impl Iterator<Item = Option<NaiveDate>> + TrustedLen + '_

Available on (crate features temporal or dtype-datetime or dtype-date) and crate feature dtype-date only.

pub fn from_naive_date<I: IntoIterator<Item = NaiveDate>>(
    name: &str,
    v: I
) -> Self

Available on (crate features temporal or dtype-datetime or dtype-date) and crate feature dtype-date only.

Construct a new DateChunked from an iterator over NaiveDate.

pub fn strftime(&self, fmt: &str) -> Utf8Chunked

Available on (crate features temporal or dtype-datetime or dtype-date) and crate feature dtype-date only.

Format Date with a fmt rule. See chrono strftime/strptime.

pub fn from_naive_date_options<I: IntoIterator<Item = Option<NaiveDate>>>(
    name: &str,
    v: I
) -> Self

Available on (crate features temporal or dtype-datetime or dtype-date) and crate feature dtype-date only.

Construct a new DateChunked from an iterator over optional NaiveDate.

impl Logical<DatetimeType, Int64Type>

pub fn as_datetime_iter(
    &self
) -> impl Iterator<Item = Option<NaiveDateTime>> + TrustedLen + '_

Available on (crate features temporal or dtype-datetime or dtype-date) and crate feature dtype-datetime only.

pub fn time_unit(&self) -> TimeUnit

Available on (crate features temporal or dtype-datetime or dtype-date) and crate feature dtype-datetime only.

pub fn time_zone(&self) -> &Option<TimeZone>

Available on (crate features temporal or dtype-datetime or dtype-date) and crate feature dtype-datetime only.

pub fn apply_on_tz_corrected<F>(&self, func: F) -> PolarsResult<DatetimeChunked>where
    F: FnMut(DatetimeChunked) -> PolarsResult<DatetimeChunked>,

Available on (crate features temporal or dtype-datetime or dtype-date) and crate feature dtype-datetime only.

pub fn cast_time_zone(&self, tz: &str) -> PolarsResult<DatetimeChunked>

Available on (crate features temporal or dtype-datetime or dtype-date) and crate feature dtype-datetime and crate feature timezones only.

pub fn strftime(&self, fmt: &str) -> Utf8Chunked

Available on (crate features temporal or dtype-datetime or dtype-date) and crate feature dtype-datetime only.

Format Datetime with a fmt rule. See chrono strftime/strptime.

pub fn from_naive_datetime<I: IntoIterator<Item = NaiveDateTime>>(
    name: &str,
    v: I,
    tu: TimeUnit
) -> Self

Available on (crate features temporal or dtype-datetime or dtype-date) and crate feature dtype-datetime only.

Construct a new DatetimeChunked from an iterator over NaiveDateTime.

pub fn from_naive_datetime_options<I: IntoIterator<Item = Option<NaiveDateTime>>>(
    name: &str,
    v: I,
    tu: TimeUnit
) -> Self

Available on (crate features temporal or dtype-datetime or dtype-date) and crate feature dtype-datetime only.

pub fn cast_time_unit(&self, tu: TimeUnit) -> Self

Available on (crate features temporal or dtype-datetime or dtype-date) and crate feature dtype-datetime only.

Change the underlying TimeUnit. And update the data accordingly.

pub fn set_time_unit(&mut self, tu: TimeUnit)

Available on (crate features temporal or dtype-datetime or dtype-date) and crate feature dtype-datetime only.

Change the underlying TimeUnit. This does not modify the data.

pub fn set_time_zone(&mut self, tz: Option<TimeZone>)

Available on (crate features temporal or dtype-datetime or dtype-date) and crate feature dtype-datetime only.

Change the underlying TimeZone. This does not modify the data.

pub fn with_time_zone(self, tz: Option<TimeZone>) -> Self

Available on (crate features temporal or dtype-datetime or dtype-date) and crate feature dtype-datetime only.

impl Logical<DurationType, Int64Type>

pub fn time_unit(&self) -> TimeUnit

Available on (crate features temporal or dtype-datetime or dtype-date) and crate feature dtype-duration only.

pub fn cast_time_unit(&self, tu: TimeUnit) -> Self

Available on (crate features temporal or dtype-datetime or dtype-date) and crate feature dtype-duration only.

Change the underlying TimeUnit. And update the data accordingly.

pub fn set_time_unit(&mut self, tu: TimeUnit)

Available on (crate features temporal or dtype-datetime or dtype-date) and crate feature dtype-duration only.

Change the underlying TimeUnit. This does not modify the data.

pub fn from_duration<I: IntoIterator<Item = ChronoDuration>>(
    name: &str,
    v: I,
    tu: TimeUnit
) -> Self

Available on (crate features temporal or dtype-datetime or dtype-date) and crate feature dtype-duration only.

Construct a new DurationChunked from an iterator over ChronoDuration.

pub fn from_duration_options<I: IntoIterator<Item = Option<ChronoDuration>>>(
    name: &str,
    v: I,
    tu: TimeUnit
) -> Self

Available on (crate features temporal or dtype-datetime or dtype-date) and crate feature dtype-duration only.

Construct a new DurationChunked from an iterator over optional ChronoDuration.

impl Logical<TimeType, Int64Type>

pub fn as_time_iter(
    &self
) -> impl Iterator<Item = Option<NaiveTime>> + TrustedLen + '_

Available on (crate features temporal or dtype-datetime or dtype-date) and crate feature dtype-time only.

pub fn from_naive_time<I: IntoIterator<Item = NaiveTime>>(
    name: &str,
    v: I
) -> Self

Available on (crate features temporal or dtype-datetime or dtype-date) and crate feature dtype-time only.

Construct a new TimeChunked from an iterator over NaiveTime.

pub fn from_naive_time_options<I: IntoIterator<Item = Option<NaiveTime>>>(
    name: &str,
    v: I
) -> Self

Available on (crate features temporal or dtype-datetime or dtype-date) and crate feature dtype-time only.

Construct a new TimeChunked from an iterator over optional NaiveTime.

Methods from Deref<Target = ChunkedArray<T>>

pub fn abs(&self) -> Self

Available on crate feature abs only.

Convert all values to their absolute/positive value.

pub fn append(&mut self, other: &Self)

Append in place. This is done by adding the chunks of other to this ChunkedArray.

See also extend for appends to the underlying memory

pub fn cast_and_apply_in_place<F, S>(&self, f: F) -> ChunkedArray<S>where
    F: Fn(S::Native) -> S::Native + Copy,
    S: PolarsNumericType,

Cast a numeric array to another numeric data type and apply a function in place. This saves an allocation.

pub fn apply_mut<F>(&mut self, f: F)where
    F: Fn(T::Native) -> T::Native + Copy,

pub fn len(&self) -> usize

Get the length of the ChunkedArray

pub fn is_empty(&self) -> bool

Check if ChunkedArray is empty.

pub fn rechunk(&self) -> Self

pub fn slice(&self, offset: i64, length: usize) -> Self

Slice the array. The chunks are reallocated the underlying data slices are zero copy.

When offset is negative it will be counted from the end of the array. This method will never error, and will slice the best match when offset, or length is out of bounds

pub fn limit(&self, num_elements: usize) -> Selfwhere
    Self: Sized,

Take a view of top n elements

pub fn head(&self, length: Option<usize>) -> Selfwhere
    Self: Sized,

Get the head of the ChunkedArray

pub fn tail(&self, length: Option<usize>) -> Selfwhere
    Self: Sized,

Get the tail of the ChunkedArray

pub fn extend(&mut self, other: &Self)

Extend the memory backed by this array with the values from other.

Different from ChunkedArray::append which adds chunks to this ChunkedArray extend appends the data from other to the underlying PrimitiveArray and thus may cause a reallocation.

However if this does not cause a reallocation, the resulting data structure will not have any extra chunks and thus will yield faster queries.

Prefer extend over append when you want to do a query after a single append. For instance during online operations where you add n rows and rerun a query.

Prefer append over extend when you want to append many times before doing a query. For instance when you read in multiple files and when to store them in a single DataFrame. In the latter case finish the sequence of append operations with a rechunk.

pub fn rolling_apply_float<F>(
    &self,
    window_size: usize,
    f: F
) -> PolarsResult<Self>where
    F: FnMut(&mut ChunkedArray<T>) -> Option<T::Native>,

Available on crate feature rolling_window only.

Apply a rolling custom function. This is pretty slow because of dynamic dispatch.

pub fn all(&self) -> bool

Check if all values are true

pub fn any(&self) -> bool

Check if any value is true

pub fn is_nan(&self) -> BooleanChunked

pub fn is_not_nan(&self) -> BooleanChunked

pub fn is_finite(&self) -> BooleanChunked

pub fn is_infinite(&self) -> BooleanChunked

pub fn none_to_nan(&self) -> Self

Convert missing values to NaN values.

pub fn par_iter(&self) -> impl ParallelIterator<Item = Option<Series>> + '_

pub fn par_iter_indexed(
    &mut self
) -> impl IndexedParallelIterator<Item = Option<Series>> + '_

pub fn par_iter_indexed(
    &self
) -> impl IndexedParallelIterator<Item = Option<&str>>

pub fn par_iter(&self) -> impl ParallelIterator<Item = Option<&str>> + '_

pub fn to_ndarray(&self) -> PolarsResult<ArrayView1<'_, T::Native>>

Available on crate feature ndarray only.

If data is aligned in a single chunk and has no Null values a zero copy view is returned as an ndarray

pub fn to_ndarray<N>(&self) -> PolarsResult<Array2<N::Native>>where
    N: PolarsNumericType,

Available on crate feature ndarray only.

If all nested Series have the same length, a 2 dimensional ndarray::Array is returned.

pub fn amortized_iter(
    &self
) -> AmortizedListIter<'_, impl Iterator<Item = Option<ArrayBox>> + '_>

Available on crate feature private only.

This is an iterator over a ListChunked that save allocations. A Series is: 1. Arc ChunkedArray is: 2. Vec< 3. ArrayRef>

The ArrayRef we indicated with 3. will be updated during iteration. The Series will be pinned in memory, saving an allocation for

1. Arc<..>
2. Vec<…>

Warning

Though memory safe in the sense that it will not read unowned memory, UB, or memory leaks this function still needs precautions. The returned should never be cloned or taken longer than a single iteration, as every call on next of the iterator will change the contents of that Series.

pub fn apply_amortized<'a, F>(&'a self, f: F) -> Selfwhere
    F: FnMut(UnstableSeries<'a>) -> Series,

Available on crate feature private only.

Apply a closure F elementwise.

pub fn try_apply_amortized<'a, F>(&'a self, f: F) -> PolarsResult<Self>where
    F: FnMut(UnstableSeries<'a>) -> PolarsResult<Series>,

pub fn set_fast_explode(&mut self)

Available on crate feature private only.

pub fn _can_fast_explode(&self) -> bool

pub fn to_logical(&mut self, inner_dtype: DataType)

pub unsafe fn get_object_unchecked(
    &self,
    index: usize
) -> Option<&dyn PolarsObjectSafe>

Available on crate feature object only.

Get a hold to an object that can be formatted or downcasted via the Any trait.

Safety

No bounds checks

pub fn get_object(&self, index: usize) -> Option<&dyn PolarsObjectSafe>

Available on crate feature object only.

Get a hold to an object that can be formatted or downcasted via the Any trait.

pub fn sample_n(
    &self,
    n: usize,
    with_replacement: bool,
    shuffle: bool,
    seed: Option<u64>
) -> PolarsResult<Self>

Available on crate feature random only.

Sample n datapoints from this ChunkedArray.

pub fn sample_frac(
    &self,
    frac: f64,
    with_replacement: bool,
    shuffle: bool,
    seed: Option<u64>
) -> PolarsResult<Self>

Available on crate feature random only.

Sample a fraction between 0.0-1.0 of this ChunkedArray.

pub fn hex_decode(&self) -> PolarsResult<Utf8Chunked>

Available on crate feature string_encoding and non-crate feature binary_encoding only.

pub fn hex_encode(&self) -> Utf8Chunked

Available on crate feature string_encoding only.

pub fn base64_decode(&self) -> PolarsResult<Utf8Chunked>

Available on crate feature string_encoding and non-crate feature binary_encoding only.

pub fn base64_encode(&self) -> Utf8Chunked

Available on crate feature string_encoding only.

pub fn is_sorted_flag2(&self) -> IsSorted

pub fn set_sorted_flag(&mut self, sorted: IsSorted)

Set the ‘sorted’ bit meta info.

pub fn first_non_null(&self) -> Option<usize>

Get the index of the first non null value in this ChunkedArray.

pub fn last_non_null(&self) -> Option<usize>

Get the index of the last non null value in this ChunkedArray.

pub fn iter_validities(
    &self
) -> Map<Iter<'_, ArrayRef>, fn(_: &ArrayRef) -> Option<&Bitmap>>

Get the buffer of bits representing null values

pub fn has_validity(&self) -> bool

Return if any the chunks in this [ChunkedArray] have a validity bitmap. no bitmap means no null values.

pub fn shrink_to_fit(&mut self)

Shrink the capacity of this array to fit its length.

pub fn unpack_series_matching_type(
    &self,
    series: &Series
) -> PolarsResult<&ChunkedArray<T>>

Series to ChunkedArray

pub fn chunk_id(&self) -> ChunkIdIter<'_>

Unique id representing the number of chunks

pub fn chunks(&self) -> &Vec<ArrayRef>

A reference to the chunks

pub unsafe fn chunks_mut(&mut self) -> &mut Vec<ArrayRef>

A mutable reference to the chunks

Safety

The caller must ensure to not change the DataType or length of any of the chunks.

pub fn is_optimal_aligned(&self) -> bool

Returns true if contains a single chunk and has no null values

pub fn null_count(&self) -> usize

Count the null values.

pub fn is_null(&self) -> BooleanChunked

Get a mask of the null values.

pub fn is_not_null(&self) -> BooleanChunked

Get a mask of the valid values.

pub fn dtype(&self) -> &DataType

Get data type of ChunkedArray.

pub fn name(&self) -> &str

Name of the ChunkedArray.

pub fn ref_field(&self) -> &Field

Get a reference to the field.

pub fn rename(&mut self, name: &str)

Rename this ChunkedArray.

pub fn cont_slice(&self) -> PolarsResult<&[T::Native]>

Contiguous slice

pub fn data_views(
    &self
) -> impl Iterator<Item = &[T::Native]> + DoubleEndedIterator

Get slices of the underlying arrow data. NOTE: null values should be taken into account by the user of these slices as they are handled separately

pub fn into_no_null_iter(
    &self
) -> impl Iterator<Item = T::Native> + '_ + Send + Sync + ExactSizeIterator + DoubleEndedIterator + TrustedLen

pub fn inner_dtype(&self) -> DataType

Get the inner data type of the list.

pub fn set_inner_dtype(&mut self, dtype: DataType)

pub fn lhs_sub<N: Num + NumCast>(&self, lhs: N) -> Self

Apply lhs - self

pub fn lhs_div<N: Num + NumCast>(&self, lhs: N) -> Self

Apply lhs / self

pub fn lhs_rem<N: Num + NumCast>(&self, lhs: N) -> Self

Apply lhs % self

Trait Implementations

impl<K: PolarsDataType, T: PolarsDataType> Clone for Logical<K, T>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<K: PolarsDataType, T: PolarsDataType> Deref for Logical<K, T>

type Target = ChunkedArray<T>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<K: PolarsDataType, T: PolarsDataType> DerefMut for Logical<K, T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl From<Logical<DateType, Int32Type>> for Series

Available on crate feature dtype-date only.

fn from(a: DateChunked) -> Self

Converts to this type from the input type.

impl From<Logical<DatetimeType, Int64Type>> for Series

Available on crate feature dtype-datetime only.

fn from(a: DatetimeChunked) -> Self

Converts to this type from the input type.

impl From<Logical<DurationType, Int64Type>> for Series

Available on crate feature dtype-duration only.

fn from(a: DurationChunked) -> Self

Converts to this type from the input type.

impl From<Logical<TimeType, Int64Type>> for Series

Available on crate feature dtype-time only.

fn from(a: TimeChunked) -> Self

Converts to this type from the input type.