dpnp_iface_random.hpp

//*****************************************************************************
// Copyright (c) 2016-2025, Intel Corporation
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
// - Redistributions of source code must retain the above copyright notice,
//   this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright notice,
//   this list of conditions and the following disclaimer in the documentation
//   and/or other materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
// THE POSSIBILITY OF SUCH DAMAGE.
//*****************************************************************************
 
/*
 * This header file is for interface Cython with C++.
 * It should not contains any backend specific headers (like SYCL or math
 * library) because all included headers will be exposed in Cython compilation
 * procedure
 *
 * We would like to avoid backend specific things in higher level Cython
 * modules. Any backend interface functions and types should be defined here.
 *
 * Also, this file should contains documentation on functions and types
 * which are used in the interface
 */
 
#pragma once
#ifndef BACKEND_IFACE_RANDOM_H // Cython compatibility
#define BACKEND_IFACE_RANDOM_H
 
template <typename _DataType>
INP_DLLEXPORT DPCTLSyclEventRef
    dpnp_rng_beta_c(DPCTLSyclQueueRef q_ref,
                    void *result,
                    const _DataType a,
                    const _DataType b,
                    const size_t size,
                    const DPCTLEventVectorRef dep_event_vec_ref);
 
template <typename _DataType>
INP_DLLEXPORT void dpnp_rng_beta_c(void *result,
                                   const _DataType a,
                                   const _DataType b,
                                   const size_t size);
 
template <typename _DataType>
INP_DLLEXPORT DPCTLSyclEventRef
    dpnp_rng_binomial_c(DPCTLSyclQueueRef q_ref,
                        void *result,
                        const int ntrial,
                        const double p,
                        const size_t size,
                        const DPCTLEventVectorRef dep_event_vec_ref);
 
template <typename _DataType>
INP_DLLEXPORT void dpnp_rng_binomial_c(void *result,
                                       const int ntrial,
                                       const double p,
                                       const size_t size);
 
template <typename _DataType>
INP_DLLEXPORT DPCTLSyclEventRef
    dpnp_rng_chisquare_c(DPCTLSyclQueueRef q_ref,
                         void *result,
                         const int df,
                         const size_t size,
                         const DPCTLEventVectorRef dep_event_vec_ref);
 
template <typename _DataType>
INP_DLLEXPORT void
    dpnp_rng_chisquare_c(void *result, const int df, const size_t size);
 
template <typename _DataType>
INP_DLLEXPORT DPCTLSyclEventRef
    dpnp_rng_exponential_c(DPCTLSyclQueueRef q_ref,
                           void *result,
                           const _DataType beta,
                           const size_t size,
                           const DPCTLEventVectorRef dep_event_vec_ref);
 
template <typename _DataType>
INP_DLLEXPORT void dpnp_rng_exponential_c(void *result,
                                          const _DataType beta,
                                          const size_t size);
 
template <typename _DataType>
INP_DLLEXPORT DPCTLSyclEventRef
    dpnp_rng_f_c(DPCTLSyclQueueRef q_ref,
                 void *result,
                 const _DataType df_num,
                 const _DataType df_den,
                 const size_t size,
                 const DPCTLEventVectorRef dep_event_vec_ref);
 
template <typename _DataType>
INP_DLLEXPORT void dpnp_rng_f_c(void *result,
                                const _DataType df_num,
                                const _DataType df_den,
                                const size_t size);
 
template <typename _DataType>
INP_DLLEXPORT DPCTLSyclEventRef
    dpnp_rng_gamma_c(DPCTLSyclQueueRef q_ref,
                     void *result,
                     const _DataType shape,
                     const _DataType scale,
                     const size_t size,
                     const DPCTLEventVectorRef dep_event_vec_ref);
 
template <typename _DataType>
INP_DLLEXPORT void dpnp_rng_gamma_c(void *result,
                                    const _DataType shape,
                                    const _DataType scale,
                                    const size_t size);
 
template <typename _DataType>
INP_DLLEXPORT DPCTLSyclEventRef
    dpnp_rng_gaussian_c(DPCTLSyclQueueRef q_ref,
                        void *result,
                        const _DataType mean,
                        const _DataType stddev,
                        const size_t size,
                        const DPCTLEventVectorRef dep_event_vec_ref);
 
template <typename _DataType>
INP_DLLEXPORT void dpnp_rng_gaussian_c(void *result,
                                       const _DataType mean,
                                       const _DataType stddev,
                                       const size_t size);
 
