Struct datafusion::physical_plan::udaf::AggregateUDF
source · pub struct AggregateUDF {
pub name: String,
pub signature: Signature,
pub return_type: Arc<dyn Fn(&[DataType]) -> Result<Arc<DataType>, DataFusionError> + Send + Sync + 'static>,
pub accumulator: Arc<dyn Fn(&DataType) -> Result<Box<dyn Accumulator + 'static, Global>, DataFusionError> + Send + Sync + 'static>,
pub state_type: Arc<dyn Fn(&DataType) -> Result<Arc<Vec<DataType, Global>>, DataFusionError> + Send + Sync + 'static>,
}
Expand description
Logical representation of a user-defined aggregate function (UDAF) A UDAF is different from a UDF in that it is stateful across batches.
Fields§
§name: String
name
signature: Signature
signature
return_type: Arc<dyn Fn(&[DataType]) -> Result<Arc<DataType>, DataFusionError> + Send + Sync + 'static>
Return type
accumulator: Arc<dyn Fn(&DataType) -> Result<Box<dyn Accumulator + 'static, Global>, DataFusionError> + Send + Sync + 'static>
actual implementation
state_type: Arc<dyn Fn(&DataType) -> Result<Arc<Vec<DataType, Global>>, DataFusionError> + Send + Sync + 'static>
the accumulator’s state’s description as a function of the return type
Implementations§
source§impl AggregateUDF
impl AggregateUDF
sourcepub fn new(
name: &str,
signature: &Signature,
return_type: &Arc<dyn Fn(&[DataType]) -> Result<Arc<DataType>, DataFusionError> + Send + Sync + 'static>,
accumulator: &Arc<dyn Fn(&DataType) -> Result<Box<dyn Accumulator + 'static, Global>, DataFusionError> + Send + Sync + 'static>,
state_type: &Arc<dyn Fn(&DataType) -> Result<Arc<Vec<DataType, Global>>, DataFusionError> + Send + Sync + 'static>
) -> AggregateUDF
pub fn new( name: &str, signature: &Signature, return_type: &Arc<dyn Fn(&[DataType]) -> Result<Arc<DataType>, DataFusionError> + Send + Sync + 'static>, accumulator: &Arc<dyn Fn(&DataType) -> Result<Box<dyn Accumulator + 'static, Global>, DataFusionError> + Send + Sync + 'static>, state_type: &Arc<dyn Fn(&DataType) -> Result<Arc<Vec<DataType, Global>>, DataFusionError> + Send + Sync + 'static> ) -> AggregateUDF
Create a new AggregateUDF
Trait Implementations§
source§impl Clone for AggregateUDF
impl Clone for AggregateUDF
source§fn clone(&self) -> AggregateUDF
fn clone(&self) -> AggregateUDF
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 AggregateUDF
impl Debug for AggregateUDF
source§impl Hash for AggregateUDF
impl Hash for AggregateUDF
source§impl PartialEq<AggregateUDF> for AggregateUDF
impl PartialEq<AggregateUDF> for AggregateUDF
source§fn eq(&self, other: &AggregateUDF) -> bool
fn eq(&self, other: &AggregateUDF) -> bool
This method tests for
self
and other
values to be equal, and is used
by ==
.impl Eq for AggregateUDF
Auto Trait Implementations§
impl !RefUnwindSafe for AggregateUDF
impl Send for AggregateUDF
impl Sync for AggregateUDF
impl Unpin for AggregateUDF
impl !UnwindSafe for AggregateUDF
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<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Compare self to
key
and return true
if they are equal.