pub type BooleanChunked = ChunkedArray<BooleanType>;
Aliased Type§
struct BooleanChunked { /* private fields */ }
Implementations§
Source§impl BooleanChunked
Booleans are cast to 1 or 0.
impl BooleanChunked
Booleans are cast to 1 or 0.
Source§impl BooleanChunked
impl BooleanChunked
Sourcepub fn any(&self) -> bool
pub fn any(&self) -> bool
Returns whether any of the values in the column are true
.
Null values are ignored.
Sourcepub fn all(&self) -> bool
pub fn all(&self) -> bool
Returns whether all values in the array are true
.
Null values are ignored.
Sourcepub fn any_kleene(&self) -> Option<bool>
pub fn any_kleene(&self) -> Option<bool>
Returns whether any of the values in the column are true
.
The output is unknown (None
) if the array contains any null values and
no true
values.
Sourcepub fn all_kleene(&self) -> Option<bool>
pub fn all_kleene(&self) -> Option<bool>
Returns whether all values in the column are true
.
The output is unknown (None
) if the array contains any null values and
no false
values.
Source§impl BooleanChunked
impl BooleanChunked
Sourcepub unsafe fn mmap_slice(
name: PlSmallStr,
values: &[u8],
offset: usize,
len: usize,
) -> Self
pub unsafe fn mmap_slice( name: PlSmallStr, values: &[u8], offset: usize, len: usize, ) -> Self
Create a temporary ChunkedArray
from a slice.
§Safety
The lifetime will be bound to the lifetime of the slice. This will not be checked by the borrowchecker.
pub fn from_bitmap(name: PlSmallStr, bitmap: Bitmap) -> Self
Source§impl BooleanChunked
impl BooleanChunked
Sourcepub fn rand_bernoulli(
name: PlSmallStr,
length: usize,
p: f64,
) -> PolarsResult<Self>
Available on crate feature random
only.
pub fn rand_bernoulli( name: PlSmallStr, length: usize, p: f64, ) -> PolarsResult<Self>
random
only.Create ChunkedArray
with samples from a Bernoulli distribution.
Trait Implementations§
Source§impl Add for &BooleanChunked
impl Add for &BooleanChunked
Source§type Output = ChunkedArray<UInt32Type>
type Output = ChunkedArray<UInt32Type>
The resulting type after applying the
+
operator.Source§impl Add for BooleanChunked
impl Add for BooleanChunked
Source§type Output = ChunkedArray<UInt32Type>
type Output = ChunkedArray<UInt32Type>
The resulting type after applying the
+
operator.Source§impl AggList for BooleanChunked
Available on crate feature algorithm_group_by
only.
impl AggList for BooleanChunked
Available on crate feature
algorithm_group_by
only.Source§impl BitAnd for &BooleanChunked
impl BitAnd for &BooleanChunked
Source§type Output = ChunkedArray<BooleanType>
type Output = ChunkedArray<BooleanType>
The resulting type after applying the
&
operator.Source§impl BitAnd for BooleanChunked
impl BitAnd for BooleanChunked
Source§type Output = ChunkedArray<BooleanType>
type Output = ChunkedArray<BooleanType>
The resulting type after applying the
&
operator.Source§impl BitOr for &BooleanChunked
impl BitOr for &BooleanChunked
Source§type Output = ChunkedArray<BooleanType>
type Output = ChunkedArray<BooleanType>
The resulting type after applying the
|
operator.Source§impl BitOr for BooleanChunked
impl BitOr for BooleanChunked
Source§type Output = ChunkedArray<BooleanType>
type Output = ChunkedArray<BooleanType>
The resulting type after applying the
|
operator.Source§impl BitXor for &BooleanChunked
impl BitXor for &BooleanChunked
Source§type Output = ChunkedArray<BooleanType>
type Output = ChunkedArray<BooleanType>
The resulting type after applying the
^
operator.Source§impl BitXor for BooleanChunked
impl BitXor for BooleanChunked
Source§type Output = ChunkedArray<BooleanType>
type Output = ChunkedArray<BooleanType>
The resulting type after applying the
^
operator.Source§impl ChunkAggSeries for BooleanChunked
impl ChunkAggSeries for BooleanChunked
Source§fn sum_reduce(&self) -> Scalar
fn sum_reduce(&self) -> Scalar
Get the sum of the
ChunkedArray
as a new Series
of length 1.Source§fn max_reduce(&self) -> Scalar
fn max_reduce(&self) -> Scalar
Get the max of the
ChunkedArray
as a new Series
of length 1.Source§fn min_reduce(&self) -> Scalar
fn min_reduce(&self) -> Scalar
Get the min of the
ChunkedArray
as a new Series
of length 1.Source§fn prod_reduce(&self) -> Scalar
fn prod_reduce(&self) -> Scalar
Get the product of the
ChunkedArray
as a new Series
of length 1.Source§impl ChunkAnyValue for BooleanChunked
impl ChunkAnyValue for BooleanChunked
Source§unsafe fn get_any_value_unchecked(&self, index: usize) -> AnyValue<'_>
unsafe fn get_any_value_unchecked(&self, index: usize) -> AnyValue<'_>
Get a single value. Beware this is slow.
If you need to use this slightly performant, cast Categorical to UInt32 Read more
Source§fn get_any_value(&self, index: usize) -> PolarsResult<AnyValue<'_>>
fn get_any_value(&self, index: usize) -> PolarsResult<AnyValue<'_>>
Get a single value. Beware this is slow.
Source§impl<'a> ChunkApply<'a, bool> for BooleanChunked
impl<'a> ChunkApply<'a, bool> for BooleanChunked
type FuncRet = bool
Source§fn apply_values<F>(&self, f: F) -> Self
fn apply_values<F>(&self, f: F) -> Self
Apply a closure elementwise. This is fastest when the null check branching is more expensive
than the closure application. Often it is. Read more
Source§impl ChunkApplyKernel<BooleanArray> for BooleanChunked
impl ChunkApplyKernel<BooleanArray> for BooleanChunked
Source§fn apply_kernel(&self, f: &dyn Fn(&BooleanArray) -> ArrayRef) -> Self
fn apply_kernel(&self, f: &dyn Fn(&BooleanArray) -> ArrayRef) -> Self
Apply kernel and return result as a new ChunkedArray.
Source§fn apply_kernel_cast<S>(
&self,
f: &dyn Fn(&BooleanArray) -> ArrayRef,
) -> ChunkedArray<S>where
S: PolarsDataType,
fn apply_kernel_cast<S>(
&self,
f: &dyn Fn(&BooleanArray) -> ArrayRef,
) -> ChunkedArray<S>where
S: PolarsDataType,
Apply a kernel that outputs an array of different type.
Source§impl ChunkCast for BooleanChunked
impl ChunkCast for BooleanChunked
Source§fn cast_with_options(
&self,
dtype: &DataType,
options: CastOptions,
) -> PolarsResult<Series>
fn cast_with_options( &self, dtype: &DataType, options: CastOptions, ) -> PolarsResult<Series>
Cast a
ChunkedArray
to DataType
Source§unsafe fn cast_unchecked(&self, dtype: &DataType) -> PolarsResult<Series>
unsafe fn cast_unchecked(&self, dtype: &DataType) -> PolarsResult<Series>
Does not check if the cast is a valid one and may over/underflow Read more
Source§fn cast(&self, dtype: &DataType) -> PolarsResult<Series>
fn cast(&self, dtype: &DataType) -> PolarsResult<Series>
Cast a
ChunkedArray
to DataType
Source§impl ChunkCompareEq<&ChunkedArray<BooleanType>> for BooleanChunked
impl ChunkCompareEq<&ChunkedArray<BooleanType>> for BooleanChunked
type Item = ChunkedArray<BooleanType>
Source§fn equal(&self, rhs: &BooleanChunked) -> BooleanChunked
fn equal(&self, rhs: &BooleanChunked) -> BooleanChunked
Check for equality.
Source§fn equal_missing(&self, rhs: &BooleanChunked) -> BooleanChunked
fn equal_missing(&self, rhs: &BooleanChunked) -> BooleanChunked
Check for equality where
None == None
.Source§fn not_equal(&self, rhs: &BooleanChunked) -> BooleanChunked
fn not_equal(&self, rhs: &BooleanChunked) -> BooleanChunked
Check for inequality.
Source§fn not_equal_missing(&self, rhs: &BooleanChunked) -> BooleanChunked
fn not_equal_missing(&self, rhs: &BooleanChunked) -> BooleanChunked
Check for inequality where
None == None
.Source§impl ChunkCompareIneq<&ChunkedArray<BooleanType>> for BooleanChunked
impl ChunkCompareIneq<&ChunkedArray<BooleanType>> for BooleanChunked
type Item = ChunkedArray<BooleanType>
Source§fn lt(&self, rhs: &BooleanChunked) -> BooleanChunked
fn lt(&self, rhs: &BooleanChunked) -> BooleanChunked
Less than comparison.
Source§fn lt_eq(&self, rhs: &BooleanChunked) -> BooleanChunked
fn lt_eq(&self, rhs: &BooleanChunked) -> BooleanChunked
Less than or equal comparison
Source§fn gt(&self, rhs: &Self) -> BooleanChunked
fn gt(&self, rhs: &Self) -> BooleanChunked
Greater than comparison.
Source§fn gt_eq(&self, rhs: &Self) -> BooleanChunked
fn gt_eq(&self, rhs: &Self) -> BooleanChunked
Greater than or equal comparison.
Source§impl ChunkExpandAtIndex<BooleanType> for BooleanChunked
impl ChunkExpandAtIndex<BooleanType> for BooleanChunked
Source§fn new_from_index(&self, index: usize, length: usize) -> BooleanChunked
fn new_from_index(&self, index: usize, length: usize) -> BooleanChunked
Create a new ChunkedArray filled with values at that index.
Source§impl ChunkFillNullValue<bool> for BooleanChunked
impl ChunkFillNullValue<bool> for BooleanChunked
Source§fn fill_null_with_values(&self, value: bool) -> PolarsResult<Self>
fn fill_null_with_values(&self, value: bool) -> PolarsResult<Self>
Replace None values with a give value
T
.Source§impl ChunkFull<bool> for BooleanChunked
impl ChunkFull<bool> for BooleanChunked
Source§impl ChunkFullNull for BooleanChunked
impl ChunkFullNull for BooleanChunked
fn full_null(name: PlSmallStr, length: usize) -> Self
Source§impl ChunkQuantile<bool> for BooleanChunked
impl ChunkQuantile<bool> for BooleanChunked
Source§fn median(&self) -> Option<T>
fn median(&self) -> Option<T>
Returns the mean value in the array.
Returns
None
if the array is empty or only contains null values.Source§fn quantile(
&self,
_quantile: f64,
_method: QuantileMethod,
) -> PolarsResult<Option<T>>
fn quantile( &self, _quantile: f64, _method: QuantileMethod, ) -> PolarsResult<Option<T>>
Aggregate a given quantile of the ChunkedArray.
Returns
None
if the array is empty or only contains null values.Source§impl ChunkReverse for BooleanChunked
impl ChunkReverse for BooleanChunked
Source§impl<'a> ChunkSet<'a, bool, bool> for BooleanChunked
impl<'a> ChunkSet<'a, bool, bool> for BooleanChunked
Source§fn scatter_single<I: IntoIterator<Item = IdxSize>>(
&'a self,
idx: I,
value: Option<bool>,
) -> PolarsResult<Self>
fn scatter_single<I: IntoIterator<Item = IdxSize>>( &'a self, idx: I, value: Option<bool>, ) -> PolarsResult<Self>
Source§fn scatter_with<I: IntoIterator<Item = IdxSize>, F>(
&'a self,
idx: I,
f: F,
) -> PolarsResult<Self>
fn scatter_with<I: IntoIterator<Item = IdxSize>, F>( &'a self, idx: I, f: F, ) -> PolarsResult<Self>
Set the values at indexes
idx
by applying a closure to these values. Read moreSource§fn set(
&'a self,
mask: &BooleanChunked,
value: Option<bool>,
) -> PolarsResult<Self>
fn set( &'a self, mask: &BooleanChunked, value: Option<bool>, ) -> PolarsResult<Self>
Source§impl ChunkShift<BooleanType> for BooleanChunked
impl ChunkShift<BooleanType> for BooleanChunked
Source§impl ChunkShiftFill<BooleanType, Option<bool>> for BooleanChunked
impl ChunkShiftFill<BooleanType, Option<bool>> for BooleanChunked
Source§fn shift_and_fill(
&self,
periods: i64,
fill_value: Option<bool>,
) -> BooleanChunked
fn shift_and_fill( &self, periods: i64, fill_value: Option<bool>, ) -> BooleanChunked
Shift the values by a given period and fill the parts that will be empty due to this operation
with
fill_value
.Source§impl ChunkSort<BooleanType> for BooleanChunked
impl ChunkSort<BooleanType> for BooleanChunked
fn sort_with(&self, options: SortOptions) -> ChunkedArray<BooleanType>
Source§fn sort(&self, descending: bool) -> BooleanChunked
fn sort(&self, descending: bool) -> BooleanChunked
Returned a sorted
ChunkedArray
.Source§fn arg_sort(&self, options: SortOptions) -> IdxCa
fn arg_sort(&self, options: SortOptions) -> IdxCa
Retrieve the indexes needed to sort this array.
Source§fn arg_sort_multiple(
&self,
by: &[Column],
options: &SortMultipleOptions,
) -> PolarsResult<IdxCa>
fn arg_sort_multiple( &self, by: &[Column], options: &SortMultipleOptions, ) -> PolarsResult<IdxCa>
Retrieve the indexes need to sort this and the other arrays.
Source§impl ChunkUnique for BooleanChunked
Available on crate feature algorithm_group_by
only.
impl ChunkUnique for BooleanChunked
Available on crate feature
algorithm_group_by
only.Source§fn unique(&self) -> PolarsResult<Self>
fn unique(&self) -> PolarsResult<Self>
Get unique values of a ChunkedArray
Source§fn arg_unique(&self) -> PolarsResult<IdxCa>
fn arg_unique(&self) -> PolarsResult<IdxCa>
Get first index of the unique values in a
ChunkedArray
.
This Vec is sorted.Source§fn n_unique(&self) -> PolarsResult<usize>
fn n_unique(&self) -> PolarsResult<usize>
Number of unique values in the
ChunkedArray
Source§impl ChunkVar for BooleanChunked
impl ChunkVar for BooleanChunked
Source§impl FromIterator<bool> for BooleanChunked
impl FromIterator<bool> for BooleanChunked
Source§impl FromIteratorReversed<Option<bool>> for BooleanChunked
impl FromIteratorReversed<Option<bool>> for BooleanChunked
fn from_trusted_len_iter_rev<I: TrustedLen<Item = Option<bool>>>( iter: I, ) -> Self
Source§impl FromParallelIterator<Option<bool>> for BooleanChunked
impl FromParallelIterator<Option<bool>> for BooleanChunked
Source§impl FromParallelIterator<bool> for BooleanChunked
impl FromParallelIterator<bool> for BooleanChunked
Source§fn from_par_iter<I: IntoParallelIterator<Item = bool>>(iter: I) -> Self
fn from_par_iter<I: IntoParallelIterator<Item = bool>>(iter: I) -> Self
Creates an instance of the collection from the parallel iterator
par_iter
. Read moreSource§impl FromTrustedLenIterator<bool> for BooleanChunked
impl FromTrustedLenIterator<bool> for BooleanChunked
fn from_iter_trusted_length<I: IntoIterator<Item = bool>>(iter: I) -> Selfwhere
I::IntoIter: TrustedLen,
Source§impl IntoGroupsType for BooleanChunked
Available on crate feature algorithm_group_by
only.
impl IntoGroupsType for BooleanChunked
Available on crate feature
algorithm_group_by
only.Source§fn group_tuples(
&self,
multithreaded: bool,
sorted: bool,
) -> PolarsResult<GroupsType>
fn group_tuples( &self, multithreaded: bool, sorted: bool, ) -> PolarsResult<GroupsType>
Create the tuples need for a group_by operation.
* The first value in the tuple is the first index of the group.
* The second value in the tuple is the indexes of the groups including the first value.
Source§impl<'a> IntoIterator for &'a BooleanChunked
impl<'a> IntoIterator for &'a BooleanChunked
Source§type IntoIter = Box<dyn PolarsIterator<Item = <&'a ChunkedArray<BooleanType> as IntoIterator>::Item> + 'a>
type IntoIter = Box<dyn PolarsIterator<Item = <&'a ChunkedArray<BooleanType> as IntoIterator>::Item> + 'a>
Which kind of iterator are we turning this into?
Source§impl NewChunkedArray<BooleanType, bool> for BooleanChunked
impl NewChunkedArray<BooleanType, bool> for BooleanChunked
Source§fn from_iter_values(
name: PlSmallStr,
it: impl Iterator<Item = bool>,
) -> ChunkedArray<BooleanType>
fn from_iter_values( name: PlSmallStr, it: impl Iterator<Item = bool>, ) -> ChunkedArray<BooleanType>
Create a new ChunkedArray from an iterator.
fn from_slice(name: PlSmallStr, v: &[bool]) -> Self
fn from_slice_options(name: PlSmallStr, opt_v: &[Option<bool>]) -> Self
Source§fn from_iter_options(
name: PlSmallStr,
it: impl Iterator<Item = Option<bool>>,
) -> ChunkedArray<BooleanType>
fn from_iter_options( name: PlSmallStr, it: impl Iterator<Item = Option<bool>>, ) -> ChunkedArray<BooleanType>
Create a new ChunkedArray from an iterator.
Source§impl Not for &BooleanChunked
impl Not for &BooleanChunked
Source§type Output = ChunkedArray<BooleanType>
type Output = ChunkedArray<BooleanType>
The resulting type after applying the
!
operator.Source§impl Not for BooleanChunked
impl Not for BooleanChunked
Source§type Output = ChunkedArray<BooleanType>
type Output = ChunkedArray<BooleanType>
The resulting type after applying the
!
operator.Source§impl Serialize for BooleanChunked
Available on crate feature serde
only.
impl Serialize for BooleanChunked
Available on crate feature
serde
only.Source§fn serialize<S>(
&self,
serializer: S,
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where
S: Serializer,
fn serialize<S>(
&self,
serializer: S,
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where
S: Serializer,
Serialize this value into the given Serde serializer. Read more
Source§impl VecHash for BooleanChunked
impl VecHash for BooleanChunked
Source§fn vec_hash(
&self,
random_state: PlRandomState,
buf: &mut Vec<u64>,
) -> PolarsResult<()>
fn vec_hash( &self, random_state: PlRandomState, buf: &mut Vec<u64>, ) -> PolarsResult<()>
Compute the hash for all values in the array.