template <typename _DataType>
INP_DLLEXPORT DPCTLSyclEventRef
    dpnp_rng_geometric_c(DPCTLSyclQueueRef q_ref,
                         void *result,
                         const float p,
                         const size_t size,
                         const DPCTLEventVectorRef dep_event_vec_ref);
 
template <typename _DataType>
INP_DLLEXPORT void
    dpnp_rng_geometric_c(void *result, const float p, const size_t size);
 
template <typename _DataType>
INP_DLLEXPORT DPCTLSyclEventRef
    dpnp_rng_gumbel_c(DPCTLSyclQueueRef q_ref,
                      void *result,
                      const double loc,
                      const double scale,
                      const size_t size,
                      const DPCTLEventVectorRef dep_event_vec_ref);
 
template <typename _DataType>
INP_DLLEXPORT void dpnp_rng_gumbel_c(void *result,
                                     const double loc,
                                     const double scale,
                                     const size_t size);
 
template <typename _DataType>
INP_DLLEXPORT DPCTLSyclEventRef
    dpnp_rng_hypergeometric_c(DPCTLSyclQueueRef q_ref,
                              void *result,
                              const int l,
                              const int s,
                              const int m,
                              const size_t size,
                              const DPCTLEventVectorRef dep_event_vec_ref);
 
template <typename _DataType>
INP_DLLEXPORT void dpnp_rng_hypergeometric_c(void *result,
                                             const int l,
                                             const int s,
                                             const int m,
                                             const size_t size);
 
template <typename _DataType>
INP_DLLEXPORT DPCTLSyclEventRef
    dpnp_rng_laplace_c(DPCTLSyclQueueRef q_ref,
                       void *result,
                       const double loc,
                       const double scale,
                       const size_t size,
                       const DPCTLEventVectorRef dep_event_vec_ref);
 
template <typename _DataType>
INP_DLLEXPORT void dpnp_rng_laplace_c(void *result,
                                      const double loc,
                                      const double scale,
                                      const size_t size);
 
template <typename _DataType>
INP_DLLEXPORT DPCTLSyclEventRef
    dpnp_rng_logistic_c(DPCTLSyclQueueRef q_ref,
                        void *result,
                        const double loc,
                        double const scale,
                        const size_t size,
                        const DPCTLEventVectorRef dep_event_vec_ref);
 
template <typename _DataType>
INP_DLLEXPORT void dpnp_rng_logistic_c(void *result,
                                       const double loc,
                                       double const scale,
                                       const size_t size);
 
template <typename _DataType>
INP_DLLEXPORT DPCTLSyclEventRef
    dpnp_rng_lognormal_c(DPCTLSyclQueueRef q_ref,
                         void *result,
                         const _DataType mean,
                         const _DataType stddev,
                         const size_t size,
                         const DPCTLEventVectorRef dep_event_vec_ref);
 
template <typename _DataType>
INP_DLLEXPORT void dpnp_rng_lognormal_c(void *result,
                                        const _DataType mean,
                                        const _DataType stddev,
                                        const size_t size);
 
template <typename _DataType>
INP_DLLEXPORT DPCTLSyclEventRef
    dpnp_rng_multinomial_c(DPCTLSyclQueueRef q_ref,
                           void *result,
                           const int ntrial,
                           const double *p_in,
                           const size_t p_size,
                           const size_t size,
                           const DPCTLEventVectorRef dep_event_vec_ref);
 
template <typename _DataType>
INP_DLLEXPORT void dpnp_rng_multinomial_c(void *result,
                                          const int ntrial,
                                          const double *p_in,
                                          const size_t p_size,
                                          const size_t size);
 
template <typename _DataType>
INP_DLLEXPORT DPCTLSyclEventRef
    dpnp_rng_multivariate_normal_c(DPCTLSyclQueueRef q_ref,
                                   void *result,
                                   const int dimen,
                                   const double *mean_in,
                                   const size_t mean_size,
                                   const double *cov_in,
                                   const size_t cov_size,
                                   const size_t size,
                                   const DPCTLEventVectorRef dep_event_vec_ref);
 
template <typename _DataType>
INP_DLLEXPORT void dpnp_rng_multivariate_normal_c(void *result,
                                                  const int dimen,
                                                  const double *mean_in,
                                                  const size_t mean_size,
                                                  const double *cov_in,
                                                  const size_t cov_size,
                                                  const size_t size);
 
template <typename _DataType>
INP_DLLEXPORT DPCTLSyclEventRef
    dpnp_rng_negative_binomial_c(DPCTLSyclQueueRef q_ref,
                                 void *result,
                                 const double a,
                                 const double p,
                                 const size_t size,
                                 const DPCTLEventVectorRef dep_event_vec_ref);
 
