random.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>

typedef void * af_random_engine;

#ifdef __cplusplus
namespace af
{
    class array;
    class dim4;
#if AF_API_VERSION >= 34
    class AFAPI randomEngine {
    private:
      af_random_engine engine;

    public:
      explicit randomEngine(randomEngineType typeIn = AF_RANDOM_ENGINE_DEFAULT,
                            unsigned long long seedIn = 0);

      randomEngine(const randomEngine &other);

      randomEngine(af_random_engine engine);

      ~randomEngine();

      randomEngine &operator=(const randomEngine &other);

      void setType(const randomEngineType type);

      randomEngineType getType(void);

      void setSeed(const unsigned long long seed);

      unsigned long long getSeed(void) const;

      af_random_engine get(void) const;
    };
#endif

#if AF_API_VERSION >= 34

    AFAPI array randu(const dim4 &dims, const dtype ty, randomEngine &r);
#endif

#if AF_API_VERSION >= 34

    AFAPI array randn(const dim4 &dims, const dtype ty, randomEngine &r);
#endif

    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);

#if AF_API_VERSION >= 34

    AFAPI void setDefaultRandomEngineType(randomEngineType rtype);
#endif

#if AF_API_VERSION >= 34

    AFAPI randomEngine getDefaultRandomEngine(void);
#endif

    AFAPI void setSeed(const unsigned long long seed);

    AFAPI unsigned long long getSeed();

}
#endif

#ifdef __cplusplus
extern "C" {
#endif

#if AF_API_VERSION >= 34

    AFAPI af_err af_create_random_engine(af_random_engine *engine,
                                         af_random_engine_type rtype,
                                         unsigned long long seed);
#endif

#if AF_API_VERSION >= 34

    AFAPI af_err af_retain_random_engine(af_random_engine *out,
                                         const af_random_engine engine);
#endif

#if AF_API_VERSION >= 34

    AFAPI af_err af_random_engine_set_type(af_random_engine *engine,
                                           const af_random_engine_type rtype);
#endif

#if AF_API_VERSION >= 34

    AFAPI af_err af_random_engine_get_type(af_random_engine_type *rtype,
                                           const af_random_engine engine);
#endif

#if AF_API_VERSION >= 34

    AFAPI af_err af_random_uniform(af_array *out, const unsigned ndims,
                                   const dim_t * const dims, const af_dtype type,
                                   af_random_engine engine);
#endif

#if AF_API_VERSION >= 34

    AFAPI af_err af_random_normal(af_array *out, const unsigned ndims,
                                  const dim_t * const dims, const af_dtype type,
                                  af_random_engine engine);
#endif

#if AF_API_VERSION >= 34

    AFAPI af_err af_random_engine_set_seed(af_random_engine *engine,
                                           const unsigned long long seed);
#endif

#if AF_API_VERSION >= 34

    AFAPI af_err af_get_default_random_engine(af_random_engine *engine);
#endif

#if AF_API_VERSION >= 34

    AFAPI af_err af_set_default_random_engine_type(const af_random_engine_type rtype);
#endif

#if AF_API_VERSION >= 34

    AFAPI af_err af_random_engine_get_seed(unsigned long long * const seed,
                                           af_random_engine engine);
#endif

#if AF_API_VERSION >= 34

    AFAPI af_err af_release_random_engine(af_random_engine engine);
#endif

    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 unsigned long long seed);

    AFAPI af_err af_get_seed(unsigned long long *seed);

#ifdef __cplusplus
}
#endif