data.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
#include <af/dim4.hpp>
#include <af/traits.hpp>
namespace af
{
    class array;

    template<typename T>
    array constant(T val, const dim4 &dims, const dtype ty=(af_dtype)dtype_traits<T>::ctype);

    template<typename T>
    array constant(T val, const dim_t d0, const af_dtype ty=(af_dtype)dtype_traits<T>::ctype);

    template<typename T>
    array constant(T val, const dim_t d0, const dim_t d1, const af_dtype ty=(af_dtype)dtype_traits<T>::ctype);

    template<typename T>
    array constant(T val, const dim_t d0, const dim_t d1, const dim_t d2, const af_dtype ty=(af_dtype)dtype_traits<T>::ctype);

    template<typename T>
    array constant(T val, const dim_t d0, const dim_t d1, const dim_t d2, const dim_t d3, const af_dtype ty=(af_dtype)dtype_traits<T>::ctype);

    AFAPI array randu(const dim4 &dims, const dtype ty=f32);

    AFAPI array randu(const dim_t d0, const dtype ty=f32);

    AFAPI array randu(const dim_t d0,
                      const dim_t d1, const dtype ty=f32);

    AFAPI array randu(const dim_t d0,
                      const dim_t d1, const dim_t d2, const dtype ty=f32);

    AFAPI array randu(const dim_t d0,
                      const dim_t d1, const dim_t d2,
                      const dim_t d3, const dtype ty=f32);

    AFAPI array randn(const dim4 &dims, const dtype ty=f32);

    AFAPI array randn(const dim_t d0, const dtype ty=f32);
    AFAPI array randn(const dim_t d0,
                      const dim_t d1, const dtype ty=f32);
    AFAPI array randn(const dim_t d0,
                      const dim_t d1, const dim_t d2, const dtype ty=f32);

    AFAPI array randn(const dim_t d0,
                      const dim_t d1, const dim_t d2,
                      const dim_t d3, const dtype ty=f32);

    AFAPI void setSeed(const uintl seed);

    AFAPI uintl getSeed();


    AFAPI array identity(const dim4 &dims, const dtype ty=f32);

    AFAPI array identity(const dim_t d0, const dtype ty=f32);

    AFAPI array identity(const dim_t d0, const dim_t d1, const dtype ty=f32);

    AFAPI array identity(const dim_t d0, const dim_t d1,
                         const dim_t d2, const dtype ty=f32);

    AFAPI array identity(const dim_t d0, const dim_t d1,
                         const dim_t d2, const dim_t d3, const dtype ty=f32);

    AFAPI array range(const dim4 &dims, const int seq_dim = -1, const dtype ty=f32);

    AFAPI array range(const dim_t d0, const dim_t d1 = 1, const dim_t d2 = 1,
                      const dim_t d3 = 1, const int seq_dim = -1, const dtype ty=f32);

    AFAPI array iota(const dim4 &dims, const dim4 &tile_dims = dim4(1), const dtype ty=f32);

    AFAPI array diag(const array &in, const int num = 0, const bool extract = true);

    AFAPI array join(const int dim, const array &first, const array &second);

    AFAPI array join(const int dim, const array &first, const array &second, const array &third);

    AFAPI array join(const int dim, const array &first, const array &second,
                     const array &third, const array &fourth);

    AFAPI array tile(const array &in, const unsigned x, const unsigned y=1,
                     const unsigned z=1, const unsigned w=1);

    AFAPI array tile(const array &in, const dim4 &dims);

    AFAPI array reorder(const array& in, const unsigned x,
                        const unsigned y=1, const unsigned z=2, const unsigned w=3);

    AFAPI array shift(const array& in, const int x, const int y=0, const int z=0, const int w=0);

    AFAPI array moddims(const array& in, const unsigned ndims, const dim_t * const dims);

    AFAPI array moddims(const array& in, const dim4& dims);

    AFAPI array moddims(const array& in, const dim_t d0, const dim_t d1=1, const dim_t d2=1, const dim_t d3=1);

    AFAPI array flat(const array &in);

    AFAPI array flip(const array &in, const unsigned dim);

    AFAPI array lower(const array &in, bool is_unit_diag=false);