template <typename _DataType>
INP_DLLEXPORT void dpnp_rng_negative_binomial_c(void *result,
                                                const double a,
                                                const double p,
                                                const size_t size);
 
template <typename _DataType>
INP_DLLEXPORT DPCTLSyclEventRef dpnp_rng_noncentral_chisquare_c(
    DPCTLSyclQueueRef q_ref,
    void *result,
    const _DataType df,
    const _DataType nonc,
    const size_t size,
    const DPCTLEventVectorRef dep_event_vec_ref);
 
template <typename _DataType>
INP_DLLEXPORT void dpnp_rng_noncentral_chisquare_c(void *result,
                                                   const _DataType df,
                                                   const _DataType nonc,
                                                   const size_t size);
 
template <typename _DataType>
INP_DLLEXPORT DPCTLSyclEventRef
    dpnp_rng_normal_c(DPCTLSyclQueueRef q_ref,
                      void *result_out,
                      const double mean,
                      const double stddev,
                      const int64_t size,
                      void *random_state_in,
                      const DPCTLEventVectorRef dep_event_vec_ref);
 
template <typename _DataType>
INP_DLLEXPORT void dpnp_rng_normal_c(void *result,
                                     const _DataType mean,
                                     const _DataType stddev,
                                     const size_t size);
 
template <typename _DataType>
INP_DLLEXPORT DPCTLSyclEventRef
    dpnp_rng_pareto_c(DPCTLSyclQueueRef q_ref,
                      void *result,
                      const double alpha,
                      const size_t size,
                      const DPCTLEventVectorRef dep_event_vec_ref);
 
template <typename _DataType>
INP_DLLEXPORT void
    dpnp_rng_pareto_c(void *result, const double alpha, const size_t size);
 
template <typename _DataType>
INP_DLLEXPORT DPCTLSyclEventRef
    dpnp_rng_poisson_c(DPCTLSyclQueueRef q_ref,
                       void *result,
                       const double lambda,
                       const size_t size,
                       const DPCTLEventVectorRef dep_event_vec_ref);
 
template <typename _DataType>
INP_DLLEXPORT void
    dpnp_rng_poisson_c(void *result, const double lambda, const size_t size);
 
template <typename _DataType>
INP_DLLEXPORT DPCTLSyclEventRef
    dpnp_rng_power_c(DPCTLSyclQueueRef q_ref,
                     void *result,
                     const double alpha,
                     const size_t size,
                     const DPCTLEventVectorRef dep_event_vec_ref);
 
template <typename _DataType>
INP_DLLEXPORT void
    dpnp_rng_power_c(void *result, const double alpha, const size_t size);
 
template <typename _DataType>
INP_DLLEXPORT DPCTLSyclEventRef
    dpnp_rng_rayleigh_c(DPCTLSyclQueueRef q_ref,
                        void *result,
                        const _DataType scale,
                        const size_t size,
                        const DPCTLEventVectorRef dep_event_vec_ref);
 
template <typename _DataType>
INP_DLLEXPORT void
    dpnp_rng_rayleigh_c(void *result, const _DataType scale, const size_t size);
 
template <typename _DataType>
INP_DLLEXPORT DPCTLSyclEventRef
    dpnp_rng_shuffle_c(DPCTLSyclQueueRef q_ref,
                       void *result,
                       const size_t itemsize,
                       const size_t ndim,
                       const size_t high_dim_size,
                       const size_t size,
                       const DPCTLEventVectorRef dep_event_vec_ref);
 
template <typename _DataType>
INP_DLLEXPORT void dpnp_rng_shuffle_c(void *result,
                                      const size_t itemsize,
                                      const size_t ndim,
                                      const size_t high_dim_size,
                                      const size_t size);
 
INP_DLLEXPORT void dpnp_rng_srand_c(size_t seed = 1);
 
template <typename _DataType>
INP_DLLEXPORT DPCTLSyclEventRef
    dpnp_rng_standard_cauchy_c(DPCTLSyclQueueRef q_ref,
                               void *result,
                               const size_t size,
                               const DPCTLEventVectorRef dep_event_vec_ref);
 
template <typename _DataType>
INP_DLLEXPORT void dpnp_rng_standard_cauchy_c(void *result, const size_t size);
 
template <typename _DataType>
INP_DLLEXPORT DPCTLSyclEventRef dpnp_rng_standard_exponential_c(
    DPCTLSyclQueueRef q_ref,
    void *result,
    const size_t size,
    const DPCTLEventVectorRef dep_event_vec_ref);
 
