histogram.hpp

//*****************************************************************************
// Copyright (c) 2024, 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.
// - Neither the name of the copyright holder nor the names of its contributors
//   may be used to endorse or promote products derived from this software
//   without specific prior written permission.
//
// 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.
//*****************************************************************************
 
#pragma once
 
#include <pybind11/pybind11.h>
#include <sycl/sycl.hpp>
 
#include "dpctl4pybind11.hpp"
#include "ext/dispatch_table.hpp"
 
namespace statistics::histogram
{
struct Histogram
{
    using FnT = sycl::event (*)(sycl::queue &,
                                const void *,
                                const void *,
                                const void *,
                                void *,
                                const size_t,
                                const size_t,
                                const std::vector<sycl::event> &);
 
    ext::common::DispatchTable2<FnT> dispatch_table;
 
    Histogram();
 
    std::tuple<sycl::event, sycl::event>
        call(const dpctl::tensor::usm_ndarray &input,
             const dpctl::tensor::usm_ndarray &bins_edges,
             std::optional<const dpctl::tensor::usm_ndarray> &weights,
             dpctl::tensor::usm_ndarray &output,
             const std::vector<sycl::event> &depends);
};
 
void populate_histogram(py::module_ m);
} // namespace statistics::histogram