statistics.h

Go to the documentation of this file.

/*******************************************************
 * Copyright (c) 2014, ArrayFire
 * All rights reserved.
 *
 * This file is distributed under 3-clause BSD license.
 * The complete license agreement can be obtained at:
 * http://arrayfire.com/licenses/BSD-3-Clause
 ********************************************************/

#pragma once
#include <af/defines.h>

#ifdef __cplusplus
namespace af
{
class array;

AFAPI array mean(const array& in, const dim_t dim=-1);

AFAPI array mean(const array& in, const array& weights, const dim_t dim=-1);

AF_DEPRECATED("Use \ref af::var(const array&, const af_var_bias, const dim_t)")
AFAPI array var(const array& in, const bool isbiased=false, const dim_t dim=-1);

#if AF_API_VERSION >= 38

AFAPI array var(const array &in, const af_var_bias bias, const dim_t dim = -1);
#endif

AFAPI array var(const array& in, const array &weights, const dim_t dim=-1);

#if AF_API_VERSION >= 37

AFAPI void meanvar(array& mean, array& var, const array& in, const array& weights,
                   const af_var_bias bias = AF_VARIANCE_POPULATION, const dim_t dim=-1);
#endif

AF_DEPRECATED("Use af::stdev(const array&, const af_var_bias, const dim_t)")
AFAPI array stdev(const array& in, const dim_t dim=-1);

#if AF_API_VERSION >= 38

AFAPI array stdev(const array &in, const af_var_bias bias,
                  const dim_t dim = -1);
#endif

AF_DEPRECATED("Use af::cov(const af::array&, const array&, conv af_var_bias)")
AFAPI array cov(const array& X, const array& Y, const bool isbiased=false);

#if AF_API_VERSION >= 38

AFAPI array cov(const array &X, const array &Y, const af_var_bias bias);
#endif

AFAPI array median(const array& in, const dim_t dim=-1);

template<typename T>
AFAPI T mean(const array& in);

template<typename T>
AFAPI T mean(const array& in, const array& weights);

template <typename T>
AF_DEPRECATED("Use af::var(const af::array&, const af_var_bias)")
AFAPI T var(const array &in, const bool isbiased = false);

#if AF_API_VERSION >= 38

template <typename T> AFAPI T var(const array &in, const af_var_bias bias);
#endif

template<typename T>
AFAPI T var(const array& in, const array& weights);

template <typename T>
AF_DEPRECATED("Use af::stdev(const array&, const af_var_bias)")
AFAPI T stdev(const array &in);

#if AF_API_VERSION >= 38

template <typename T> AFAPI T stdev(const array &in, const af_var_bias bias);
#endif

template<typename T>
AFAPI T median(const array& in);

template<typename T>
AFAPI T corrcoef(const array& X, const array& Y);

#if AF_API_VERSION >= 36

AFAPI void topk(array &values, array &indices, const array& in, const int k,
                const int dim = -1, const topkFunction order = AF_TOPK_MAX);
#endif
}
#endif

#ifdef __cplusplus
extern "C" {
#endif

AFAPI af_err af_mean(af_array *out, const af_array in, const dim_t dim);

AFAPI af_err af_mean_weighted(af_array *out, const af_array in, const af_array weights, const dim_t dim);

AF_DEPRECATED("Use af_var_v2")
AFAPI af_err af_var(af_array *out, const af_array in, const bool isbiased, const dim_t dim);

#if AF_API_VERSION >= 38

AFAPI af_err af_var_v2(af_array *out, const af_array in, const af_var_bias bias,
                       const dim_t dim);
#endif

AFAPI af_err af_var_weighted(af_array *out, const af_array in, const af_array weights, const dim_t dim);

#if AF_API_VERSION >= 37

AFAPI af_err af_meanvar(af_array *mean, af_array *var, const af_array in,
                        const af_array weights, const af_var_bias bias, const dim_t dim);
#endif

AF_DEPRECATED("Use af_stdev_v2")
AFAPI af_err af_stdev(af_array *out, const af_array in, const dim_t dim);

#if AF_API_VERSION >= 38

AFAPI af_err af_stdev_v2(af_array *out, const af_array in,
                         const af_var_bias bias, const dim_t dim);
#endif

AF_DEPRECATED("Use af_cov_v2")
AFAPI af_err af_cov(af_array* out, const af_array X, const af_array Y, const bool isbiased);

#if AF_API_VERSION >= 38

AFAPI af_err af_cov_v2(af_array *out, const af_array X, const af_array Y,
                       const af_var_bias bias);
#endif

AFAPI af_err af_median(af_array* out, const af_array in, const dim_t dim);

AFAPI af_err af_mean_all(double *real, double *imag, const af_array in);

AFAPI af_err af_mean_all_weighted(double *real, double *imag, const af_array in, const af_array weights);


AF_DEPRECATED("Use af_var_all_v2")
AFAPI af_err af_var_all(double *realVal, double *imagVal, const af_array in, const bool isbiased);

#if AF_API_VERSION >= 38

AFAPI af_err af_var_all_v2(double *realVal, double *imagVal, const af_array in,
                           const af_var_bias bias);
#endif

AFAPI af_err af_var_all_weighted(double *realVal, double *imagVal, const af_array in, const af_array weights);

AF_DEPRECATED("Use af_stdev_all_v2")
AFAPI af_err af_stdev_all(double *real, double *imag, const af_array in);

#if AF_API_VERSION >= 38

AFAPI af_err af_stdev_all_v2(double *real, double *imag, const af_array in,
                             const af_var_bias bias);
#endif

AFAPI af_err af_median_all(double *realVal, double *imagVal, const af_array in);

AFAPI af_err af_corrcoef(double *realVal, double *imagVal, const af_array X, const af_array Y);

#if AF_API_VERSION >= 36

AFAPI af_err af_topk(af_array *values, af_array *indices, const af_array in,
                     const int k, const int dim, const af_topk_function order);
#endif

#ifdef __cplusplus
}
#endif