template <typename _DataType>
INP_DLLEXPORT void dpnp_rng_standard_exponential_c(void *result,
                                                   const size_t size);
 
template <typename _DataType>
INP_DLLEXPORT DPCTLSyclEventRef
    dpnp_rng_standard_gamma_c(DPCTLSyclQueueRef q_ref,
                              void *result,
                              const _DataType shape,
                              const size_t size,
                              const DPCTLEventVectorRef dep_event_vec_ref);
 
template <typename _DataType>
INP_DLLEXPORT void dpnp_rng_standard_gamma_c(void *result,
                                             const _DataType shape,
                                             const size_t size);
 
template <typename _DataType>
INP_DLLEXPORT void dpnp_rng_standard_normal_c(void *result, const size_t size);
 
template <typename _DataType>
INP_DLLEXPORT DPCTLSyclEventRef
    dpnp_rng_standard_t_c(DPCTLSyclQueueRef q_ref,
                          void *result,
                          const _DataType df,
                          const size_t size,
                          const DPCTLEventVectorRef dep_event_vec_ref);
 
template <typename _DataType>
INP_DLLEXPORT void
    dpnp_rng_standard_t_c(void *result, const _DataType df, const size_t size);
 
template <typename _DataType>
INP_DLLEXPORT DPCTLSyclEventRef
    dpnp_rng_triangular_c(DPCTLSyclQueueRef q_ref,
                          void *result,
                          const _DataType x_min,
                          const _DataType x_mode,
                          const _DataType x_max,
                          const size_t size,
                          const DPCTLEventVectorRef dep_event_vec_ref);
 
template <typename _DataType>
INP_DLLEXPORT void dpnp_rng_triangular_c(void *result,
                                         const _DataType x_min,
                                         const _DataType x_mode,
                                         const _DataType x_max,
                                         const size_t size);
 
template <typename _DataType>
INP_DLLEXPORT DPCTLSyclEventRef
    dpnp_rng_uniform_c(DPCTLSyclQueueRef q_ref,
                       void *result_out,
                       const double low,
                       const double high,
                       const int64_t size,
                       void *random_state_in,
                       const DPCTLEventVectorRef dep_event_vec_ref);
 
template <typename _DataType>
INP_DLLEXPORT void dpnp_rng_uniform_c(void *result,
                                      const long low,
                                      const long high,
                                      const size_t size);
 
template <typename _DataType>
INP_DLLEXPORT DPCTLSyclEventRef
    dpnp_rng_vonmises_c(DPCTLSyclQueueRef q_ref,
                        void *result,
                        const _DataType mu,
                        const _DataType kappa,
                        const size_t size,
                        const DPCTLEventVectorRef dep_event_vec_ref);
 
template <typename _DataType>
INP_DLLEXPORT void dpnp_rng_vonmises_c(void *result,
                                       const _DataType mu,
                                       const _DataType kappa,
                                       const size_t size);
 
template <typename _DataType>
INP_DLLEXPORT DPCTLSyclEventRef
    dpnp_rng_wald_c(DPCTLSyclQueueRef q_ref,
                    void *result,
                    const _DataType mean,
                    const _DataType scale,
                    size_t size,
                    const DPCTLEventVectorRef dep_event_vec_ref);
 
template <typename _DataType>
INP_DLLEXPORT void dpnp_rng_wald_c(void *result,
                                   const _DataType mean,
                                   const _DataType scale,
                                   size_t size);
 
template <typename _DataType>
INP_DLLEXPORT DPCTLSyclEventRef
    dpnp_rng_weibull_c(DPCTLSyclQueueRef q_ref,
                       void *result,
                       const double alpha,
                       const size_t size,
                       const DPCTLEventVectorRef dep_event_vec_ref);
 
template <typename _DataType>
INP_DLLEXPORT void
    dpnp_rng_weibull_c(void *result, const double alpha, const size_t size);
 
template <typename _DataType>
INP_DLLEXPORT DPCTLSyclEventRef
    dpnp_rng_zipf_c(DPCTLSyclQueueRef q_ref,
                    void *result,
                    const _DataType a,
                    const size_t size,
                    const DPCTLEventVectorRef dep_event_vec_ref);
 
template <typename _DataType>
INP_DLLEXPORT void
    dpnp_rng_zipf_c(void *result, const _DataType a, const size_t size);
 
#endif // BACKEND_IFACE_RANDOM_H