.rst .pdf

Contents

oneapi::mkl::stats::make_dataset

Description

Entry point to create a dataset from the provided parameters.

API

Syntax

Buffer API

template<layout ObservationsLayout = layout::row_major,
  typename Type> dataset<ObservationsLayout,
  sycl::buffer<Type, 1>> make_dataset(std::int64_t n_dims,
  std::int64_t n_observations,
  sycl::buffer<Type, 1> observations,
  sycl::buffer<Type, 1> weights = {0},
  sycl::buffer<std::int64_t, 1> indices = {0});

USM API

template<layout ObservationsLayout = layout::row_major,
  typename Type> dataset<ObservationsLayout,
  Type*> make_dataset(std::int64_t n_dims,
  std::int64_t n_observations,
  Type* observations, Type* weights = nullptr,
  std::int64_t* indices = nullptr);

Include Files

• oneapi/mkl/stats.hpp

Template Parameters

typename DataType	Type of dataset. May be float, double.
oneapi::mkl::stats::layout ObservationsLayout	Layout of the observations matrix of the dataset. The specific values are as follows: oneapi::mkl::stats::layout::row_major oneapi::mkl::stats::layout::col_major

Input Parameters

Name	Type	Description
n_dims	std::int64_t	The number of dimensions (variables)
n_observations	std::int64_t	The number of observations
observations	sycl::buffer<Type, 1> / Type*	Matrix of observations

Optional Input Parameters

Name	Type	Description
weights	sycl::buffer<Type, 1> / Type*	Array of weights of size n_observations. Elements of the arrays are non-negative numbers. If the parameter is not specified, each observation is assigned weight equal to 1.
indices	sycl::buffer<std::int64_t, 1> / std::int64_t*	Array of vector components that will be processed. Size of array is n_dims. If the parameter is not specified, all components of the random vector are processed.

Return Type

Buffer API

oneapi::mkl::stats::dataset<ObservationsLayout, sycl::buffer<Type, 1>>

Dataset holding specified parameters

USM API

oneapi::mkl::stats::dataset<ObservationsLayout, Type*>

Dataset holding specified parameters

Service Functions to Create Dataset Summary Statistics Routines