util.h (2020-10-27 00:11:00 -0400, (build d99887ae))

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:
 * https://arrayfire.com/licenses/BSD-3-Clause
 ********************************************************/

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

#ifdef __cplusplus
namespace af
{
    class array;

    AFAPI void print(const char *exp, const array &arr);

#if AF_API_VERSION >= 31

    AFAPI void print(const char *exp, const array &arr, const int precision);
#endif

#if AF_API_VERSION >= 31

    AFAPI int saveArray(const char *key, const array &arr, const char *filename, const bool append = false);
#endif

#if AF_API_VERSION >= 31

    AFAPI array readArray(const char *filename, const unsigned index);
#endif

#if AF_API_VERSION >= 31

    AFAPI array readArray(const char *filename, const char *key);
#endif

#if AF_API_VERSION >= 31

    AFAPI int readArrayCheck(const char *filename, const char *key);
#endif

#if AF_API_VERSION >= 31

    AFAPI void toString(char **output, const char *exp, const array &arr,
                        const int precision = 4, const bool transpose = true);
#endif

#if AF_API_VERSION >= 33

    AFAPI const char* toString(const char *exp, const array &arr,
                               const int precision = 4, const bool transpose = true);
#endif

    // Purpose of Addition: "How to add Function" documentation
    AFAPI array exampleFunction(const array& in, const af_someenum_t param);

#if AF_API_VERSION >= 34
    AFAPI size_t getSizeOf(af::dtype type);
#endif
}

#if AF_API_VERSION >= 31

#define AF_PRINT1(exp)            af::print(#exp, exp);
#define AF_PRINT2(exp, precision) af::print(#exp, exp, precision);

#define GET_PRINT_MACRO(_1, _2, NAME, ...) NAME

#define af_print(...) GET_PRINT_MACRO(__VA_ARGS__, AF_PRINT2, AF_PRINT1)(__VA_ARGS__)

#else // AF_API_VERSION

#define af_print(exp) af::print(#exp, exp);

#endif // AF_API_VERSION

#endif //__cplusplus

#ifdef __cplusplus
extern "C" {
#endif

    AFAPI af_err af_print_array(af_array arr);

#if AF_API_VERSION >= 31

    AFAPI af_err af_print_array_gen(const char *exp, const af_array arr, const int precision);
#endif

#if AF_API_VERSION >= 31

    AFAPI af_err af_save_array(int *index, const char* key, const af_array arr, const char *filename, const bool append);
#endif

#if AF_API_VERSION >= 31

    AFAPI af_err af_read_array_index(af_array *out, const char *filename, const unsigned index);
#endif

#if AF_API_VERSION >= 31

    AFAPI af_err af_read_array_key(af_array *out, const char *filename, const char* key);
#endif

#if AF_API_VERSION >= 31

    AFAPI af_err af_read_array_key_check(int *index, const char *filename, const char* key);
#endif

#if AF_API_VERSION >= 31

    AFAPI af_err af_array_to_string(char **output, const char *exp, const af_array arr,
                                    const int precision, const bool transpose);
#endif

    // Purpose of Addition: "How to add Function" documentation
    AFAPI af_err af_example_function(af_array* out,
                                     const af_array in,
                                     const af_someenum_t param);

    AFAPI af_err af_get_version(int *major, int *minor, int *patch);


#if AF_API_VERSION >= 33
    AFAPI const char *af_get_revision();
#endif

#if AF_API_VERSION >= 34
    AFAPI af_err af_get_size_of(size_t *size, af_dtype type);
#endif

#if AF_API_VERSION >= 37
    AFAPI af_err af_set_enable_stacktrace(int is_enabled);
#endif

#ifdef __cplusplus
}
#endif