/**
 * @file sample_utilites.h
 * @brief
 * @author Cat (null.null.null@qq.com)
 * @version 0.1
 * @date 2021-06-04
 *
 * Company: Baosight Co. Ltd.
 * DO NOT COPY/USE WITHOUT PERMISSION
 *
 */
#pragma once
#include <eqpalg/stat_tools/SampleTrendAnalysis.h>
#include <string>
using std::string;
namespace utility {

/**
 * @brief 产生样本描述
 * @param  sample           总样本信息
 * @param  real_value       输入的实际值
 * @param  diff             合法区间
 * @return string           产生的样本描述
 */
string generate_sample_describe(SampleTrendAnalysis *sample, double real_value,
                                double diff);

/**
 * @brief 判断样本是否应该报警
 * @param  sample           总采样信息
 * @param  real_value       输入的实际值
 * @param  diff             运行的差值
 * @return true             样本应报警
 * @return false            样本不应报警
 */
bool is_alarm_value(SampleTrendAnalysis *sample, double real_value,
                    double diff);

/**
 * @brief 判断样本是否应该报警 *无报警下限，适用于样本判断偏差是否合法的算法
 * @param  sample           总采样信息
 * @param  real_value       输入的实际值
 * @param  diff             运行的差值
 * @return true             样本应报警
 * @return false            样本不应报警
 */
bool is_alarm_value_no_down_lim(SampleTrendAnalysis *sample, double real_value,
                                double diff);
} // namespace utility