dpnp_iface_fptr.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_FPTR_H // Cython compatibility
#define BACKEND_IFACE_FPTR_H
 
#include <dpnp_iface.hpp>
 
enum class DPNPFuncName : size_t
{
    DPNP_FN_NONE,    
    DPNP_FN_ERF,     
    DPNP_FN_ERF_EXT, 
    DPNP_FN_INITVAL, 
    DPNP_FN_INITVAL_EXT, 
    DPNP_FN_MODF,        
    DPNP_FN_MODF_EXT,  
    DPNP_FN_ONES,      
    DPNP_FN_ONES_LIKE, 
    DPNP_FN_PARTITION, 
    DPNP_FN_PARTITION_EXT, 
    DPNP_FN_RNG_BETA,      
    DPNP_FN_RNG_BETA_EXT,  
    DPNP_FN_RNG_BINOMIAL,  
    DPNP_FN_RNG_BINOMIAL_EXT,  
    DPNP_FN_RNG_CHISQUARE,     
    DPNP_FN_RNG_CHISQUARE_EXT, 
    DPNP_FN_RNG_EXPONENTIAL,   
    DPNP_FN_RNG_EXPONENTIAL_EXT, 
    DPNP_FN_RNG_F,               
    DPNP_FN_RNG_F_EXT,        
    DPNP_FN_RNG_GAMMA,        
    DPNP_FN_RNG_GAMMA_EXT,    
    DPNP_FN_RNG_GAUSSIAN,     
    DPNP_FN_RNG_GAUSSIAN_EXT, 
    DPNP_FN_RNG_GEOMETRIC,    
    DPNP_FN_RNG_GEOMETRIC_EXT, 
    DPNP_FN_RNG_GUMBEL,        
    DPNP_FN_RNG_GUMBEL_EXT,    
    DPNP_FN_RNG_HYPERGEOMETRIC, 
    DPNP_FN_RNG_HYPERGEOMETRIC_EXT, 
    DPNP_FN_RNG_LAPLACE,            
    DPNP_FN_RNG_LAPLACE_EXT,        
    DPNP_FN_RNG_LOGISTIC,      
    DPNP_FN_RNG_LOGISTIC_EXT,  
    DPNP_FN_RNG_LOGNORMAL,     
    DPNP_FN_RNG_LOGNORMAL_EXT, 
    DPNP_FN_RNG_MULTINOMIAL,   
    DPNP_FN_RNG_MULTINOMIAL_EXT, 
    DPNP_FN_RNG_MULTIVARIATE_NORMAL,     
    DPNP_FN_RNG_MULTIVARIATE_NORMAL_EXT, 
    DPNP_FN_RNG_NEGATIVE_BINOMIAL, 
    DPNP_FN_RNG_NEGATIVE_BINOMIAL_EXT,    
    DPNP_FN_RNG_NONCENTRAL_CHISQUARE,     
    DPNP_FN_RNG_NONCENTRAL_CHISQUARE_EXT, 
    DPNP_FN_RNG_NORMAL,       
    DPNP_FN_RNG_NORMAL_EXT,   
    DPNP_FN_RNG_PARETO,       
    DPNP_FN_RNG_PARETO_EXT,   
    DPNP_FN_RNG_POISSON,      
    DPNP_FN_RNG_POISSON_EXT,  
    DPNP_FN_RNG_POWER,        
    DPNP_FN_RNG_POWER_EXT,    
    DPNP_FN_RNG_RAYLEIGH,     
    DPNP_FN_RNG_RAYLEIGH_EXT, 
    DPNP_FN_RNG_SRAND,        
    DPNP_FN_RNG_SRAND_EXT, 
    DPNP_FN_RNG_SHUFFLE,   
    DPNP_FN_RNG_SHUFFLE_EXT, 
    DPNP_FN_RNG_STANDARD_CAUCHY,     
    DPNP_FN_RNG_STANDARD_CAUCHY_EXT, 
    DPNP_FN_RNG_STANDARD_EXPONENTIAL,     
    DPNP_FN_RNG_STANDARD_EXPONENTIAL_EXT, 
    DPNP_FN_RNG_STANDARD_GAMMA, 
    DPNP_FN_RNG_STANDARD_GAMMA_EXT, 
    DPNP_FN_RNG_STANDARD_NORMAL,    
    DPNP_FN_RNG_STANDARD_T,     
    DPNP_FN_RNG_STANDARD_T_EXT, 
    DPNP_FN_RNG_TRIANGULAR,     
    DPNP_FN_RNG_TRIANGULAR_EXT, 
    DPNP_FN_RNG_UNIFORM,        
    DPNP_FN_RNG_UNIFORM_EXT,  
    DPNP_FN_RNG_VONMISES,     
    DPNP_FN_RNG_VONMISES_EXT, 
    DPNP_FN_RNG_WALD,         
    DPNP_FN_RNG_WALD_EXT, 
    DPNP_FN_RNG_WEIBULL,  
    DPNP_FN_RNG_WEIBULL_EXT, 
    DPNP_FN_RNG_ZIPF,        
    DPNP_FN_RNG_ZIPF_EXT, 
    DPNP_FN_ZEROS,        
    DPNP_FN_ZEROS_LIKE,   
    DPNP_FN_LAST,         
};
 
enum class DPNPFuncType : size_t
{
    DPNP_FT_NONE,    
    DPNP_FT_BOOL,    
    DPNP_FT_INT,     
    DPNP_FT_LONG,    
    DPNP_FT_FLOAT,   
    DPNP_FT_DOUBLE,  
    DPNP_FT_CMPLX64, 
    DPNP_FT_CMPLX128 
};
 
INP_DLLEXPORT
size_t operator-(DPNPFuncType lhs, DPNPFuncType rhs);
 
typedef struct DPNPFuncData
{
    DPNPFuncData(const DPNPFuncType gen_type,
                 void *gen_ptr,
                 const DPNPFuncType type_no_fp64,
                 void *ptr_no_fp64)
        : return_type(gen_type), ptr(gen_ptr),
          return_type_no_fp64(type_no_fp64), ptr_no_fp64(ptr_no_fp64)
    {
    }
    DPNPFuncData(const DPNPFuncType gen_type, void *gen_ptr)
        : DPNPFuncData(gen_type, gen_ptr, DPNPFuncType::DPNP_FT_NONE, nullptr)
    {
    }
    DPNPFuncData() : DPNPFuncData(DPNPFuncType::DPNP_FT_NONE, nullptr) {}
 
    DPNPFuncType return_type; 
    void *ptr;                
    DPNPFuncType return_type_no_fp64; 
    void *ptr_no_fp64; 
} DPNPFuncData_t;
 
INP_DLLEXPORT
DPNPFuncData_t get_dpnp_function_ptr(
    DPNPFuncName name,
    DPNPFuncType first_type,
    DPNPFuncType second_type = DPNPFuncType::DPNP_FT_NONE);
 
INP_DLLEXPORT
void *get_dpnp_function_ptr1(
    DPNPFuncType &result_type,
    DPNPFuncName name,
    DPNPFuncType first_type,
    DPNPFuncType second_type = DPNPFuncType::DPNP_FT_NONE);
 
#endif // BACKEND_IFACE_FPTR_H