graphrecords-query 0.5.0

use crate::{
    Bare, BareValueDomain, EvaluateOperand, Explain, Failure, IndexDomain, Indexed, Labeled,
    Multiple, Operand, OrderState, QueryResult,
    capabilities::ValueScalar,
    error::aggregation::InvalidStandardDeviationValue,
    execution::EvaluationCache,
    operands::BareValueOperand,
    operations::{
        Apply, BareStream, KeyedStream, LaneKernel, Operation, OperationContext, Prepare,
    },
    optimizer::{Estimate, OperationInputs, OptimizerHints, PlanIdentity, PlanInputs, Stats},
    registry::operation_manifest,
    traits::StandardDeviation,
};
use graphrecords_core::{GraphRecord, graphrecord::GraphRecordValue};

#[derive(Clone, Explain, Operation, OperationInputs, OptimizerHints, PlanIdentity, PlanInputs)]
#[operation(scope = Lane)]
#[explain(label = "Std")]
#[plan(optimizer_hints(empty = if_any))]
pub struct StandardDeviationOperation;

impl Prepare for StandardDeviationOperation {
    type Prepared<'a> = ();

    fn prepare<'a>(
        &'a self,
        _graphrecord: &'a GraphRecord,
        _cache: &'a EvaluationCache<'a>,
    ) -> QueryResult<Self::Prepared<'a>> {
        Ok(())
    }
}

fn update_state(
    (count, mean, squared_deviation): (usize, f64, f64),
    value: f64,
) -> (usize, f64, f64) {
    let count = count + 1;
    let difference = value - mean;
    let mean = mean + difference / count as f64;
    let updated_difference = value - mean;
    let squared_deviation = difference.mul_add(updated_difference, squared_deviation);

    (count, mean, squared_deviation)
}

impl<I, V, O> LaneKernel<Indexed<I, V>, Multiple<O>> for StandardDeviationOperation
where
    I: IndexDomain,
    V: ValueScalar + BareValueDomain,
    O: OrderState,
{
    type Output = BareValueOperand;

    fn execute<'a>(
        _graphrecord: &'a GraphRecord,
        mut values: KeyedStream<'a, I, V, Multiple<O>>,
        _prepared: Self::Prepared<'a>,
    ) -> QueryResult<<Self::Output as EvaluateOperand>::ReturnValue<'a>> {
        let standard_deviation = values
            .try_fold((0_usize, 0.0, 0.0), |state, (index, value)| {
                let value = V::into_scalar(Self::LABEL, value?)
                    .map_err(|failure| failure.at::<I>(&index))?;
                let value = match value {
                    GraphRecordValue::Int(value) => value as f64,
                    GraphRecordValue::Float(value) => value,
                    value => {
                        return Err(Failure::new_at::<I, _>(
                            Self::LABEL,
                            InvalidStandardDeviationValue::new(value),
                            &index,
                        ));
                    }
                };

                Ok(update_state(state, value))
            })
            .map(|(count, _, squared_deviation)| {
                (count > 1).then(|| {
                    GraphRecordValue::Float((squared_deviation / (count - 1) as f64).sqrt())
                })
            });

        Ok(standard_deviation.transpose())
    }

    fn estimate(&self, input: Estimate, _stats: &Stats) -> Estimate {
        input.zero_or_one()
    }
}

impl<V, O> LaneKernel<Bare<V>, Multiple<O>> for StandardDeviationOperation
where
    V: ValueScalar + BareValueDomain,
    O: OrderState,
{
    type Output = BareValueOperand;

    fn execute<'a>(
        _graphrecord: &'a GraphRecord,
        mut values: BareStream<'a, V, Multiple<O>>,
        _prepared: Self::Prepared<'a>,
    ) -> QueryResult<<Self::Output as EvaluateOperand>::ReturnValue<'a>> {
        let standard_deviation = values
            .try_fold((0_usize, 0.0, 0.0), |state, value| {
                let value = V::into_scalar(Self::LABEL, value?)?;
                let value = match value {
                    GraphRecordValue::Int(value) => value as f64,
                    GraphRecordValue::Float(value) => value,
                    value => {
                        return Err(Failure::new(
                            Self::LABEL,
                            InvalidStandardDeviationValue::new(value),
                        ));
                    }
                };

                Ok(update_state(state, value))
            })
            .map(|(count, _, squared_deviation)| {
                (count > 1).then(|| {
                    GraphRecordValue::Float((squared_deviation / (count - 1) as f64).sqrt())
                })
            });

        Ok(standard_deviation.transpose())
    }

    fn estimate(&self, input: Estimate, _stats: &Stats) -> Estimate {
        input.zero_or_one()
    }
}

impl<O: Apply<StandardDeviationOperation>> StandardDeviation for O {
    type ReturnOperand = O::Output;

    fn std(&self) -> Self::ReturnOperand {
        Self::ReturnOperand::new(OperationContext::new(
            self.clone(),
            StandardDeviationOperation,
        ))
    }
}

operation_manifest! {
    StandardDeviationOperation {
        method: StandardDeviation::std;
        scope: lane;

        kernel {
            parameters: <
                I: IndexDomain,
                V: ValueScalar + BareValueDomain,
                O: OrderState,
            >;
            input: (Indexed<I, V>, Multiple<O>);
            output: BareValueOperand;
        }

        kernel {
            parameters: <
                V: ValueScalar + BareValueDomain,
                O: OrderState,
            >;
            input: (Bare<V>, Multiple<O>);
            output: BareValueOperand;
        }
    }
}