cdfnorminv#

ベクトル要素の要素ごとの逆累積正規分布関数を計算します。

説明 #

cdfnorminv(a) 関数は、入力ベクトル a の要素の逆累積正規分布関数の値を計算し、それを出力ベクトル y に書き込みます。

逆累積正規分布関数は次のように定義されます。

\[\mathrm{CdfNormInv} (x) = \mathrm{CdfNorm}^{-1} (x),\]

ここで、cdfnorm(x) は累積正規分布関数を表します。

有用な関係:

\[\mathrm{cdfnorminv} (x) = \sqrt{2} \mathrm{erfinv} (2x - 1) = \sqrt{2} \mathrm{erfcinv} (2 - 2x)\]

ここで、erfinv(x) は逆誤差関数を、erfcinv(x) は逆相補誤差関数を表します。

次の図は、erfinv ファミリー関数 (erfinv、erfcinv、cdfnorminv) 間の関係を示しています。

cdfnorminv ファミリー関数の関係 — `cdfnorminv` ファミリー関数の関係#

これらの関数の有用な関係:

\[\mathrm{erfcinv} (x) = \mathrm{erfinv} (1 - x)\]

\[\mathrm{cdfnorminv} (x) = \sqrt{2} \mathrm{erfinv} (2x - 1) = \sqrt{2} \mathrm{erfcinv} (2 - 2x)\]

引数	結果	エラーコード
+0.5	+0
+1	+\(\infty\)	`status::sing`
-0	-\(\infty\)	`status::sing`
+0	-\(\infty\)	`status::sing`
a < -0	QNAN	`status::errdom`
a > +1	QNAN	`status::errdom`
+\(\infty\)	QNAN	`status::errdom`
-\(\infty\)	QNAN	`status::errdom`
QNAN	QNAN
SNAN	QNAN

API #

構文#

バッファー API

namespace oneapi::mkl::vm { 

sycl::event cdfnorminv(sycl::queue & exec_queue, 
      std::int64_t n, 
      sycl::buffer<T> & a, 
      sycl::buffer<T> & y, 
      oneapi::mkl::vm::mode mode = oneapi::mkl::vm::mode::not_defined, 
      oneapi::mkl::vm::error_handler<T> errhandler = {}); 

}

namespace oneapi::mkl::vm { 

sycl::event cdfnorminv(sycl::queue & exec_queue, 
      sycl::buffer<T> & a, 
      oneapi::mkl::slice sa, 
      sycl::buffer<T> & y, 
      oneapi::mkl::slice sy, 
      oneapi::mkl::vm::mode mode = oneapi::mkl::vm::mode::not_defined, 
      oneapi::mkl::vm::error_handler<T> errhandler = {}); 

}

USM API

namespace oneapi::mkl::vm { 

sycl::event cdfnorminv(sycl::queue & exec_queue, 
      std::int64_t n, 
      T const * a, 
      T * y, 
      std::vector<sycl::event> const & depends = {}, 
      oneapi::mkl::vm::mode mode = oneapi::mkl::vm::mode::not_defined, 
      oneapi::mkl::vm::error_handler<T> errhandler = {}); 

}

namespace oneapi::mkl::vm { 

sycl::event cdfnorminv(sycl::queue & exec_queue, 
      T const * a, 
      oneapi::mkl::slice sa, 
      T * y, 
      oneapi::mkl::slice sy, 
      std::vector<sycl::event> const & depends = {}, 
      oneapi::mkl::vm::mode mode = oneapi::mkl::vm::mode::not_defined, 
      oneapi::mkl::vm::error_handler<T> errhandler = {}); 

}

cdfnorminv は次の精度とデバイスをサポートしています。

T	デバイスサポート
`sycl::half`	GPU
`_Float16`	CPU
`float`	CPU および GPU
`double`	CPU および GPU

入力パラメーター#

バッファー API

exec_queue: ルーチンが実行されるキュー。
n: 計算する要素の数を指定します。
a: 入力ベクトルを含むバッファー。
sa: a のスライスセレクター。oneMKL スライスタイプの説明については、データタイプを参照してください。
sy: y のスライスセレクター。oneMKL スライスタイプの説明については、データタイプを参照してください。
mode: この関数呼び出しのグローバル VM モード設定をオーバーライドします。指定可能な値とその説明については、set_mode 関数を参照してください。これはオプションのパラメーターです。デフォルト値は mode::not_defined です。
errhandler: この関数呼び出しのローカルエラー処理モードを設定します。引数と説明については、create_error_handler 関数を参照してください。これはオプションのパラメーターです。ローカル・エラー・ハンドラーはデフォルトで無効になっています。

USM API

exec_queue: ルーチンが実行されるキュー。
n: 計算する要素の数を指定します。
a: 入力ベクトルへのポインター。
sa: a のスライスセレクター。oneMKL スライスタイプの説明については、データタイプを参照してください。
sy: y のスライスセレクター。oneMKL スライスタイプの説明については、データタイプを参照してください。
depends: 依存イベントのベクトル (入力データの準備ができるまで待機)。これはオプションのパラメーターです。デフォルトは空のベクトルです。
mode: この関数呼び出しのグローバル VM モード設定をオーバーライドします。指定可能な値とその説明については、set_mode 関数を参照してください。これはオプションのパラメーターです。デフォルト値は mode::not_defined です。
errhandler: この関数呼び出しのローカルエラー処理モードを設定します。引数と説明については、create_error_handler 関数を参照してください。これはオプションのパラメーターです。ローカル・エラー・ハンドラーはデフォルトで無効になっています。

出力パラメーター#

バッファー API

y: 出力ベクトルを含むバッファー。
戻り値 (event): 計算終了イベント。

USM API

y: 出力ベクトルへのポインター。
戻り値 (event): 計算終了イベント。

例 #

cdfnorminv の使用例は、oneMKL インストール・ディレクトリーの以下の場所にあります。

share/doc/mkl/examples/sycl/vml/source/vcdfnorminv.cpp

cdfnorminv

目次

cdfnorminv#

説明#

API#

構文#

入力パラメーター#

出力パラメーター#

例#

説明 #

API #

例 #