    AFAPI array upper(const array &in, bool is_unit_diag=false);

#if AF_API_VERSION >= 31

    AFAPI array select(const array &cond, const array  &a, const array  &b);
#endif

#if AF_API_VERSION >= 31

    AFAPI array select(const array &cond, const array  &a, const double &b);
#endif

#if AF_API_VERSION >= 31

    AFAPI array select(const array &cond, const double &a, const array  &b);
#endif

#if AF_API_VERSION >= 31

    AFAPI void replace(array &a, const array  &cond, const array  &b);
#endif

#if AF_API_VERSION >= 31

    AFAPI void replace(array &a, const array  &cond, const double &b);
#endif

}
#endif

#ifdef __cplusplus
extern "C" {
#endif


    AFAPI af_err af_constant(af_array *arr, const double val, const unsigned ndims, const dim_t * const dims, const af_dtype type);

    AFAPI af_err af_constant_complex(af_array *arr, const double real, const double imag,
                                     const unsigned ndims, const dim_t * const dims, const af_dtype type);

    AFAPI af_err af_constant_long (af_array *arr, const  intl val, const unsigned ndims, const dim_t * const dims);

    AFAPI af_err af_constant_ulong(af_array *arr, const uintl val, const unsigned ndims, const dim_t * const dims);
    AFAPI af_err af_range(af_array *out, const unsigned ndims, const dim_t * const dims,
                          const int seq_dim, const af_dtype type);

    AFAPI af_err af_iota(af_array *out, const unsigned ndims, const dim_t * const dims,
                         const unsigned t_ndims, const dim_t * const tdims, const af_dtype type);

    AFAPI af_err af_randu(af_array *out, const unsigned ndims, const dim_t * const dims, const af_dtype type);

    AFAPI af_err af_randn(af_array *out, const unsigned ndims, const dim_t * const dims, const af_dtype type);

    AFAPI af_err af_set_seed(const uintl seed);

    AFAPI af_err af_get_seed(uintl *seed);


    AFAPI af_err af_identity(af_array *out, const unsigned ndims, const dim_t * const dims, const af_dtype type);

    AFAPI af_err af_diag_create(af_array *out, const af_array in, const int num);

    AFAPI af_err af_diag_extract(af_array *out, const af_array in, const int num);

    AFAPI af_err af_join(af_array *out, const int dim, const af_array first, const af_array second);

    AFAPI af_err af_join_many(af_array *out, const int dim, const unsigned n_arrays, const af_array *inputs);

    AFAPI af_err af_tile(af_array *out, const af_array in,
                         const unsigned x, const unsigned y, const unsigned z, const unsigned w);

    AFAPI af_err af_reorder(af_array *out, const af_array in,
                            const unsigned x, const unsigned y, const unsigned z, const unsigned w);

    AFAPI af_err af_shift(af_array *out, const af_array in, const int x, const int y, const int z, const int w);

    AFAPI af_err af_moddims(af_array *out, const af_array in, const unsigned ndims, const dim_t * const dims);

    AFAPI af_err af_flat(af_array *out, const af_array in);

    AFAPI af_err af_flip(af_array *out, const af_array in, const unsigned dim);

    AFAPI af_err af_lower(af_array *out, const af_array in, bool is_unit_diag);

    AFAPI af_err af_upper(af_array *out, const af_array in, bool is_unit_diag);
#if AF_API_VERSION >= 31

    AFAPI af_err af_select(af_array *out, const af_array cond, const af_array a, const af_array b);
#endif

#if AF_API_VERSION >= 31

    AFAPI af_err af_select_scalar_r(af_array *out, const af_array cond, const af_array a, const double b);
#endif

#if AF_API_VERSION >= 31

    AFAPI af_err af_select_scalar_l(af_array *out, const af_array cond, const double a, const af_array b);
#endif

#if AF_API_VERSION >= 31

    AFAPI af_err af_replace(af_array a, const af_array cond, const af_array b);
#endif

#if AF_API_VERSION >= 31

    AFAPI af_err af_replace_scalar(af_array a, const af_array cond, const double b);
#endif

#ifdef __cplusplus
}
#endif