netdata/web/api/queries/trimmed_mean/trimmed_mean.h

// SPDX-License-Identifier: GPL-3.0-or-later

#ifndef NETDATA_API_QUERIES_TRIMMED_MEAN_H
#define NETDATA_API_QUERIES_TRIMMED_MEAN_H

#include "../query.h"
#include "../rrdr.h"

struct tg_trimmed_mean {
    size_t series_size;
    size_t next_pos;
    NETDATA_DOUBLE percent;

    NETDATA_DOUBLE *series;
};

static inline void tg_trimmed_mean_create_internal(RRDR *r, const char *options, NETDATA_DOUBLE def) {
    long entries = r->view.group;
    if(entries < 10) entries = 10;

    struct tg_trimmed_mean *g = (struct tg_trimmed_mean *)onewayalloc_callocz(r->internal.owa, 1, sizeof(struct tg_trimmed_mean));
    g->series = onewayalloc_mallocz(r->internal.owa, entries * sizeof(NETDATA_DOUBLE));
    g->series_size = (size_t)entries;

    g->percent = def;
    if(options && *options) {
        g->percent = str2ndd(options, NULL);
        if(!netdata_double_isnumber(g->percent)) g->percent = 0.0;
        if(g->percent < 0.0) g->percent = 0.0;
        if(g->percent > 50.0) g->percent = 50.0;
    }

    g->percent = 1.0 - ((g->percent / 100.0) * 2.0);
    r->time_grouping.data = g;
}

static inline void tg_trimmed_mean_create_1(RRDR *r, const char *options) {
    tg_trimmed_mean_create_internal(r, options, 1.0);
}
static inline void tg_trimmed_mean_create_2(RRDR *r, const char *options) {
    tg_trimmed_mean_create_internal(r, options, 2.0);
}
static inline void tg_trimmed_mean_create_3(RRDR *r, const char *options) {
    tg_trimmed_mean_create_internal(r, options, 3.0);
}
static inline void tg_trimmed_mean_create_5(RRDR *r, const char *options) {
    tg_trimmed_mean_create_internal(r, options, 5.0);
}
static inline void tg_trimmed_mean_create_10(RRDR *r, const char *options) {
    tg_trimmed_mean_create_internal(r, options, 10.0);
}
static inline void tg_trimmed_mean_create_15(RRDR *r, const char *options) {
    tg_trimmed_mean_create_internal(r, options, 15.0);
}
static inline void tg_trimmed_mean_create_20(RRDR *r, const char *options) {
    tg_trimmed_mean_create_internal(r, options, 20.0);
}
static inline void tg_trimmed_mean_create_25(RRDR *r, const char *options) {
    tg_trimmed_mean_create_internal(r, options, 25.0);
}

// resets when switches dimensions
// so, clear everything to restart
static inline void tg_trimmed_mean_reset(RRDR *r) {
    struct tg_trimmed_mean *g = (struct tg_trimmed_mean *)r->time_grouping.data;
    g->next_pos = 0;
}

static inline void tg_trimmed_mean_free(RRDR *r) {
    struct tg_trimmed_mean *g = (struct tg_trimmed_mean *)r->time_grouping.data;
    if(g) onewayalloc_freez(r->internal.owa, g->series);

    onewayalloc_freez(r->internal.owa, r->time_grouping.data);
    r->time_grouping.data = NULL;
}

static inline void tg_trimmed_mean_add(RRDR *r, NETDATA_DOUBLE value) {
    struct tg_trimmed_mean *g = (struct tg_trimmed_mean *)r->time_grouping.data;

    if(unlikely(g->next_pos >= g->series_size)) {
        g->series = onewayalloc_doublesize( r->internal.owa, g->series, g->series_size * sizeof(NETDATA_DOUBLE));
        g->series_size *= 2;
    }

    g->series[g->next_pos++] = value;
}

static inline NETDATA_DOUBLE tg_trimmed_mean_flush(RRDR *r, RRDR_VALUE_FLAGS *rrdr_value_options_ptr) {
    struct tg_trimmed_mean *g = (struct tg_trimmed_mean *)r->time_grouping.data;

    NETDATA_DOUBLE value;
    size_t available_slots = g->next_pos;

    if(unlikely(!available_slots)) {
        value = 0.0;
        *rrdr_value_options_ptr |= RRDR_VALUE_EMPTY;
    }
    else if(available_slots == 1) {
        value = g->series[0];
    }
    else {
        sort_series(g->series, available_slots);

        NETDATA_DOUBLE min = g->series[0];
        NETDATA_DOUBLE max = g->series[available_slots - 1];

        if (min != max) {
            size_t slots_to_use = (size_t)((NETDATA_DOUBLE)available_slots * g->percent);
            if(!slots_to_use) slots_to_use = 1;

            NETDATA_DOUBLE percent_to_use = (NETDATA_DOUBLE)slots_to_use / (NETDATA_DOUBLE)available_slots;
            NETDATA_DOUBLE percent_delta = g->percent - percent_to_use;

            NETDATA_DOUBLE percent_interpolation_slot = 0.0;
            NETDATA_DOUBLE percent_last_slot = 0.0;
            if(percent_delta > 0.0) {
                NETDATA_DOUBLE percent_to_use_plus_1_slot = (NETDATA_DOUBLE)(slots_to_use + 1) / (NETDATA_DOUBLE)available_slots;
                NETDATA_DOUBLE percent_1slot = percent_to_use_plus_1_slot - percent_to_use;

                percent_interpolation_slot = percent_delta / percent_1slot;
                percent_last_slot = 1 - percent_interpolation_slot;
            }

            int start_slot, stop_slot, step, last_slot, interpolation_slot;
            if(min >= 0.0 && max >= 0.0) {
                start_slot = (int)((available_slots - slots_to_use) / 2);
                stop_slot = start_slot + (int)slots_to_use;
                last_slot = stop_slot - 1;
                interpolation_slot = stop_slot;
                step = 1;
            }
            else {
                start_slot = (int)available_slots - 1 - (int)((available_slots - slots_to_use) / 2);
                stop_slot = start_slot - (int)slots_to_use;
                last_slot = stop_slot + 1;
                interpolation_slot = stop_slot;
                step = -1;
            }

            value = 0.0;
            for(int slot = start_slot; slot != stop_slot ; slot += step)
                value += g->series[slot];

            size_t counted = slots_to_use;
            if(percent_interpolation_slot > 0.0 && interpolation_slot >= 0 && interpolation_slot < (int)available_slots) {
                value += g->series[interpolation_slot] * percent_interpolation_slot;
                value += g->series[last_slot] * percent_last_slot;
                counted++;
            }

            value = value / (NETDATA_DOUBLE)counted;
        }
        else
            value = min;
    }

    if(unlikely(!netdata_double_isnumber(value))) {
        value = 0.0;
        *rrdr_value_options_ptr |= RRDR_VALUE_EMPTY;
    }

    //log_series_to_stderr(g->series, g->next_pos, value, "trimmed_mean");

    g->next_pos = 0;

    return value;
}

#endif //NETDATA_API_QUERIES_TRIMMED_MEAN_H