Struct polars::prelude::chunkedarray::RollingOptions
source · pub struct RollingOptions {
pub window_size: Duration,
pub min_periods: usize,
pub weights: Option<Vec<f64>>,
pub center: bool,
pub by: Option<String>,
pub closed_window: Option<ClosedWindow>,
pub fn_params: Option<Arc<dyn Any + Sync + Send>>,
pub warn_if_unsorted: bool,
}
Available on crate feature
temporal
only.Fields§
§window_size: Duration
The length of the window.
min_periods: usize
Amount of elements in the window that should be filled before computing a result.
weights: Option<Vec<f64>>
An optional slice with the same length as the window that will be multiplied elementwise with the values in the window.
center: bool
Set the labels at the center of the window.
by: Option<String>
Compute the rolling aggregates with a window defined by a time column
closed_window: Option<ClosedWindow>
The closed window of that time window if given
fn_params: Option<Arc<dyn Any + Sync + Send>>
Optional parameters for the rolling function
warn_if_unsorted: bool
Warn if data is not known to be sorted by by
column (if passed)
Trait Implementations§
source§impl Clone for RollingOptions
impl Clone for RollingOptions
source§fn clone(&self) -> RollingOptions
fn clone(&self) -> RollingOptions
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl Debug for RollingOptions
impl Debug for RollingOptions
source§impl Default for RollingOptions
impl Default for RollingOptions
source§fn default() -> RollingOptions
fn default() -> RollingOptions
Returns the “default value” for a type. Read more
source§impl PartialEq for RollingOptions
Available on crate feature rolling_window
only.
impl PartialEq for RollingOptions
Available on crate feature
rolling_window
only.source§fn eq(&self, other: &RollingOptions) -> bool
fn eq(&self, other: &RollingOptions) -> bool
This method tests for
self
and other
values to be equal, and is used
by ==
.source§impl TryFrom<RollingOptions> for RollingOptionsImpl<'static>
impl TryFrom<RollingOptions> for RollingOptionsImpl<'static>
§type Error = PolarsError
type Error = PolarsError
The type returned in the event of a conversion error.
source§fn try_from(
options: RollingOptions
) -> Result<RollingOptionsImpl<'static>, PolarsError>
fn try_from( options: RollingOptions ) -> Result<RollingOptionsImpl<'static>, PolarsError>
Performs the conversion.
Auto Trait Implementations§
impl Freeze for RollingOptions
impl !RefUnwindSafe for RollingOptions
impl Send for RollingOptions
impl Sync for RollingOptions
impl Unpin for RollingOptions
impl !UnwindSafe for RollingOptions
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
Converts
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
Converts
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more