NumPy C-API: PyArray_CGT() 関数で共役転置積を計算する

NumPy C-API: PyArray_CGT() 関数の詳細解説

PyArray_CGT() 関数は、NumPy C-API の一部であり、2つの配列間の共役転置積 (Conjugate Transpose Product, 以下 CGT) を計算するために使用されます。これは、数学的には以下の式で表されます。

C = A^H * B

ここで、

• C は出力配列
• A は最初の入力配列
• B は2番目の入力配列
• ^H は共役転置を表す

詳細

PyArray_CGT() 関数は以下の引数を受け取ります。

• op: 演算の種類。NPY_CGT または NPY_CCGT を指定できます。
• out: 出力配列へのポインタ。NULL の場合は、A と同じ形状の新しい配列が作成されます。
• x: 最初の入力配列へのポインタ。
• y: 2番目の入力配列へのポインタ。

PyArray_CGT() 関数は以下の型をサポートしています。

• 入力配列: NPY_FLOAT, NPY_DOUBLE, NPY_COMPLEX64, NPY_COMPLEX128

例

以下のコードは、PyArray_CGT() 関数を使用して 2つの配列間の CGT を計算する方法を示しています。

#include <numpy/arrayobject.h>

int main() {

  // 入力配列を初期化
  npy_intp dims[] = {3, 3};
  PyArrayObject *x = PyArray_Zeros(2, dims, NPY_COMPLEX128);
  PyArrayObject *y = PyArray_Zeros(2, dims, NPY_COMPLEX128);

  // ...

  // PyArray_CGT() 関数を呼び出す
  PyArrayObject *out = PyArray_CGT(NPY_CGT, x, y);

  // ...

  // 出力配列を解放
  Py_DECREF(out);

  // 入力配列を解放
  Py_DECREF(x);
  Py_DECREF(y);

  return 0;
}

注意事項

• PyArray_CGT() 関数は、入力配列と出力配列が同じ形状であることを前提としています。
• 入力配列または出力配列の型がサポートされていない場合、エラーが発生します。
• 出力配列は PyArray_CGT() 関数によって作成されるため、明示的に解放する必要があります。

補足

• NumPy C-API は、NumPy の Python インターフェースよりも低レベルで効率的な方法で NumPy 配列を操作するために使用できます。
• PyArray_CGT() 関数は、フーリエ変換などの多くの科学計算で使用される重要な演算です。

NumPy C-API: PyArray_CGT() 関数のサンプルコード

#include <numpy/arrayobject.h>

int main() {

  // 入力配列を初期化
  npy_intp dims[] = {3, 3};
  PyArrayObject *x = PyArray_Zeros(2, dims, NPY_COMPLEX128);
  PyArrayObject *y = PyArray_Zeros(2, dims, NPY_COMPLEX128);

  // ...

  // PyArray_CGT() 関数を呼び出す
  PyArrayObject *out = PyArray_CGT(NPY_CGT, x, y);

  // ...

  // 出力配列を解放
  Py_DECREF(out);

  // 入力配列を解放
  Py_DECREF(x);
  Py_DECREF(y);

  return 0;
}

複素数配列と実数配列の共役転置積を計算する

#include <numpy/arrayobject.h>

int main() {

  // 入力配列を初期化
  npy_intp dims[] = {3, 3};
  PyArrayObject *x = PyArray_Zeros(2, dims, NPY_COMPLEX128);
  PyArrayObject *y = PyArray_Zeros(2, dims, NPY_FLOAT);

  // ...

  // PyArray_CGT() 関数を呼び出す
  PyArrayObject *out = PyArray_CGT(NPY_CGT, x, y);

  // ...

  // 出力配列を解放
  Py_DECREF(out);

  // 入力配列を解放
  Py_DECREF(x);
  Py_DECREF(y);

  return 0;
}

転置された配列の共役転置積を計算する

#include <numpy/arrayobject.h>

int main() {

  // 入力配列を初期化
  npy_intp dims[] = {3, 3};
  PyArrayObject *x = PyArray_Zeros(2, dims, NPY_COMPLEX128);
  PyArrayObject *y = PyArray_Zeros(2, dims, NPY_COMPLEX128);

  // ...

  // 転置された配列を取得
  PyArrayObject *xt = PyArray_Transpose(x, NULL);

  // PyArray_CGT() 関数を呼び出す
  PyArrayObject *out = PyArray_CGT(NPY_CGT, xt, y);

  // ...

  // 出力配列を解放
  Py_DECREF(out);

  // 転置された配列を解放
  Py_DECREF(xt);

  // 入力配列を解放
  Py_DECREF(x);
  Py_DECREF(y);

  return 0;
}

異なる型の配列の共役転置積を計算する

#include <numpy/arrayobject.h>

int main() {

  // 入力配列を初期化
  npy_intp dims[] = {3, 3};
  PyArrayObject *x = PyArray_Zeros(2, dims, NPY_FLOAT);
  PyArrayObject *y = PyArray_Zeros(2, dims, NPY_COMPLEX128);

  // ...

  // PyArray_CGT() 関数を呼び出す
  PyArrayObject *out = PyArray_CGT(NPY_CCGT, x, y);

  // ...

  // 出力配列を解放
  Py_DECREF(out);

  // 入力配列を解放
  Py_DECREF(x);
  Py_DECREF(y);

  return 0;
}

これらのサンプルコードは、PyArray_CGT() 関数のさまざまな使用方法を示しています。これらのコードを参考に、

NumPy C-API: PyArray_CGT() 関数の代替方法

numpy.dot() 関数は、2つの配列間のドット積を計算するために使用できます。共役転置積を計算するには、conj=True オプションを指定します。

import numpy as np

x = np.array([[1, 2], [3, 4]])
y = np.array([[5, 6], [7, 8]])

out = np.dot(x.conj().T, y)

print(out)

# [[19 22]
#  [43 50]]

numpy.einsum() 関数は、Einstein 記法を使用して配列演算を記述するために使用できます。共役転置積を計算するには、以下の式を使用します。

import numpy as np

x = np.array([[1, 2], [3, 4]])
y = np.array([[5, 6], [7, 8]])

out = np.einsum("ij,jk->ik", x.conj().T, y)

print(out)

# [[19 22]
#  [43 50]]

手動でループ処理を行う

NumPy 配列の形状が小さい場合は、手動でループ処理を行って共役転置積を計算することもできます。

import numpy as np

def cgt(x, y):
  out = np.zeros_like(x)
  for i in range(x.shape[0]):
    for j in range(x.shape[1]):
      for k in range(y.shape[1]):
        out[i, j] += x[i, k].conj() * y[k, j]

x = np.array([[1, 2], [3, 4]])
y = np.array([[5, 6], [7, 8]])

out = cgt(x, y)

print(out)

# [[19 22]
#  [43 50]]

これらの方法は、それぞれ異なる利点と欠点があります。

• numpy.dot() 関数は最も簡潔ですが、配列の形状が複雑な場合に効率的でない場合があります。
• numpy.einsum() 関数はより柔軟ですが、記法を理解するのに時間がかかる場合があります。
• 手動でループ処理を行う方法は最も効率的ですが、最も時間がかかります。

最適な方法は、特定の状況によって異なります。