random.hpp

Go to the documentation of this file.

#ifndef CYTNX_RANDOM_H_
#define CYTNX_RANDOM_H_
 
#include "Type.hpp"
#include "Device.hpp"
#include "cytnx_error.hpp"
#include <vector>
#include <initializer_list>
#include <random>
#include "Tensor.hpp"
#include "UniTensor.hpp"
 
#include "backend/Storage.hpp"
 
namespace cytnx {
  namespace random {
    // Actual definition is in uniform_.cpp
    extern std::random_device __static_random_device;
 
    // [Storage]
    // =============================================================================================================
    // =============================================================================================================
    // normal_:
    //--------------------------------------------------
    void normal_(cytnx::Storage &Sin, const double &mean, const double &std,
                 const unsigned int &seed = __static_random_device());
 
    // uniform_:
    //--------------------------------------------------
    void uniform_(cytnx::Storage &Sin, const double &low = 0, const double &high = 1,
                  const unsigned int &seed = __static_random_device());
 
    // [Tensor]
    // =============================================================================================================
    // =============================================================================================================
    // normal_:
    //-------------------------------------------------
    void normal_(cytnx::Tensor &Tin, const double &mean, const double &std,
                 const unsigned int &seed = __static_random_device());
 
    // uniform_:
    //--------------------------------------------------
    void uniform_(cytnx::Tensor &Tin, const double &low = 0, const double &high = 1,
                  const unsigned int &seed = __static_random_device());
 
    // [UniTensor]
    // =============================================================================================================
    // =============================================================================================================
    // normal_:
    //-------------------------------------------------
    void normal_(cytnx::UniTensor &Tin, const double &mean, const double &std,
                 const unsigned int &seed = __static_random_device());
 
    // uniform_:
    //--------------------------------------------------
    void uniform_(cytnx::UniTensor &Tin, const double &low = 0, const double &high = 1,
                  const unsigned int &seed = __static_random_device());
 
    // normal:
 
    Tensor normal(const cytnx_uint64 &Nelem, const double &mean, const double &std,
                  const int &device = Device.cpu,
                  const unsigned int &seed = __static_random_device(),
                  const unsigned int &dtype = Type.Double);
 
    Tensor normal(const std::vector<cytnx_uint64> &Nelem, const double &mean, const double &std,
                  const int &device = Device.cpu,
                  const unsigned int &seed = __static_random_device(),
                  const unsigned int &dtype = Type.Double);
 
    // uniform:
 
    Tensor uniform(const cytnx_uint64 &Nelem, const double &low, const double &high,
                   const int &device = Device.cpu,
                   const unsigned int &seed = __static_random_device(),
                   const unsigned int &dtype = Type.Double);
 
    Tensor uniform(const std::vector<cytnx_uint64> &Nelem, const double &low, const double &high,
                   const int &device = Device.cpu,
                   const unsigned int &seed = __static_random_device(),
                   const unsigned int &dtype = Type.Double);
 
    Tensor random_tensor(const std::vector<cytnx_uint64> &shape, const double &low = -10.0,
                         const double &high = 10.0, const int &device = Device.cpu,
                         const unsigned int &seed = __static_random_device(),
                         const unsigned int &dtype = Type.Double);
 
    // this is going to deprecated:
    template <class T>
    [[deprecated("Use random::normal_ instead")]] void Make_normal(
      T &In, const double &mean, const double &std,
      const unsigned int &seed = __static_random_device()) {
      normal_(In, mean, std, seed);
    }
    template <class T>
    [[deprecated("Use random::uniform_ instead")]] void Make_uniform(
      T &In, const double &low, const double &high,
      const unsigned int &seed = __static_random_device()) {
      uniform_(In, low, high, seed);
    }
 
 
  }  // namespace random
}  // namespace cytnx
 
#endif  // CYTNX_RANDOM_H_