-module(dqe_confidence).
-behaviour(dqe_fun).

-include_lib("mmath/include/mmath.hrl").

-export([spec/0, describe/1, init/1, chunk/1, resolution/2, run/2, help/0]).

-record(state, {
         }).

init([]) ->
    #state{}.

chunk(#state{}) ->
    ?RDATA_SIZE.

resolution(_Resolution, State) ->
    {1, State}.

describe(#state{}) ->
    ["confidence()"].

spec() ->
    {<<"confidence">>, [metric], none, metric}.

run([Data], S = #state{}) ->
    {mmath_trans:confidence(Data), S}.

help() ->
    <<"Converts the metric from the value at a given time into the confidence "
      "at a given time. This can be either applied to raw serieses or "
      "aggregates. The return value is a float between 0 and 1.">>.